The emoji_extension from ndelanou

Emojis for Dart Unicode 15.0
+
One, yet powerful emojis String extension

Quick overview of just a few possibilities:

'👍️te👍🏻xt👍🏼te👍🏽xt👍🏾te👍🏿xt'.emojis.extract; // [👍, 👍🏻, 👍🏼, 👍🏽, 👍🏾, 👍🏿]


'text😀 te😀xt 😀text'.emojis.remove; // text text text


// to Slack shortcodes:
'😀text🤦🏾‍♀️'.emojis.get.slackShortcodes; // [:grinning:, :woman-facepalming::skin-tone-5:]


// from Discord shortcodes:
'text:woman_facepalming_tone4:text'.emojis.fromShortcodes(); // text🤦🏾‍♀️text

Usage

Import import 'package:emoji_extension/emoji_extension.dart'; and you've got 2 benefits:

✅ Emojis repository

get
- values
- unicodes
- names
- shortcodes
groups
subgroups
groupsWithSubgroups
shortcodePlatforms
getOne()
getOneOrNull()
byGroup()
bySubgroup()

✅ Emojis extension

any
only
onlyOne
count
remove
split
extract
get
- unicodes
- names
- shortcodes
- groups
- subgroups
hasAny()
hasEach()
splitMapJoin()
replace()
replaceEach()
toShortcodes()
fromShortcodes()

1️⃣ `Emojis()` repository

Full Emojis() repository with unicodes, names, groups, subgroups, shortcodes:

Emojis() // .get .groups .subgroups .groupsWithSubgroups .shortcodePlatforms   and many more...

Emojis().get

Emojis().get; /* [
                  Emoji(
                   value: 😀,
                   unicode: 1F600,
                   name: Grinning Face,
                   group: Smileys & Emotion,
                   subgroup: face-smiling,
                   shortcodes: [
                            Shortcode(
                            platform: Discord,
                            value: grinning
                          ),
                            Shortcode(
                            platform: Github,
                            value: grinning
                          ),                             
                            Shortcode(
                            platform: Slack,
                            value: grinning
                          ), 
                            Shortcode(
                            platform: Default,
                            value: grinning_face
                          ), 
                            Shortcode(
                            platform: CLDR,
                            value: grinning_face
                          )]
                  ), 
                  Emoji(
                   value: 😃,
                   unicode: 1F603,
                   name: Grinning face with big eyes,
                   group: Smileys & Emotion,
                   subgroup: face-smiling,
                   shortcodes: [...]
                  )
                 ...
                 ] */

Emojis().get.values

Emojis().get.values; // [😀, 😃, 😄, 😁, 😆, 😅, 🤣, 😂, 🙂, 🙃, 🫠, 😉, 😊, 😇, 🥰, 😍, ...]

Emojis().get.unicodes

Emojis().get.unicodes; // [1F600, 1F603, 1F604, 1F601, 1F606, 1F605, 1F923, 1F602, 1F642, ...]

Emojis().get.names

Emojis().get.names; // [Grinning face, Grinning face with big eyes, ...]

Emojis().get.shortcodes

// Default (emoji name in snake_case)
Emojis().get.shortcodes; // [:grinning_face:, :grinning_face_with_big_eyes:, ...]

// CLDR
Emojis().get.cldrShortcodes; // [:grinning_face:, :grinning_face_with_big_eyes:, ...]

// Discord
Emojis().get.discordShortcodes; // [:grinning:, :smiley:, :smile:, :grin:, :laughing:, ...]

// Github (no skin-tone shortcodes)
Emojis().get.githubShortcodes; // [:grinning:, :smiley:, :smile:, :grin:, :laughing:, ...]

// Slack
Emojis().get.slackShortcodes; // [:grinning:, :smiley:, :smile:, :grin:, :laughing:, ...]

Emojis().groups

Emojis().groups; // [Group.smileysAndEmotion, Group.peopleAndBody, Group.component, ...]
Emojis().groups.values; // [Smileys & Emotion, People & Body, Component, Animals & Nature, ...]

Emojis().subgroups

Emojis().subgroups; // [Subgroup.faceSmiling, Subgroup.faceAffection, Subgroup.faceTongue, ...]
Emojis().subgroups.values; // face-smiling, face-affection, face-tongue, face-hand, ...]

Emojis().groupsWithSubgroups

Emojis().groupsWithSubgroups; // {Group.smileysAndEmotion: [Subgroup.faceSmiling, ...], ...}
Emojis().groupsWithSubgroupsValues; // {Smileys & Emotion: [face-smiling, ...], ...}

Emojis().shortcodePlatforms

Emojis().shortcodePlatforms; // [Default, CLDR, Discord, Github, Slack]

Emojis().getOne()

// By value
Emojis().getOne('😀'); // or

// By unicode
Emojis().getOne('1F600'); // or

// By name (ignore-case)
Emojis().getOne('Grinning Face'); // or
Emojis().getOne('grinning face'); // or

// By shortcode (ignore-colons)
Emojis().getOne(':grinning:'); // or
Emojis().getOne('grinning'); // or
Emojis().getOne('grinning_face'); /* [Emoji(
                                         value: 😀,
                                         unicode: 1F600,
                                         name: Grinning face,
                                         group: Smileys & Emotion,
                                         subgroup: face-smiling,
                                         shortcodes: [
                                           Shortcode(
                                           platform: Discord,
                                           value: grinning
                                         ),
                                           Shortcode(
                                           platform: Github,
                                           value: grinning
                                         ),  
                                           Shortcode(
                                           platform: Slack,
                                           value: grinning
                                         ), 
                                           Shortcode(
                                           platform: Default,
                                           value: grinning_face
                                         ), 
                                           Shortcode(
                                           platform: CLDR,
                                           value: grinning_face
                                         )]
                                       )] */

Emojis().getOneOrNull()

Equivalent of getOne() with null safety:

Emojis().getOneOrNull('😀')?.name; // Grinning face
Emojis().getOneOrNull('some broken value')?.name; // null

Emojis().byGroup()

Emojis().byGroup(Group.smileysAndEmotion); // [Emoji(value: 😀, ...), Emoji(value: 😃, ...), ...]

//or use convenient getters:
Emojis().smileysAndEmotion; // [Emoji(value: 😀, ...), Emoji(value: 😃, ...), ...]

Emojis().bySubgroup()

Emojis().bySubgroup(Subgroup.faceSmiling); // [Emoji(value: 😀, ...), Emoji(value: 😃, ...), ...]

//or use convenient getters:
Emojis().faceSmiling; // [Emoji(value: 😀, ...), Emoji(value: 😃, ...), ...]

2️⃣ `emojis` extension

Simple emojis extension that you can use to manipulate emojis on any text:

'😀 text with emojis 😀'.emojis // .any .only .count .remove .get .extract   and many more...

emojis.any

'😀text😀'.emojis.any; // true
'text'.emojis.any; // false

emojis.only

'😀'.emojis.only; // true
'😀 😀 😀'.emojis.only; // true
'text 😀 😀 😀 text'.emojis.only; // false
'text'.emojis.only; // false

emojis.onlyOne

'😀'.emojis.onlyOne; // true
'😀 😀 😀'.emojis.onlyOne; // false
'text 😀 😀 😀 text'.emojis.onlyOne; // false
'text'.emojis.onlyOne; // false

emojis.count

'text 😀 😀 😀 text'.emojis.count; // 3

emojis.remove

'text😀 te😀xt 😀text'.emojis.remove; // text text text

emojis.split

'text😀text'.emojis.split; // [text, text]

emojis.extract

'👍️te👍🏻xt👍🏼te👍🏽xt👍🏾te👍🏿xt'.emojis.extract; // [👍, 👍🏻, 👍🏼, 👍🏽, 👍🏾, 👍🏿]

emojis.get

'😀text'.emojis.get; /* [Emoji(
                          value: 😀,
                          unicode: 1F600,
                          name: Grinning Face,
                          group: Smileys & Emotion,
                          subgroup: face-smiling,
                          shortcodes: [
                            Shortcode(
                            platform: Discord,
                            value: grinning
                          ),
                            Shortcode(
                            platform: Github,
                            value: grinning
                          ),                             
                            Shortcode(
                            platform: Slack,
                            value: grinning
                          ), 
                            Shortcode(
                            platform: Default,
                            value: grinning_face
                          ), 
                            Shortcode(
                            platform: CLDR,
                            value: grinning_face
                          )]
                        )] */

emojis.get.unicodes

'😀text'.emojis.get.unicodes; // [1F600]

emojis.get.names

'😀text'.emojis.get.names; // [Grinning Face]

emojis.get.shortcodes

// Default (emoji name in snake_case)
'😀text🤦🏾‍♀️'.emojis.get.shortcodes; // [:grinning_face:, :woman_facepalming_medium_dark_skin_tone:]

// CLDR
'😀text🤦🏾‍♀️'.emojis.get.cldrShortcodes; // [:grinning_face:, :woman_facepalming_tone4:]

// Discord
'😀text🤦🏾‍♀️'.emojis.get.discordShortcodes; // [:grinning:, :woman_facepalming_tone4:]

// Github (no skin-tone shortcodes)
'😀text🤦🏾‍♀️'.emojis.get.githubShortcodes; // [:grinning:]

// Slack
'😀text🤦🏾‍♀️'.emojis.get.slackShortcodes; // [:grinning:, :woman-facepalming::skin-tone-5:]

emojis.get.groups

'😀text'.emojis.get.groups; // [Group.smileysAndEmotion]
'😀text'.emojis.get.groups.values; // [Smileys & Emotion]

emojis.get.subgroups

'😀text'.emojis.get.subgroups; // [Subgroup.faceSmiling]
'😀text'.emojis.get.subgroups.values; // [face-smiling]

emojis.hasAny()

'👍️text'.emojis.hasAny(['👍']); // true
'😀text'.emojis.hasAny(['👍', '😀']); // true
'👍️te👍🏻xt👍🏼te👍🏽xt👍🏾te👍🏿xt'.emojis.hasAny(['😀']); // false

emojis.hasEach()

'👍️text'.emojis.hasEach(['👍']); // true
'😀text👍'.emojis.hasEach(['👍', '😀']); // true
'😀text'.emojis.hasEach(['👍', '😀']); // false

emojis.splitMapJoin()

'text😀text'.emojis.splitMapJoin( // TEXT_emoji_TEXT
onMatch: (_) => '_emoji_',
onNonMatch: (s) => s.toUpperCase(),
);

emojis.replace()

'😀text👍'.emojis.replace('_'); // _️text_

emojis.replaceEach()

'😀text👍🏻text😀'.emojis.replaceEach({'😀': 'ABC', '👍🏻': '123'}); // ABCtext123textABC

emojis.toShortcodes()

// Default (emoji name in snake_case)
'😀text🤦🏾‍♀️'.emojis.toShortcodes(); // :grinning_face:text:woman_facepalming_medium_dark_skin_tone:

// CLDR
'😀text🤦🏾‍♀️'.emojis.toCLDRShortcodes(); // :grinning_face:text:woman_facepalming_tone4:

// Discord
'😀text🤦🏾‍♀️'.emojis.toDiscordShortcodes(); // :grinning:text:woman_facepalming_tone4:

// Github (no skin-tone shortcodes)
'😀text🤦🏾‍♀️'.emojis.toGithubShortcodes(); // :grinning:text🤦🏾‍♀️

// Slack
'😀text🤦🏾‍♀️'.emojis.toSlackShortcodes(); // :grinning:text:woman-facepalming::skin-tone-5:

emojis.fromShortcodes()

// Default 
'text:woman_facepalming_medium_dark_skin_tone:text'.emojis.fromShortcodes(); // text🤦🏾‍♀️text

// CLDR or Discord
'text:woman_facepalming_tone4:text'.emojis.fromShortcodes(); // text🤦🏾‍♀️text

// Slack
'text:woman-facepalming::skin-tone-5:text'.emojis.fromShortcodes(); // text🤦🏾‍♀️text

ndelanou / emoji_extension Goto Github PK

emoji_extension's Introduction

Emojis for Dart Unicode 15.0 + One, yet powerful emojis String extension