Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/withplum/EmojiBottomSheetDialog
A nice Android bottom sheet dialog populated with AndroidX EmojiCompat supported emojis.
https://github.com/withplum/EmojiBottomSheetDialog
android bottomsheet emojicompat emojis kotlin
Last synced: 3 months ago
JSON representation
A nice Android bottom sheet dialog populated with AndroidX EmojiCompat supported emojis.
- Host: GitHub
- URL: https://github.com/withplum/EmojiBottomSheetDialog
- Owner: withplum
- License: mit
- Created: 2020-09-06T09:31:13.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-05T13:26:10.000Z (3 months ago)
- Last Synced: 2024-08-06T11:32:56.393Z (3 months ago)
- Topics: android, bottomsheet, emojicompat, emojis, kotlin
- Language: Kotlin
- Homepage:
- Size: 398 KB
- Stars: 17
- Watchers: 9
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - withplum/EmojiBottomSheetDialog - A nice Android bottom sheet dialog populated with AndroidX EmojiCompat supported emojis. (Kotlin)
README
[](https://search.maven.org/search?q=g:%22com.withplum%22%20AND%20a:%22emojiBottomSheetDialog%22)
# EmojiBottomSheetDialog
A nice Android bottom sheet dialog populated with AndroidX EmojiCompat supported emojis.
## Usage
### Add the dependency
```gradle
dependencies {
implementation("com.withplum:emojiBottomSheetDialog:)
}
```
### Style customization
The appearance of the Bottom Sheet can be customised by providing a custom style like this example:
```xml
<item name="colorPrimary">@color/colorPrimary</item>
<item name="colorPrimaryDark">@color/colorPrimaryDark</item>
<item name="colorAccent">@color/colorAccent</item>
<item name="android:windowBackground">@color/white</item>
<item name="bottomSheetDialogTheme">@style/ModalBottomSheetDialog</item>
<item name="colorSurface">@color/white</item>
<item name="emojiBottomSheetTitleTextAppearance">@style/MyCustomEmojiBottomTitleTextAppearance</item>
<item name="emojiBottomSheetSectionHeaderTextAppearance">@style/MyCustomEmojiBottomSheetSectionHeaderTextAppearance
</item>
<item name="android:textColor">@color/greyDark</item>
<item name="android:textColor">@color/greyMid</item>
```
The title and section headers can be styled by providing custom text appearances in the style.
| Element | Attribute | Default value |
|--------------------|-----------------------------------------------|------------------------------------------------------|
| **Title** | `emojiBottomSheetTitleTextAppearance` | `@style/TextAppearance.MaterialComponents.Headline6` |
| **Section Header** | `emojiBottomSheetSectionHeaderTextAppearance` | `TextAppearance.MaterialComponents.Body1` |
| **Background** | `colorSurface` | `?android:attr/colorSurface` |
### Initialize the dialog
```kotlin
private fun initializeEmojiCategoriesPreferred() {
emojiItemViewList = EmojiCategoryTransformer().transform(initializeEmojiCategoryList())
}
private fun initializeEmojiCategoryList(): List {
return listOf(
ActivitiesCategory(getString(R.string.activitiesCategoryTitle)),
AnimalsNatureCategory(getString(R.string.animalsAndNatureTitle)),
FoodDrinkCategory(getString(R.string.foodAndDrinkTitle)),
FlagsCategory(getString(R.string.flagsTitle)),
ObjectsCategory(getString(R.string.objectsTitle)),
SmileysPeopleCategory(getString(R.string.smileysAndPeopleTitle)),
SymbolsCategory(getString(R.string.symbolsTitle)),
TravelPlacesCategory(getString(R.string.travelAndPlacesTitle))
)
}
private fun showEmojiDialog() {
EmojiPickerDialog.Builder(this@MainActivity, emojiItemViewList)
.dismissWithAnimation(true)
.title(getString(R.string.emojiDialogTitle))
.cancelable(true)
.listener(object : EmojiClickListener {
override fun emojiClicked(unicode: EmojiItemView) {
selectedEmoji.text = unicode.value
selectedEmojiName.text = unicode.name
}
}).build().show()
}
```
## Breaking changes of version `3.0.0`
1. Certain APIs have become `internal`.
2. In version `3.0.0` the library uses Java 17. You'll have to add the following to your build file:
```kotlin
android {
compileOptions {
sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17
}
kotlinOptions {
jvmTarget = "17"
}
}
```
## Breaking changes of version `2.0.0`
In version `2.0.0` we migrated to [Emoji2](https://developer.android.com/jetpack/androidx/releases/emoji2).
This results in the removal of:
* `EmojiCompatUtils`
* `EmojInitListener`
* `EmojiValues` which was mostly used internally.
Initialization now happens internally via the [Emoji2](https://developer.android.com/jetpack/androidx/releases/emoji2).
If you still need an initialization listener you should use the official API as described [here](https://developer.android.com/develop/ui/views/text-and-emoji/emoji2#add-initialization-listeners).
The whole document [Support modern emoji - Android Developers](https://developer.android.com/develop/ui/views/text-and-emoji/emoji2) provides further details.
The same document will help you if you rely on AppCompat version lower than `1.4.0-alpha01` or on the [Emoji](https://developer.android.com/jetpack/androidx/releases/emoji)
library itself which provides [these custom views](https://developer.android.com/reference/kotlin/androidx/emoji/widget/package-summary) for compatibility.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
### Publishing
The project uses [gradle-maven-publish-plugin](https://github.com/vanniktech/gradle-maven-publish-plugin) to publish artifacts to maven central.
To upload archives use the command (after having put the appropriate credentials in gradle properties or env variables):
```
./gradlew clean build emojiBottomSheetDialog:publish
```