emoji.mbt

    MoonBit emoji library: lookup emoji in O(log n), access metadata and GitHub shortcodes, iterate over all emoji, multi-target support. Ported from Rust `emojis` (Unicode 18.0).

    moonbit
    emoji
    unicode
    smiley
    skin-tone
    gemoji
    shortcode
    lookup
    pure
    multi-target
    Download zip
    Author
    Version
    0.1.0
    License
    Apache-2.0
    Last updated
    11 hours ago
    Downloads
    4

    #walkzzz/emoji.mbt

    ✨ Pure MoonBit emoji library: lookup emoji, access metadata and GitHub shortcodes, iterate over all emoji in Unicode CLDR order. Zero FFI, multi-target (native / wasm-gc / js / wasm).

    API ported from Rust emojis 0.9.1, built on the Unicode 18.0 emoji data.

    #Features

    • O(log n) lookup by glyph (accepts unqualified / minimally qualified input), gemoji shortcode, or exact CLDR name
    • Rich metadata: name, group, emoji version, Unicode version, skin tone, shortcodes
    • CLDR-ordered iteration over all emojis (default skin tone only), per-group iteration
    • Skin tone families: iterate all variants (up to 26 combinations) or select a specific tone
    • MoonBit value-add APIs (@since 0.1.0 moonbit): count, get_by_name, search, random / random_with, iter_version_ge, Group::to_string, SkinTone::to_string
    • Built-in CLI: ls / search / find / show / count

    #Getting started

    Add the dependency and import the module root package:

    moon add walkzzz/emoji.mbt

    Lookup by glyph — the returned Emoji carries full metadata:

    ///|
    test "lookup" {
    let rocket = @emoji.get("🚀").unwrap()
    assert_eq(rocket.glyph, "🚀")
    assert_eq(rocket.name, "rocket")
    assert_eq(rocket.group, @emoji.TravelAndPlaces)
    assert_eq(rocket.emoji_version, @emoji.Version::new(0, 6))
    assert_eq(rocket.shortcode(), Some("rocket"))
    assert_eq(rocket.utf8_bytes(), b"\xf0\x9f\x9a\x80")
    }

    Unqualified input resolves to the fully qualified version:

    ///|
    test "unqualified" {
    let chipmunk = @emoji.get("🐿").unwrap()
    assert_eq(chipmunk.glyph, "🐿️")
    assert_eq(chipmunk.shortcode(), Some("chipmunk"))
    }

    Skin tone families are laid out consecutively; iterate them or select one:

    ///|
    test "skin tones" {
    let raised_hands = @emoji.get("🙌🏼").unwrap()
    let tones = raised_hands.skin_tones().unwrap().collect()
    assert_eq(tones.map(fn(e) { e.glyph }), [
    "🙌", "🙌🏻", "🙌🏼", "🙌🏽", "🙌🏾", "🙌🏿",
    ])
    let target = raised_hands.with_skin_tone(@emoji.MediumDark).unwrap()
    assert_eq(target.glyph, "🙌🏾")
    }

    Iterate all emojis in CLDR order, or a single group:

    ///|
    test "iteration" {
    let faces = @emoji.iter().take(5).collect()
    assert_eq(faces.map(fn(e) { e.glyph }), [
    "😀", "😃", "😄", "😁", "😆",
    ])
    let fruit = @emoji.FoodAndDrink.emojis().take(5).collect()
    assert_eq(fruit.map(fn(e) { e.glyph }), [
    "🍇", "🍈", "🍉", "🍊", "🍋",
    ])
    }

    MoonBit value-add APIs — search, name lookup, reproducible random, version filter:

    ///|
    test "value add" {
    assert_eq(@emoji.get_by_name("rocket").unwrap().glyph, "🚀")
    assert_eq(@emoji.search("GRINNING FACE")[0].glyph, "😀")
    let seed = b"\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f\x20"
    let r = @random.Rand::chacha8(seed~)
    let any = @emoji.random_with(r).unwrap()
    assert_eq(any, @emoji.random_with(@random.Rand::chacha8(seed~)).unwrap())
    assert_eq(
    @emoji.iter_version_ge(@emoji.Version::new(18, 0)).count() > 0,
    true,
    )
    }

    #API overview

    #Top-level functions

    MoonBitUpstreamDescription
    iter()iter()All emojis, CLDR order, default skin tone only
    get(s)get(s)O(log n) lookup by glyph, FE0F-tolerant
    get_by_shortcode(s)get_by_shortcode(s)O(log n) lookup by gemoji shortcode
    count()—Total emoji count (default subset)
    get_by_name(name)—Exact CLDR name lookup
    search(term)—Case-insensitive name substring search
    random() / random_with(r)—Random emoji (chacha8-reproducible)
    iter_version_ge(v)—Filter by Unicode version

    #Emoji

    MemberUpstreamDescription
    glyphas_str()The emoji string itself
    namename()CLDR name
    emoji_versionemoji_version()UTS #51 version
    unicode_version()unicode_version()Derived Unicode version
    groupgroup()CLDR group
    skin_tone()skin_tone()Current skin tone
    skin_tones()skin_tones()Iterate the whole family
    with_skin_tone(t)with_skin_tone()Select a specific tone
    shortcode() / shortcodesshortcode() / shortcodes()GitHub shortcodes
    utf8_bytes()as_bytes()UTF-8 encoded bytes
    to_string()DisplayThe glyph

    Group (9 variants), SkinTone (26 variants) and Version mirror the upstream enums/structs with the same ordering and numbering.

    #CLI

    moon run cmd/main count # totals per group moon run cmd/main ls Flags # list a group moon run cmd/main find rocket # glyph / shortcode / name lookup moon run cmd/main show "🐿" # full metadata (FE0F-tolerant) moon run cmd/main search grin # name substring search

    #Data provenance & licensing

    • API design ported from emojis 0.9.1 (MIT OR Apache-2.0)
    • Emoji data derived from Unicode 18.0 emoji data (Unicode License v3) and gemoji v4.1.0 (MIT), via the upstream generated tables
    • Regenerate with moon run data/gen.mbtx

    #License

    Apache-2.0

    Emoji

    pub struct Emoji {
    glyph : String
    name : String
    emoji_version : Version
    group : Group
    base_idx : Int
    variant_n : Int
    tone_idx : Int
    shortcodes : Array[String]
    } derive(
    Debug
    )

    表示一个 emoji(字段只读快照,构造仅限本包数据驱动)。

    Represents an emoji. Fields are read-only; construction is data-driven inside this package (mirrors upstream "no public constructors" policy).

    Emoji::shortcode

    fn Emoji::shortcode(self : Emoji) -> String?

    返回首个 gemoji 短码;无短码时返回 None。

    Returns the first GitHub shortcode, or None if the emoji has none. (Upstream shortcode())

    Emoji::skin_tone

    fn Emoji::skin_tone(self : Emoji) -> SkinTone?

    返回当前 emoji 的肤色;肤色不适用时返回 None。

    Returns the skin tone of this emoji, or None when skin tones are not applicable. (Upstream skin_tone())

    Emoji::skin_tones

    fn Emoji::skin_tones(self : Emoji) -> Iter[Emoji]?

    迭代该 emoji 及其全部肤色变体(从默认版开始);肤色不适用时返回 None。

    Returns an iterator over the emoji and all related skin tone emojis, starting from the default version; None when not applicable. (Upstream skin_tones())

    Emoji::to_repr

    Emoji::to_string

    fn Emoji::to_string(self : Emoji) -> String

    emoji 本体字符串。

    Returns this emoji as a string. (Upstream as_str())

    Emoji::unicode_version

    fn Emoji::unicode_version(self : Emoji) -> Version

    返回 Unicode 标准版本:由 emoji_version 派生(上游 unicode_version())。

    Returns the version of the Unicode Standard in which the underlying code point(s) were first encoded. (Upstream unicode_version())

    Emoji::utf8_bytes

    fn Emoji::utf8_bytes(self : Emoji) -> Bytes

    返回 emoji 本体的 UTF-8 编码字节。

    Returns this emoji as UTF-8 encoded bytes. (Upstream as_bytes())

    Emoji::with_skin_tone

    fn Emoji::with_skin_tone(self : Emoji, tone : SkinTone) -> Emoji?

    返回指定肤色的变体版本;肤色不适用或族内无该序号时返回 None。

    Returns a version of this emoji with the given skin tone; None when not applicable or the tone is out of the family. (Upstream with_skin_tone())

    Group

    pub(all) enum Group {
    SmileysAndEmotion
    PeopleAndBody
    AnimalsAndNature
    FoodAndDrink
    TravelAndPlaces
    Activities
    Objects
    Symbols
    Flags
    } derive(Compare, Eq,
    Debug
    )

    emoji 分组(基于 Unicode CLDR 数据)。

    A category for an emoji, based on Unicode CLDR data. (Upstream Group)

    Group::compare

    fn Group::compare(Group, Group) -> Int

    Group::emojis

    fn Group::emojis(self : Group) -> Iter[Emoji]

    迭代该分组内全部 emoji(CLDR 顺序,仅默认肤色)。

    Returns an iterator over all emojis in this group. (Upstream Group::emojis())

    Group::equal

    fn Group::equal(Group, Group) -> Bool

    Group::iter

    fn Group::iter() -> Iter[Group]

    迭代全部分组(上游 Group::iter())。

    Returns an iterator over all groups. (Upstream Group::iter())

    Group::not_equal

    fn Group::not_equal(x : Group, y : Group) -> Bool

    Group::op_ge

    fn Group::op_ge(x : Group, y : Group) -> Bool

    Group::op_gt

    fn Group::op_gt(x : Group, y : Group) -> Bool

    Group::op_le

    fn Group::op_le(x : Group, y : Group) -> Bool

    Group::op_lt

    fn Group::op_lt(x : Group, y : Group) -> Bool

    Group::to_repr

    Group::to_string

    fn Group::to_string(self : Group) -> String

    人类可读分组名(与上游 Debug 输出一致)。

    Human-readable group name, matching upstream Debug output. (MoonBit-specific, @since 0.1.0 moonbit)

    SkinTone

    pub(all) enum SkinTone {
    Default
    Light
    MediumLight
    Medium
    MediumDark
    Dark
    LightAndMediumLight
    LightAndMedium
    LightAndMediumDark
    LightAndDark
    MediumLightAndLight
    MediumLightAndMedium
    MediumLightAndMediumDark
    MediumLightAndDark
    MediumAndLight
    MediumAndMediumLight
    MediumAndMediumDark
    MediumAndDark
    MediumDarkAndLight
    MediumDarkAndMediumLight
    MediumDarkAndMedium
    MediumDarkAndDark
    DarkAndLight
    DarkAndMediumLight
    DarkAndMedium
    DarkAndMediumDark
    } derive(Compare, Eq,
    Debug
    )

    emoji 肤色。变体顺序与编号严格对齐上游 SkinTone(Default=0 … DarkAndMediumDark=25), 数据表中的肤色族按此顺序连续排列。

    The skin tone of an emoji. Variant order matches upstream SkinTone exactly; skin-tone families in the data table are laid out consecutively in this order. (Upstream SkinTone)

    SkinTone::compare

    fn SkinTone::compare(SkinTone, SkinTone) -> Int

    SkinTone::equal

    fn SkinTone::equal(SkinTone, SkinTone) -> Bool

    SkinTone::not_equal

    fn SkinTone::not_equal(x : SkinTone, y : SkinTone) -> Bool

    SkinTone::op_ge

    fn SkinTone::op_ge(x : SkinTone, y : SkinTone) -> Bool

    SkinTone::op_gt

    fn SkinTone::op_gt(x : SkinTone, y : SkinTone) -> Bool

    SkinTone::op_le

    fn SkinTone::op_le(x : SkinTone, y : SkinTone) -> Bool

    SkinTone::op_lt

    fn SkinTone::op_lt(x : SkinTone, y : SkinTone) -> Bool

    SkinTone::to_repr

    SkinTone::to_string

    fn SkinTone::to_string(self : SkinTone) -> String

    人类可读肤色名(与上游 Debug 输出一致)。

    Human-readable skin tone name, matching upstream Debug output. (MoonBit-specific, @since 0.1.0 moonbit)

    Version

    pub(all) struct Version {
    major : Int
    minor : Int
    } derive(Compare, Eq,
    Debug
    )

    Emoji 或 Unicode 版本(major.minor)。

    An emoji or Unicode version as defined by the Unicode Standard.

    Version::compare

    fn Version::compare(Version, Version) -> Int

    Version::equal

    fn Version::equal(Version, Version) -> Bool

    Version::new

    fn Version::new(major : Int, minor : Int) -> Version

    构造版本号(上游 UnicodeVersion::new / EmojiVersion::new)。

    Construct a new version. (Upstream UnicodeVersion::new)

    Version::not_equal

    fn Version::not_equal(x : Version, y : Version) -> Bool

    Version::op_ge

    fn Version::op_ge(x : Version, y : Version) -> Bool

    Version::op_gt

    fn Version::op_gt(x : Version, y : Version) -> Bool

    Version::op_le

    fn Version::op_le(x : Version, y : Version) -> Bool

    Version::op_lt

    fn Version::op_lt(x : Version, y : Version) -> Bool

    Version::to_repr

    count

    fn count() -> Int

    默认肤色 emoji 总数。

    Total number of emojis with default skin tone. (MoonBit-specific, @since 0.1.0 moonbit)

    get

    fn get(s : String) -> Emoji?

    按 emoji 字符查询(O(log n))。传入未限定/最小限定序列(缺 VS16 等) 时返回完全限定版本的 emoji。

    Lookup an emoji by Unicode value (O(log n)). If passed a minimally qualified or unqualified emoji, returns the emoji containing the fully qualified version. (Upstream get())

    get_by_name

    fn get_by_name(name : String) -> Emoji?

    按名称精确查询 emoji(默认肤色子集内的 CLDR 名称,如 "rocket"); 多个同名时返回 CLDR 顺序第一个。

    Lookup an emoji by exact CLDR name within the default skin tone subset. Returns the first match in CLDR order. (MoonBit-specific, @since 0.1.0 moonbit)

    get_by_shortcode

    fn get_by_shortcode(s : String) -> Emoji?

    按 gemoji 短码查询(O(log n))。

    Lookup an emoji by GitHub shortcode (O(log n)). (Upstream get_by_shortcode())

    iter

    fn iter() -> Iter[Emoji]

    迭代全部 emoji:按 Unicode CLDR 顺序,仅含默认肤色版本。

    Returns an iterator over all emojis, ordered by Unicode CLDR data, excluding non-default skin tones. (Upstream iter())

    iter_version_ge

    fn iter_version_ge(v : Version) -> Iter[Emoji]

    迭代 Unicode 版本 >= v 的默认肤色 emoji(CLDR 顺序)。

    Iterate emojis whose Unicode version is greater than or equal to v (default skin tone subset, CLDR order). Mirrors the upstream recommendation of filtering by unicode_version(). (MoonBit-specific, @since 0.1.0 moonbit)

    random

    fn random() -> Emoji?

    随机取一个默认肤色 emoji(使用系统随机源,每次调用独立)。

    Pick a random emoji from the default skin tone subset using a fresh random source. (MoonBit-specific, @since 0.1.0 moonbit)

    random_with

    用给定随机源随机取一个 emoji(可复现:如 @random.Rand::chacha8(seed))。

    Pick a random emoji using the given random source; reproducible with a seeded source such as chacha8. (MoonBit-specific, @since 0.1.0 moonbit)
    fn search(term : String) -> Array[Emoji]

    按 CLDR 名称大小写不敏感子串搜索 emoji(默认肤色子集,CLDR 顺序)。

    Search emojis whose CLDR name contains the given term (case-insensitive, default skin tone subset, CLDR order). (MoonBit-specific, @since 0.1.0 moonbit)