BSD-3-Clause licensed by John MacFarlane
Maintained by [email protected]
This version can be pinned in stack with:emojis-0.1.4.1@sha256:2e7006c952aa51fe7757ec6f2749f1bcbb65664da91c0404565381ddc909dbf5,1940

Module documentation for 0.1.4.1

Depends on 3 packages(full list with versions):
Used by 3 packages in nightly-2024-09-17(full list with versions):

emojis

CI tests

This package provides functions for looking up an emoji by its name (alias), and for returning the aliases of an emoji.

A full list of (alias, emoji) pairs is also exported. In addition, a list of all emoji (including those without aliases) is exported, along with a list of all emoji formed using zero-width joiners.

Emoji aliases (emoji.json) are taken from the gemoji gem, used by GitHub. The full list of emoji are taken from the Unicode emoji specification files, (emoji-sequences.txt, emoji-zwj-sequences.txt). To regenerate these datafiles from the latest source, do make datafiles. If they have changed, do make to regenerate the emojis.inc file and rebuild the project.

This package has the following advantages over the emoji package on Hackage:

  • It supports a fuller range of emojis, including all those supported by GitHub
  • It supports lookup of emoji aliases from emoji
  • It uses Text rather than String
  • It has a lighter dependency footprint: in particular, it does not require aeson
  • It does not require TemplateHaskell

Changes

emojis

0.1.4.1

  • Use foldl’ instead of foldr to avoid stack overflows.

0.1.4

  • Update emoji data.
  • Export new function replaceEmojis, allowing replacement of emojis in a Text with alternate text.
  • Drop support for ghc < 8.8.

0.1.3

  • Update emoji data to Unicode Emoji 15.0 and aliases from gemoji.

0.1.2

  • Update emoji data (Unicode 14.0) and aliases from gemoji.
  • Export baseEmojis and zwjEmojis, generated directly from Unicode emoji data files, so that the library contains a complete list of emojis, including emojis for which gemoji provides no alias (Stephen Morgan).

0.1.1

  • Update emoji data.

0.1

  • Initial release