rn-emoji-compat

Support new Emojis on older Android versions.

If you are interested in emoji world checkout also our RN-Emoji-Keyboard library.

Supported Unicode Versions

Currently (02.01.2023) it supports emojis up to Unicode 14.

🪄 Installation

yarn add rn-emoji-compat

The library needs an initialization, to do that you only have to modify the MainApplication.java file.

rootDir/android/app/src/main/java/com/your-project-name/app*/MainApplication.java
* The app folder name may vary depends on your project setup.
...

  @Override
  public void onCreate() {
    super.onCreate();
    SoLoader.init(this, /* native exopackage */ false);
    initializeEmojiCompat(this); ---> this is NEW
  }

  private static void initializeEmojiCompat(Context context) {
      try{
        Class<?> compatPackageClass = Class.forName("com.rnemojicompat.RnEmojiCompatPackage");
        compatPackageClass.getMethod("initializeEmojiCompat", Context.class).invoke(null, context);
      } catch (ClassNotFoundException e) {
        e.printStackTrace();
      } catch (NoSuchMethodException e) {
        e.printStackTrace();
      } catch (IllegalAccessException e) {
        e.printStackTrace();
      } catch (InvocationTargetException e) {
        e.printStackTrace();
      }
  }

  rest...

Usage

After initilization, all uncompatible emojis should be rendered correctly, there's nothing more to do.

Worth to know

Due to problems with using native FontRequest method which should allow to download fonts when they are needed, I had to use bundled config.

The bundled font config will add 10mb to your Android bundle size. However this shouldn't affect your application performance. If you care about bundle size and still need emoji compatibility you should consider enabling proguard and separate build per cpu architecture if you haven't done it yet.

android/app/build.gradle

- def enableSeparateBuildPerCPUArchitecture = false
+ def enableSeparateBuildPerCPUArchitecture = true

- def enableProguardInReleaseBuilds = false
+ def enableProguardInReleaseBuilds = true

Depending on the current bundle size it can save you even more than those 10mb

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

📝 Contribute

If you want to contribute read the CONTRIBUTING.md guide.

🏢 Built with ♥️ and ⌨️ at TheWidlarzGroup

Built at TheWidlarzGroup - the group of React Native Developers and Designers who has built this project for you. If you like it -> give it a star!

E-mail if you have any questions or just want to talk [email protected]