@matrix-org/emojibase-bindings
v1.3.3
Published
Kotlin, Swift and Typescript bindings for emojibase json.
Downloads
8,617
Readme
emojibase-bindings
Kotlin, Swift and Web bindings for emojibase json.
Requirements
- Node LTS
- Yarn Classic
Installation
Run ./scripts/setup.sh
to install dependencies for this project.
Generating the emojibase.json
Run ./scripts/generateJson.sh
to generate the emojibase.json assets
Updating Emoji Version
- Update the emojibase
emojibase
version in a package.json to one that support the required emoji version. - To update the emoji version web uses change
MAX_EMOJI_VERSION_WEB
in src/emoji.ts(Element Web imports this file directly).- caveat: This version should be changed in unison with the twemoji verison so that all emojis displayed in the picker can actually be rendered.
- To update the emoji version iOS or Android use change
MAX_EMOJI_VERSION_ANDROID
orMAX_EMOJI_VERSION_IOS
respectively in scripts/generateJson.sh(This script generates theemojibase.json
file packaged with the iOS and Android packages)
Releasing
Use "Run workflow". Refer to SemVer for versioning semantics. This workflow will bump the version, publish to NPM/Maven and create a GitHub release. The Swift consumer uses SwiftPM and can target the latest released version.