emojindex/emoji

Types

Basegroup

The basegroup of an emoji.

pub type Basegroup {
  SmileysAndEmotionBase
  PeopleAndBodyBase
  ComponentBase
  AnimalsAndNatureBase
  FoodAndDrinkBase
  TravelAndPlacesBase
  ActivitiesBase
  ObjectsBase
  SymbolsBase
  FlagsBase
}

Constructors

```
SmileysAndEmotionBase
```
```
PeopleAndBodyBase
```
```
ComponentBase
```
```
AnimalsAndNatureBase
```
```
FoodAndDrinkBase
```
```
TravelAndPlacesBase
```
```
ActivitiesBase
```
```
ObjectsBase
```
```
SymbolsBase
```
```
FlagsBase
```

Emoji

</>

An emoji.

pub type Emoji =
  @internal Emoji

Group

</>

The group of an emoji.

pub type Group {
  SmileysAndEmotion(subgroup: SubgroupSmileysAndEmotion)
  PeopleAndBody(subgroup: SubgroupPeopleAndBody)
  Component(subgroup: SubgroupComponent)
  AnimalsAndNature(subgroup: SubgroupAnimalsAndNature)
  FoodAndDrink(subgroup: SubgroupFoodAndDrink)
  TravelAndPlaces(subgroup: SubgroupTravelAndPlaces)
  Activities(subgroup: SubgroupActivities)
  Objects(subgroup: SubgroupObjects)
  Symbols(subgroup: SubgroupSymbols)
  Flags(subgroup: SubgroupFlags)
}

Constructors

SmileysAndEmotion(subgroup: SubgroupSmileysAndEmotion)

PeopleAndBody(subgroup: SubgroupPeopleAndBody)

```
Component(subgroup: SubgroupComponent)
```

AnimalsAndNature(subgroup: SubgroupAnimalsAndNature)

FoodAndDrink(subgroup: SubgroupFoodAndDrink)

TravelAndPlaces(subgroup: SubgroupTravelAndPlaces)

Activities(subgroup: SubgroupActivities)

```
Objects(subgroup: SubgroupObjects)
```
```
Symbols(subgroup: SubgroupSymbols)
```
```
Flags(subgroup: SubgroupFlags)
```

SubgroupActivities

</>

The Activities subgroup.

pub type SubgroupActivities {
  Event
  AwardMedal
  Sport
  Game
  ArtsAndCrafts
}

Constructors

```
Event
```
```
AwardMedal
```
```
Sport
```
```
Game
```
```
ArtsAndCrafts
```

SubgroupAnimalsAndNature

</>

The Animals & Nature subgroup.

pub type SubgroupAnimalsAndNature {
  AnimalMammal
  AnimalBird
  AnimalAmphibian
  AnimalReptile
  AnimalMarine
  AnimalBug
  PlantFlower
  PlantOther
}

Constructors

```
AnimalMammal
```
```
AnimalBird
```
```
AnimalAmphibian
```
```
AnimalReptile
```
```
AnimalMarine
```
```
AnimalBug
```
```
PlantFlower
```
```
PlantOther
```

SubgroupComponent

</>

The Component subgroup.

pub type SubgroupComponent {
  SkinTone
  HairStyle
}

Constructors

```
SkinTone
```
```
HairStyle
```

SubgroupFlags

</>

The Flags subgroup.

pub type SubgroupFlags {
  Flag
  CountryFlag
  SubdivisionFlag
}

Constructors

```
Flag
```
```
CountryFlag
```
```
SubdivisionFlag
```

SubgroupFoodAndDrink

</>

The Food & Drink subgroup.

pub type SubgroupFoodAndDrink {
  FoodFruit
  FoodVegetable
  FoodPrepared
  FoodAsian
  FoodSweet
  Drink
  Dishware
}

Constructors

```
FoodFruit
```
```
FoodVegetable
```
```
FoodPrepared
```
```
FoodAsian
```
```
FoodSweet
```
```
Drink
```
```
Dishware
```

SubgroupObjects

</>

The Objects subgroup.

pub type SubgroupObjects {
  Clothing
  Sound
  Music
  MusicalInstrument
  Phone
  Computer
  LightAndVideo
  BookPaper
  Money
  Mail
  Writing
  Office
  Lock
  Tool
  Science
  Medical
  Household
  OtherObject
}

Constructors

```
Clothing
```
```
Sound
```
```
Music
```
```
MusicalInstrument
```
```
Phone
```
```
Computer
```
```
LightAndVideo
```
```
BookPaper
```
```
Money
```
```
Mail
```
```
Writing
```
```
Office
```
```
Lock
```
```
Tool
```
```
Science
```
```
Medical
```
```
Household
```
```
OtherObject
```

SubgroupPeopleAndBody

</>

The People & Body subgroup.

pub type SubgroupPeopleAndBody {
  HandFingersOpen
  HandFingersPartial
  HandSingleFinger
  HandFingersClosed
  Hands
  HandProp
  BodyParts
  Person
  PersonGesture
  PersonRole
  PersonFantasy
  PersonActivity
  PersonSport
  PersonResting
  Family
  PersonSymbol
}

Constructors

```
HandFingersOpen
```
```
HandFingersPartial
```
```
HandSingleFinger
```
```
HandFingersClosed
```
```
Hands
```
```
HandProp
```
```
BodyParts
```
```
Person
```
```
PersonGesture
```
```
PersonRole
```
```
PersonFantasy
```
```
PersonActivity
```
```
PersonSport
```
```
PersonResting
```
```
Family
```
```
PersonSymbol
```

SubgroupSmileysAndEmotion

</>

The Smileys & Emotion subgroup.

pub type SubgroupSmileysAndEmotion {
  FaceSmiling
  FaceAffection
  FaceTongue
  FaceHand
  FaceNeutralSkeptical
  FaceSleepy
  FaceUnwell
  FaceHat
  FaceGlasses
  FaceConcerned
  FaceNegative
  FaceCostume
  CatFace
  MonkeyFace
  Heart
  Emotion
}

Constructors

```
FaceSmiling
```
```
FaceAffection
```
```
FaceTongue
```
```
FaceHand
```
```
FaceNeutralSkeptical
```
```
FaceSleepy
```
```
FaceUnwell
```
```
FaceHat
```
```
FaceGlasses
```
```
FaceConcerned
```
```
FaceNegative
```
```
FaceCostume
```
```
CatFace
```
```
MonkeyFace
```
```
Heart
```
```
Emotion
```

SubgroupSymbols

</>

The Symbols subgroup.

pub type SubgroupSymbols {
  TransportSign
  Warning
  Arrow
  Religion
  Zodiac
  AvSymbol
  Gender
  Math
  Punctuation
  Currency
  OtherSymbol
  Keycap
  Alphanum
  Geometric
}

Constructors

```
TransportSign
```
```
Warning
```
```
Arrow
```
```
Religion
```
```
Zodiac
```
```
AvSymbol
```
```
Gender
```
```
Math
```
```
Punctuation
```
```
Currency
```
```
OtherSymbol
```
```
Keycap
```
```
Alphanum
```
```
Geometric
```

SubgroupTravelAndPlaces

</>

The Travel & Places subgroup.

pub type SubgroupTravelAndPlaces {
  PlaceMap
  PlaceGeographic
  PlaceBuilding
  PlaceReligious
  PlaceOther
  TransportGround
  TransportWater
  TransportAir
  Hotel
  Time
  SkyAndWeather
}

Constructors

```
PlaceMap
```
```
PlaceGeographic
```
```
PlaceBuilding
```
```
PlaceReligious
```
```
PlaceOther
```
```
TransportGround
```
```
TransportWater
```
```
TransportAir
```
```
Hotel
```
```
Time
```
```
SkyAndWeather
```

UnicodeVersion

</>

The Unicode version in which an emoji was added.

pub type UnicodeVersion {
  UnicodeVersion(major: Int, minor: Int)
}

Constructors

```
UnicodeVersion(major: Int, minor: Int)
```

Values

all

</>

pub const all: List(@internal Emoji)

List of all emojis.

basegroup

</>

pub fn basegroup(emoji: @internal Emoji) -> Basegroup

Returns the basegroup of an emoji.

Examples

e.penguin |> basegroup()
// -> AnimalsAndNatureBase

group

</>

pub fn group(emoji: @internal Emoji) -> Group

Returns the group of an emoji.

Examples

e.penguin |> group()
// -> AnimalsAndNature(AnimalBird)

group_to_group_base

</>

pub fn group_to_group_base(group: Group) -> Basegroup

Returns the basegroup of a group.

Examples

AnimalsAndNature(AnimalBird) |> group_to_group_base()
// -> AnimalsAndNatureBase

name

</>

pub fn name(emoji: @internal Emoji) -> String

Returns the CLDR short name of an emoji.

Examples

e.penguin |> name()
// -> "penguin"

to_string

</>

pub fn to_string(emoji: @internal Emoji) -> String

Returns the emoji string of an emoji.

Examples

e.penguin |> to_string()
// -> "🐧"

unicode_version

</>

pub fn unicode_version(emoji: @internal Emoji) -> UnicodeVersion

Returns the Unicode version of an emoji.

Examples

e.penguin |> unicode_version()
// -> UnicodeVersion(0, 6)

unicode_version_compare

</>

pub fn unicode_version_compare(
  a: UnicodeVersion,
  with b: UnicodeVersion,
) -> order.Order

Compares two unicode version, returning an order.

Examples

unicode_version_compare(UnicodeVersion(5, 0), UnicodeVersion(15, 1))
// -> Lt

unicode_version_compare(UnicodeVersion(4, 0), UnicodeVersion(3, 0))
// -> Gt

unicode_version_compare(UnicodeVersion(1, 0), UnicodeVersion(1, 0))
// -> Eq