-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Conversion between emoji characters and their names.
--   
--   This package provides functions for converting emoji names to emoji
--   characters and vice versa.
--   
--   How does it differ from the emoji package?
--   
--   
--   
- 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
--   
@package emojis
@version 0.1.4.1

module Text.Emoji

-- | Association list of (alias, emoji) pairs. Note that the same emoji may
--   have multiple aliases.
emojis :: [(Text, Text)]

-- | Lookup an emoji given its alias.
emojiFromAlias :: Text -> Maybe Text

-- | Lookup the aliases of an emoji.
aliasesFromEmoji :: Text -> Maybe [Text]

-- | Replace emojis in a text with alternative text. The replacement
--   function maps an emoji and a list of emoji aliases to a replacement
--   text.
replaceEmojis :: (Text -> [Text] -> Text) -> Text -> Text

-- | A list of all valid emoji (not containing zero-width joiners), taken
--   from the Unicode Emoji Specification.
baseEmojis :: [Text]

-- | A list of all valid emoji built from zero-width joiners, taken from
--   the Unicode Emoji Specification.
zwjEmojis :: [Text]
