Emojix (emojix v0.4.0)

Documentation for Emojix.

Summary

Functions

all()

Returns a list of all 3019 Emoji, including variations.

find_by_hexcode(hexcode)

Find a emoji by hexcode

find_by_shortcode(shortcode)

Find a emoji by shortcode

find_by_unicode(unicode)

Find a emoji by unicode

replace(str, fun)

Returns a new string where each emoji contained in the given string is applied to a function.

scan(str)

Returns a list of all emoji contained within that string, in order.

search_by_description(description)

Search a emoji by description

search_by_tag(tag)

Search a emoji by tag

Functions

Link to this function

all()

@spec all() :: [Emojix.Emoji.t()]

Returns a list of all 3019 Emoji, including variations.

Examples 

iex> Emojix.all()
  [
    %Emojix.Emoji{
      description: "flag: Andorra",
      hexcode: "1F1E6-1F1E9",
      id: 3577,
      shortcodes: ["flag_ad"],
      tags: ["AD", "flag"],
      unicode: "ðŸ‡ĶðŸ‡Đ",
      variations: []
    },
    %Emojix.Emoji{
      description: "downcast face with sweat",
      hexcode: "1F613",
      id: 85,
      shortcodes: ["shamed"],
      tags: ["cold", "face", "sweat"],
      unicode: "😓",
      variations: []
    },
  ...
]
Link to this function

find_by_hexcode(hexcode)

@spec find_by_hexcode(String.t()) :: Emojix.Emoji.t() | nil

Find a emoji by hexcode

Examples 

iex> Emojix.find_by_hexcode("1F600")
%Emojix.Emoji{
  description: "grinning face",
  hexcode: "1F600",
  id: 1,
  shortcodes: ["gleeful"],
  tags: ["face", "grin"],
  unicode: "😀",
  variations: []
}
iex> Emojix.find_by_hexcode("FFFFF")
nil
Link to this function

find_by_shortcode(shortcode)

@spec find_by_shortcode(String.t()) :: Emojix.Emoji.t() | nil

Find a emoji by shortcode

Examples 

iex> Emojix.find_by_shortcode("gleeful")
%Emojix.Emoji{
  description: "grinning face",
  hexcode: "1F600",
  id: 1,
  shortcodes: ["gleeful"],
  tags: ["face", "grin"],
  unicode: "😀",
  variations: []
}
iex> Emojix.find_by_shortcode("non_valid")
nil
Link to this function

find_by_unicode(unicode)

@spec find_by_unicode(String.t()) :: nil | Emojix.Emoji.t()

Find a emoji by unicode

Examples 

iex> Emojix.find_by_unicode("😞")
%Emojix.Emoji{
  description: "cat with wry smile",
  hexcode: "1F63C",
  id: 110,
  shortcodes: ["smirking_cat"],
  tags: ["cat", "face", "ironic", "smile", "wry"],
  unicode: "😞",
  variations: []
}
Link to this function

replace(str, fun)

@spec replace(String.t(), (Emojix.Emoji.t() -> any())) :: String.t()

Returns a new string where each emoji contained in the given string is applied to a function.

Examples 

iex> Emojix.replace("The ðŸķ likes ðŸĶī", fn e -> e.shortcodes end)
"The dog_face likes bone"
Link to this function

scan(str)

@spec scan(String.t()) :: [Emojix.Emoji.t()]

Returns a list of all emoji contained within that string, in order.

Examples 

iex> Emojix.scan("Elixir is awesome!! ✌ðŸŧðŸ‘ðŸ―")
[
  %Emojix.Emoji{
    description: "victory hand: light skin tone",
    hexcode: "270C-1F3FB",
    id: 206,
    shortcodes: ["victory_tone1"],
    tags: [],
    unicode: "✌ðŸŧ",
    variations: []
  },
  %Emojix.Emoji{
    description: "thumbs up: medium skin tone",
    hexcode: "1F44D-1F3FD",
    id: 275,
    shortcodes: ["thumbsup_tone3", "+1_tone3", "yes_tone3"],
    tags: [],
    unicode: "ðŸ‘ðŸ―",
    variations: []
  }
]
iex> Emojix.scan("There is no emoji in this sentence")
[]
Link to this function

search_by_description(description)

@spec search_by_description(String.t()) :: [Emojix.Emoji.t()] | []

Search a emoji by description

Examples 

iex> Emojix.search_by_description("grinning")
[
  %Emojix.Emoji{
    description: "grinning face with sweat",
    hexcode: "1F605",
    id: 6,
    shortcodes: ["embarassed"],
    tags: ["cold", "face", "open", "smile", "sweat"],
    unicode: "😅",
    variations: []
  },
  %Emojix.Emoji{
    description: "grinning cat with smiling eyes",
    hexcode: "1F638",
    id: 107,
    shortcodes: ["grinning_cat"],
    tags: ["cat", "eye", "face", "grin", "smile"],
    unicode: "ðŸ˜ļ",
    variations: []
  },
  ...
]
iex> Emojix.search_by_description("blah")
[]
Link to this function

search_by_tag(tag)

@spec search_by_tag(String.t()) :: [Emojix.Emoji.t()] | []

Search a emoji by tag

Examples 

iex> Emojix.search_by_tag("face")
[
  %Emojix.Emoji{
    description: "downcast face with sweat",
    hexcode: "1F613",
    id: 85,
    shortcodes: ["shamed"],
    tags: ["cold", "face", "sweat"],
    unicode: "😓",
    variations: []
  },
  %Emojix.Emoji{
    description: "smiling face with sunglasses",
    hexcode: "1F60E",
    id: 61,
    shortcodes: ["confident"],
    tags: ["bright", "cool", "face", "sun", "sunglasses"],
    unicode: "😎",
    variations: []
  },
  ...
]
iex> Emojix.search_by_tag("blah")
[]