# `Mojibake.Emoji`
[🔗](https://github.com/zaerl/mojibake/blob/main/src/elixir/lib/mojibake/emoji.ex#L5)

Emoji sequences (UTS #51).

The emoji properties of a single codepoint come from `Mojibake.Char.emoji_properties/1`.

# `qualification`

```elixir
@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.

# `sequence`

```elixir
@type sequence() :: %{
  type: sequence_type(),
  qualification: qualification(),
  codepoint_count: pos_integer()
}
```

What `sequence/1` returns.

# `sequence_type`

```elixir
@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-16
  * `nil` - a sequence that only `emoji-test.txt` lists, such as the unqualified keycap
    "1" U+20E3

# `rgi?`

```elixir
@spec rgi?(String.t()) :: boolean()
```

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

# `sequence`

```elixir
@spec sequence(String.t()) :: sequence() | nil
```

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

# `sequence?`

```elixir
@spec sequence?(String.t()) :: boolean()
```

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*
