Emoji sequences (UTS #51).
The emoji properties of a single codepoint come from Mojibake.Char.emoji_properties/1.
Summary
Types
The qualification status of an emoji sequence in emoji-test.txt: :component,
:fully_qualified, :minimally_qualified, :unqualified, or nil for a sequence that
emoji-test.txt does not list, such as a variation sequence.
What sequence/1 returns.
The kind of an emoji sequence
Functions
Return true if string is a recommended-for-general-interchange (RGI) emoji: a basic,
keycap, flag, tag, modifier, or ZWJ sequence, or a fully-qualified or component one.
Describe string if the whole of it is one emoji sequence that Unicode lists, including the
standardized emoji variation sequences. Return nil otherwise.
Return true if the whole of string is one emoji sequence that Unicode lists.
Types
@type qualification() ::
:component | :fully_qualified | :minimally_qualified | :unqualified | nil
The qualification status of an emoji sequence in emoji-test.txt: :component,
:fully_qualified, :minimally_qualified, :unqualified, or nil for a sequence that
emoji-test.txt does not list, such as a variation sequence.
@type sequence() :: %{ type: sequence_type(), qualification: qualification(), codepoint_count: pos_integer() }
What sequence/1 returns.
@type sequence_type() ::
nil
| :basic
| :keycap
| :flag
| :tag
| :modifier
| :zwj
| :text_variation
| :emoji_variation
The kind of an emoji sequence:
:basic- a single emoji, such as "😀":keycap- a keycap sequence, such as "1️⃣":flag- a pair of regional indicators, such as "🇮🇹":tag- a tag sequence, such as the flag of Scotland:modifier- an emoji with a skin-tone modifier, such as "👍🏽":zwj- a sequence joined with ZERO WIDTH JOINER, such as "👨👩👧":text_variation- a character followed by VARIATION SELECTOR-15:emoji_variation- a character followed by VARIATION SELECTOR-16nil- a sequence that onlyemoji-test.txtlists, such as the unqualified keycap "1" U+20E3
Functions
Return true if string is a recommended-for-general-interchange (RGI) emoji: a basic,
keycap, flag, tag, modifier, or ZWJ sequence, or a fully-qualified or component one.
Examples
iex> Mojibake.Emoji.rgi?("😀")
true
iex> Mojibake.Emoji.rgi?("#")
false
Describe string if the whole of it is one emoji sequence that Unicode lists, including the
standardized emoji variation sequences. Return nil otherwise.
Examples
iex> Mojibake.Emoji.sequence("👍🏽")
%{type: :modifier, qualification: :fully_qualified, codepoint_count: 2}
iex> Mojibake.Emoji.sequence("🇮🇹")
%{type: :flag, qualification: :fully_qualified, codepoint_count: 2}
iex> Mojibake.Emoji.sequence("hi")
nil
Return true if the whole of string is one emoji sequence that Unicode lists.
Examples
iex> Mojibake.Emoji.sequence?("👨👩👧")
true
iex> Mojibake.Emoji.sequence?("👍👍")
false