https://github.com/chrynan/emoji
Kotlin Multi-platform Emoji Support Library
https://github.com/chrynan/emoji
emoji emojis kotlin kotlin-multi-platform kotlin-multiplatform kotlin-multiplatform-library
Last synced: 5 months ago
JSON representation
Kotlin Multi-platform Emoji Support Library
- Host: GitHub
- URL: https://github.com/chrynan/emoji
- Owner: chRyNaN
- License: apache-2.0
- Created: 2020-09-13T01:02:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-08T02:48:35.000Z (about 3 years ago)
- Last Synced: 2023-02-27T06:41:52.324Z (almost 3 years ago)
- Topics: emoji, emojis, kotlin, kotlin-multi-platform, kotlin-multiplatform, kotlin-multiplatform-library
- Language: Kotlin
- Homepage:
- Size: 966 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# emoji
Kotlin Multi-platform Emoji Support Library.
## Usage
### Create an Emoji
```kotlin
Emoji(
unicodeString = "U+1F600",
character = "😀",
name = "grinning face",
aliases = listOf("grinning_face", "grin_face", "grin face"),
category = "Smileys & Emotion",
group = "face-smiling",
iconUri = null
)
```
### Accessing Emojis
Emojis can be retrieved from a `EmojiRepository` instance:
```kotlin
val emojiByName = emojiRepository.getByName("grinning face")
val emojiByAlias = emojiRepository.getByAlias(":grinning_face:")
val allEmojis = emojiRepository.getAll()
```
#### Retrieving an EmojiRepository
The `EmojiRepository` interface is in the `emoji-core` module but there are different implementations in
the `emoji-repo-map` and `emoji-repo-sqlite` modules. Note that the `emoji-repo-sqlite` module uses
the [sqldelight](https://github.com/cashapp/sqldelight) library and requires a `SqlDriver` to obtain an instance of
the `SqliteEmojiRepository`.
`emoji-repo-map`:
```
val repo = KotlinMapEmojiRepository()
```
`emoji-repo-sqlite`:
```kotlin
val database = EmojiDatabase(sqldriver)
val repo = SqliteEmojiRepository(database)
```
#### Initializing an EmojiRepository
Before the `EmojiRepository` implementation class is used for the first time, it has to be initialized by calling
the `init()` function. This loads the emoji data set. Note that the `init()` function is only on the implementation
classes and not on the `EmojiRepository` interface.
```kotlin
repository.init()
```
### Categorizing Emojis
It may be useful to have the Emojis grouped by their `category` and/or `group` properties. There are convenience
functions to achieve this.
```kotlin
repository.getAll().categorize() // List
repository.getAll().group() // List
```
## Building
The library is provided through [Repsy.io](https://repsy.io). Checkout
the [releases page](https://github.com/chRyNaN/emoji/releases) to get the latest version.
### Repository
```kotlin
repositories {
maven { url = uri("https://repo.repsy.io/mvn/chrynan/public") }
}
```
### Core Dependency
```kotlin
implementation("com.chrynan.emoji:emoji-core:$VERSION")
```
### Map Repository Dependency
```kotlin
implementation("com.chrynan.emoji:emoji-repo-map:$VERSION")
```
### SQLite Repository Dependency
```kotlin
implementation("com.chrynan.emoji:emoji-repo-sqlite:$VERSION")
```
### Jetpack Compose Dependency
```kotlin
implementation("com.chrynan.emoji:emoji-ui-compose:$VERSION")
```
## Documentation
More detailed documentation is available in the [docs](docs) folder. The entry point to the documentation can be
found [here](docs/index.md).
## License
```
Copyright 2020 chRyNaN
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.
```