EmoticonGIFKeyboard is an easy to integrate, customizable and lightweight library to add support for emojis and GIFs.
- Highly customizable.
- Extremely lightweight 🏋. You only have to add the icon packs you want to use by adding extra dependency, so you don't have to add emoticon icons you don't want to use.
- ❤ for Emoticons
- More than 1400 emoticons. This library includes all the emoticons listed under Emoticons 6.0 standards.
- 6 emoticons categories.
- 🔍 Search emoticons by their name or meaning.
- Add you favourite emoticons icon theme (e.g ios, google, samsung emoticons) by adding readily available emoticon icon packs.
- ❤ for GIFs
- Displays trending GIFs for batter suggestion.
- 🔍 Search GIFs based on the content and meaning.
- Select your favourite GIF provider (e.g. Giphy, Tenor) by adding available GIF packs.
- Custom widgets (e.g.
EmoticonTextView
,EmoticonEditText
andEmoticonButton
) to render custom emoticon icons throughout application. - Easily disable emoticons or GIF functionality if you don't want.
-
- Add below lines to
app/build.gradle
file of your project.
dependencies { compile 'com.kevalpatel2106:emoticongifkeyboard:1.0' }
- Add below lines to
- To integrate using maven visit this page.
-
- Create
EmoticonConfig
to configure emoticons. - Set the custom emoticon icon provider using
EmoticonConfig#setEmoticonProvider()
. If you don't set any icon provider here, library will render system emoticons. You can pic custom emoticon icons from here. - Set the
EmoticonSelectListener
usingEmoticonConfig#setEmoticonSelectListener()
. This will notify you when user selects any emoticon from list or user preses back button.
EmoticonGIFKeyboardFragment.EmoticonConfig emoticonConfig = new EmoticonGIFKeyboardFragment.EmoticonConfig() .setEmoticonProvider(IosEmoticonProvider.create()) /* NOTE: The process of removing last character when user preses back space will handle by library if your edit text is in focus. */ .setEmoticonSelectListener(new EmoticonSelectListener() { @Override public void emoticonSelected(Emoticon emoticon) { //Do something with new emoticon. } @Override public void onBackSpace() { //Do something here to handle backspace event. //The process of removing last character when user preses back space will handle //by library if your edit text is in focus. } });
- Create
-
- Set the desired GIF provider by passing desired
GIFProvider
in constructorGIFConfig()
. Here is the list of supported GIF providers. It is required to set GIF provider before adding fragment into container. - Implement GIF select listener using
GIFConfig#setGifSelectListener()
. This will notify you when user selects new GIF.
//Create GIF config EmoticonGIFKeyboardFragment.GIFConfig gifConfig = new EmoticonGIFKeyboardFragment /* Here we are using GIPHY to provide GIFs. Create Giphy GIF provider by passing your key. It is required to set GIF provider before adding fragment into container. */ .GIFConfig(GiphyGifProvider.create(this, "564ce7370bf347f2b7c0e4746593c179")) .setGifSelectListener(new GifSelectListener() { @Override public void onGifSelected(@NonNull Gif gif) { //Do something with the selected GIF. Log.d(TAG, "onGifSelected: " + gif.getGifUrl()); } });
- Set the desired GIF provider by passing desired
-
- Create new
EmoticonGIFKeyboardFragment
by passingEmoticonConfig
andGIFConfig
. If you pass null toEmoticonConfig
, emoticon functionality will be disabled. Also, if you passGIFConfig
as null, GIF functionality will be disabled. - Add the generated fragment to the container.
EmoticonGIFKeyboardFragment emoticonGIFKeyboardFragment = EmoticonGIFKeyboardFragment .getNewInstance(findViewById(R.id.keyboard_container), emoticonConfig, gifConfig); //Adding the keyboard fragment to keyboard_container. getSupportFragmentManager() .beginTransaction() .replace(R.id.keyboard_container, EmoticonGIFKeyboardFragment) .commit();
- Create new
-
- Open keyboard view by calling
EmoticonGIFKeyboardFragment#open()
and close it by callingEmoticonGIFKeyboardFragment#close()
. - Handle back button press events by using
EmoticonGIFKeyboardFragment#handleBackPressed()
in your activity.
@Override public void onBackPressed() { if (!mEmoticonGIFKeyboardFragment.handleBackPressed()) super.onBackPressed(); }
- Open keyboard view by calling
Emoticons | GIFs |
---|---|
![]() |
![]() |
Only Emoticons | Only GIFs |
---|---|
![]() |
![]() |
Search Emoticons | Search GIFs |
---|---|
![]() |
![]() |
Icon | Emoticon Pack | Gradle Dependency | Version |
---|---|---|---|
![]() |
Apple | compile 'com.kevalpatel2106:emoticonpack-ios:<latest> |
|
![]() |
compile 'com.kevalpatel2106:emoticonpack-google:<latest> |
|
|
![]() |
compile 'com.kevalpatel2106:emoticonpack-facebook:<latest> |
|
|
![]() |
compile 'com.kevalpatel2106:emoticonpack-twitter:<latest> |
|
|
![]() |
Samsung | compile 'com.kevalpatel2106:emoticonpack-samsung:<latest> |
|
![]() |
Windows | compile 'com.kevalpatel2106:emoticonpack-windows:<latest> |
|
![]() |
Messenger | compile 'com.kevalpatel2106:emoticonpack-messenger:<latest> |
|
![]() |
Emojidex | compile 'com.kevalpatel2106:emoticonpack-emojidex:<latest> |
|
![]() |
EmojiOne | compile 'com.kevalpatel2106:emoticonpack-emojione:<latest> |
|
GIF Provider | Module | Dependency | Version |
---|---|---|---|
giphy.com | Giphy | compile 'com.kevalpatel2106:gifpack-giphy:<latest> |
|
tenor.com | Tenor | compile 'com.kevalpatel2106:gifpack-tenor:<latest> |
|
- Based on Hieu Rocker's library Emojicon.
- Emoticon graphics and emoticon details are from Emojipedia. (See mEmoticon-scrapper module.)
- Check out contribution guidelines 👉CONTRIBUTING.md
Copyright 2017 Keval Patel
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.