NAME

Text::Emoji - provide :text: to emoji translation

SYNOPSIS

use Text::Emoji;

say to-emoji("I :heart: :beer:");  # I ❤️ 🍺

say to-text(":I: ❤️ 🍺");  # I :heart: :beer:

DESCRIPTION

The Text::Emoji distribution contains information about transforming :text: to emoji transliteration. As such it exports a number of subroutines.

It also installs a convenience script em that will convert to emojis any arguments from the command line or from standard input.

SUBROUTINES

to-emoji

say to-emoji("I :heart: :beer:");                     # I ❤️ 🍺

say to-emoji("I :love: :beer:", :love<❤️>);           # I ❤️ 🍺
say to-emoji("I :love: :beer:", :love<heart>);        # I ❤️ 🍺
say to-emoji("I :love: :beer:", %(love => "❤️"));     # I ❤️ 🍺
say to-emoji("I :love: :beer:", %(love => "heart"));  # I ❤️ 🍺

say to-emoji("baby: :baby-bottle::babybottle:");  # baby: 🍼🍼

The to-emoji subroutine in its simplest form takes a string as the first argument and attempt to transform any known emoji strings of the form :word: into the associated emoji. Note that the word may contain hyphens, but they are optional.

Additional mapping info may be specified as additional named arguments, or as a hash. The value for each additional mapping may be either the emoji directly, or the text equivalent of the emoji.

to-text

say to-text("I ❤️ 🍺");                      # I :heart: :beer:
say to-text("I ❤️ 🍺", :love<❤️>);           # I :love: :beer:
say to-text("I ❤️ 🍺", :love<heart>);        # I :love: :beer:
say to-text("I ❤️ 🍺", %(love => "❤️"));     # I :love: :beer:
say to-text("I ❤️ 🍺", %(love => "heart"));  # I :love: :beer:

The to-text subroutine in its simplest form takes a string as the first argument and attempt to transform any known emojis to the shortest possible :word: form known for that emoji.

The same type of additional map information as can be specified with to-emoji, can be specified with to-text.

raw-emoji-data

say raw-emoji-data<❤️>.keys;
# (aliases category description emoji ios_version tags unicode_version)

The raw-emoji-data subroutine returns a Map, keyed to the supported emojis. The value associated with is a Map as well, which can be best described by its JSON representation:

{
  "emoji": "❤️",
  "description": "red heart",
  "category": "Smileys & Emotion",
  "aliases": [
    "heart"
  ],
  "tags": [
    "love"
  ],
  "unicode_version": "",
  "ios_version": "6.0"
}

SCRIPTS

em

$ em I :heart: :beer:
I ❤️ 🍺

$ echo I :heart: :beer: | em
I ❤️ 🍺

The em script converts any text given either on the command line, or from STDIN, to emojis where appropriate.

INSPIRATION

Inspired by Simon Harms' Avolution::Emoji module, but completely re-imagined from scratch using the table provided by the gemoji library.

AUTHOR

Elizabeth Mattijsen liz@raku.rocks

Source can be located at: https://github.com/lizmat/Text-Emoji . Comments and Pull Requests are welcome.

If you like this module, or what I'm doing more generally, committing to a small sponsorship would mean a great deal to me!

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.