summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6ba456f..d858eb4 100644
--- a/README.md
+++ b/README.md
@@ -610,6 +610,34 @@ test "Scripts" {
610} 610}
611``` 611```
612 612
613## Emoji
614
615To get information about emoji and emoji-like characters, use the `Emoji` module.
616
617In your `build.zig`:
618
619```zig
620exe.root_module.addImport("Emoji", zg.module("Emoji"));
621```
622
623In your code:
624
625```zig
626const Emoji = @import("Emoji");
627
628test "Emoji" {
629 const emoji = try Emoji.init(allocator);
630 defer emoji.deinit(allocator);
631
632 try expect(emoji.isEmoji(0x1F415)); // 🐕
633 try expect(emoji.isEmojiPresentation(0x1F408)); // 🐈
634 try expect(emoji.isEmojiModifier(0x1F3FF)); // 🏿
635 try expect(emoji.isEmojiModifierBase(0x1F977)); // 🥷
636 try expect(emoji.isEmojiComponent(0x1F9B0)); // 🦰
637 try expect(emoji.isExtendedPictographic(0x1F005)); // 🀅
638}
639```
640
613## Limits 641## Limits
614 642
615Iterators, and fragment types such as `CodePoint`, `Grapheme` and 643Iterators, and fragment types such as `CodePoint`, `Grapheme` and