Android Emojify

This project is an android port of vdurmont/emoji-java which is a lightweight java library that helps you use Emojis in your java applications re-written in Kotlin, with some extra tweaks.

This project is already being used in AniTrend and only aims to provide emojis from emojipedia

All class and function documentation on the emojify module can be found here
All supported emojis can be found here

Known Issues

Converting of html entities to emojis may not always display the emoji on a given android device if the target device does not have the suggested emoticons e.g. android 4.3 does not have some emoticons available in android 5.0+

Suggestions

From v1.X the project was reworked and should be able to handle conversion from emoji to hexHtml, decHtml or short codes on the main thread with a slight improvement on processing speed (depending on the length of text of course), however I would highly recommend moving all convention work to a background thread ( consider Coroutines - Kotlin) between network requests for a smoother experience for your users (read up on the repository pattern).
If you are using a markdown library like txtmark , [markwon](GitHub - noties/Markwon: Android markdown library (no WebView)) or using just Html.fromHtml() you can skip the conversion of HexHtml & HtmlCodes to emoji and just pass the returned Spanned from whichever framework you're using. (See sample in project)

Use Case

Trying to get emoji support in your application in a way that is both compatible with a browser and mobile, you might even be trying to create a github client with reaction support? Then this library is for you, your backend stores is the html entities or aliases in text and this library will take care of everything for you.

Getting Started

Step 1. Add this to your root build.gradle:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Step 2. Add the dependencies:

You must use one of our artifacts kotlinx, gson or moshi for deserialization, this should match whatever library you want to use. e.g.

dependencies {
    implementation 'com.github.anitrend.android-emojify:emojify:{latest_version}'
    implementation 'com.github.anitrend.android-emojify:contract:{latest_version}'
    implementation 'com.github.anitrend.android-emojify:kotlinx:{latest_version}'
}

Step 3. Create an application class in your android project and add:

Don't know how to do that?? Take a look at the application class example

class App : Application() {

  /**
   * Application scope bound emojiManager, you could keep a reference to this object in a
   * dependency injector framework like as a singleton in `Hilt`, `Dagger` or `Koin`
   */
    internal val emojiManager: EmojiManager by lazy {
        EmojiManager.create(this, KotlinxDeserializer())
    }
}

Step4. Optional - Init EmojiManager with androidx-startup

class EmojiInitializer : Initializer<EmojiManager> {
  private val serializer: IEmojiDeserializer = KotlinxDeserializer()

  /**
   * Initializes and a component given the application [Context]
   *
   * @param context The application context.
   */
  override fun create(context: Context) = EmojiManager.create(context, serializer)

  /**
   * @return A list of dependencies that this [Initializer] depends on. This is
   * used to determine initialization order of [Initializer]s.
   *
   * For e.g. if a [Initializer] `B` defines another
   * [Initializer] `A` as its dependency, then `A` gets initialized before `B`.
   */
  override fun dependencies() = emptyList<Class<out Initializer<*>>>()
}

class App : Application() {

  /**
   * Application scope bound emojiManager, you could keep a reference to this object in a
   * dependency injector framework like as a singleton in `Hilt`, `Dagger` or `Koin`
   */
  internal val startupEmojiManager: EmojiManager by lazy {
    // should already be initialized if we haven't disabled initialization in manifest
    // see: https://developer.android.com/topic/libraries/app-startup#disable-individual
    AppInitializer.getInstance(this)
      .initializeComponent(EmojiInitializer::class.java)
  }
}

AndroidManifest.xml

<provider
    android:name="androidx.startup.InitializationProvider"
    android:authorities="${applicationId}.androidx-startup"
    android:exported="false"
    tools:node="merge">
    <meta-data
        android:name="{some_package_name_of_your_choosing}.EmojiInitializer"
        android:value="androidx.startup" />
</provider>

Screenshots

Examples:

EmojiManager

The EmojiManager provides several instance methods to search through the emojis database:

getForTag returns all the emojis for a given tag
getForAlias returns the emoji for an alias
emojiList list of all the emojis
isEmoji checks if a string is an emoji

You can also query the metadata:

getAllTags returns the available tags

Or get everything:

emojiList list of all the emojis

Emoji model

An Emoji is a data class, which provides the following methods:

unicode the unicode representation of the emoji
description the (optional) description of the emoji
aliases a list of aliases for this emoji
tags a list of tags for this emoji
htmlDec an html decimal representation of the emoji
htmlHex an html decimal representation of the emoji
supportsFitzpatrick true if the emoji supports the Fitzpatrick modifiers, else false
getUnicode(fitzpatrick: Fitzpatrick?): String Returns the unicode representation of the emoji associated with the provided Fitzpatrick modifier.

Fitzpatrick modifiers

Some emojis now support the use of Fitzpatrick modifiers that gives the choice between 5 shades of skin tones:

Modifier	Type
🏻	type_1_2
🏼	type_3
🏽	type_4
🏾	type_5
🏿	type_6

We defined the format of the aliases including a Fitzpatrick modifier as:

:ALIAS|TYPE:

A few examples:

:boy|type_1_2:
:swimmer|type_4:
:santa|type_6:

EmojiParser

Is a set of extension methods to act on EmojiManager, so given an instance of EmojiManger we can achieve the following:

val emojiManager: EmojiManger = ...

To unicode

To replace all the aliases and the html representations found in a string by their unicode, use EmojiParser#parseToUnicode(String).

For example:

val str = "An :+1:awesome :smiley:string " + "😄with a few :wink:emojis!"
val result = emojiManager.parseToUnicode(str)
// An 😀awesome 😃string 😄with a few 😉emojis!

To aliases

To replace all the emoji's unicodes found in a string by their aliases, use EmojiParser#parseToAliases(String).

For example:

val str = "An 😀awesome 😃string with a few 😉emojis!"
val result = emojiManager.parseToAliases(str)
// "An :grinning:awesome :smiley:string with a few :wink:emojis!"

By default, the aliases will parse and include any Fitzpatrick modifier that would be provided. If you want to remove or ignore the Fitzpatrick modifiers, use EmojiParser#parseToAliases(String, FitzpatrickAction). Examples:

val str = "Here is a boy: \uD83D\uDC66\uD83C\uDFFF!"
emojiManager.parseToAliases(str, FitzpatrickAction.PARSE)
// Returns twice: "Here is a boy: :boy|type_6:!"
emojiManager.parseToAliases(str, FitzpatrickAction.REMOVE)
// Returns: "Here is a boy: :boy:!"
emojiManager.parseToAliases(str, FitzpatrickAction.IGNORE)
// Returns: "Here is a boy: :boy:🏿!"

To html

To replace all the emoji's unicodes found in a string by their html representation, use EmojiParser#parseToHtmlDecimal(String) or EmojiParser#parseToHtmlHexadecimal(String).

For example:

val str = "An 😀awesome 😃string with a few 😉emojis!"
val resultHtmlDecimal = emojiManager.parseToHtmlDecimal(str)
// Returns:
// "An &#128512;awesome &#128515;string with a few &#128521;emojis!"

val resultHexadecimal = emojiManager.parseToHtmlHexadecimal(str)
// Returns:
// "An 😀awesome 😃string with a few 😉emojis!"

By default, any Fitzpatrick modifier will be removed. If you want to ignore the Fitzpatrick modifiers, use emojiManager.parseToAliases(String, FitzpatrickAction). Examples:

val str = "Here is a boy: \uD83D\uDC66\uD83C\uDFFF!"

emojiManager.parseToHtmlDecimal(str, FitzpatrickAction.PARSE)
emojiManager.parseToHtmlDecimal(str, FitzpatrickAction.REMOVE)
// Returns: "Here is a boy: 👦!"
emojiManager.parseToHtmlDecimal(str, FitzpatrickAction.IGNORE)
// Returns: "Here is a boy: 👦🏿!"

The same applies for the methods emojiManager.parseToHtmlHexadecimal(String) and emojiManager.parseToHtmlHexadecimal(String, FitzpatrickAction).

Remove emojis

You can easily remove emojis from a string using one of the following methods:

emojiManager.removeAllEmojis(String): removes all the emojis from the String
emojiManager.removeAllEmojisExcept(String, Collection<Emoji>): removes all the emojis from the String, except the ones in the Collection
emojiManager.removeEmojis(String, Collection<Emoji>): removes the emojis in the Collection from the String

For example:

val str = "An 😀awesome 😃string with a few 😉emojis!"
val collection = ArrayList<Emoji>()
collection.add(emojiManager.getForAlias("wink")); // This is 😉

emojiManager.removeAllEmojis(str);
emojiManager.removeAllEmojisExcept(str, collection);
emojiManager.removeEmojis(str, collection);

// Returns:
// "An awesome string with a few emojis!"
// "An awesome string with a few 😉emojis!"
// "An 😀awesome 😃string with a few emojis!"

Extract Emojis from a string

You can search a string of mixed emoji/non-emoji characters and have all of the emoji characters returned as a Collection.

emojiManager.extractEmojis(String): returns all emojis as a Collection. This will include duplicates if emojis are present more than once.

Credits

emoji-java originally used the data provided by the github/gemoji project. It is still based on it but has evolved since.

License

Copyright 2018 AniTrend

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

AniTrend / android-emojify

readme

Android Emojify

Known Issues

Suggestions

Use Case

Getting Started

Step 1. Add this to your root build.gradle:

Step 2. Add the dependencies:

Step 3. Create an application class in your android project and add:

Step4. Optional - Init EmojiManager with androidx-startup

Screenshots

Examples:

EmojiManager

Emoji model

Fitzpatrick modifiers

EmojiParser

To unicode

To aliases

To html

Remove emojis

Extract Emojis from a string

Credits

License