How to Integrate Emojis Keyboard in your Android App
A simple library to add Emoji support to your Android app. In a
PopupWindow Emojis can be chosen. In order to edit and display text with
Emojis this library provides public APIs:
The library has 3 different providers to choose from (iOS, Google & Twitter).
For getting the above iOS Emojis simply add the dependency and code below.
And install the provider (preferably in your Application class):
Google
For getting the above Google Emojis simply add the dependency and code below.
And install the provider (preferably in your Application class):
Twitter
For getting the above Twitter Emojis simply add the dependency and code below.
And install the provider (preferably in your Application class):
All of the core API lays in, which is being pulled in automatically by the provided implementations (iOS, Google & Twitter):
Keep in mind that this custom class must be a subclass of
To open the
The
Note: Instantiate the
Just use the
If no instance or a null instance is set the default implementation will be used.
If no instance or a null instance is set the default implementation will be used.
If no style is set the keyboard will appear and exit as a regular PopupWindow.
This library currently ships with two animation styles as an example:
If no transformer is set ViewPager will behave as its usual self.
Please do note that this library currently does not ship any example
Page Transformers.
And one of these to your dependencies:
Licensed under the Apache License, Version 2.0
EmojiEditText
, EmojiTextView
& EmojiButton
.The library has 3 different providers to choose from (iOS, Google & Twitter).
iOS Emojis
For getting the above iOS Emojis simply add the dependency and code below.
compile 'com.vanniktech:emoji-ios:0.6.0'
// This line needs to be executed before any usage of EmojiTextView, EmojiEditText or EmojiButton.
EmojiManager.install(new IosEmojiProvider());
For getting the above Google Emojis simply add the dependency and code below.
compile 'com.vanniktech:emoji-google:0.6.0'
// This line needs to be executed before any usage of EmojiTextView, EmojiEditText or EmojiButton.
EmojiManager.install(new GoogleEmojiProvider());
For getting the above Twitter Emojis simply add the dependency and code below.
compile 'com.vanniktech:emoji-twitter:0.6.0'
// This line needs to be executed before any usage of EmojiTextView, EmojiEditText or EmojiButton.
EmojiManager.install(new TwitterEmojiProvider());
Custom Emojis
If you want to display your own Emojis you can create your own implementation ofEmojiProvider
and pass it to EmojiManager.install
.All of the core API lays in, which is being pulled in automatically by the provided implementations (iOS, Google & Twitter):
compile 'com.vanniktech:emoji:0.6.0'
Custom EditText
If you want to add the emoji support to your existingEditText
, you only have to
implement
EmojiEditTextInterface
. An example can be seen on the default EditText
implementation: EmojiEditText
.Keep in mind that this custom class must be a subclass of
android.view.View
.Inserting Emojis
Declare yourEmojiEditText
in your layout xml file.<com.vanniktech.emoji.EmojiEditText
android:id="@+id/emojiEditText"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:imeOptions="actionSend"
android:inputType="textCapSentences|textMultiLine"
android:maxLines="3"/>
EmojiPopup
execute the code below:final EmojiPopup emojiPopup = EmojiPopup.Builder.fromRootView(rootView).build(emojiEditText);
emojiPopup.toggle(); // Toggles visibility of the Popup.
emojiPopup.dismiss(); // Dismisses the Popup.
emojiPopup.isShowing(); // Returns true when Popup is showing.
rootView
is the rootView of your layout xml file which will be used for calculating the height of the keyboard.
emojiEditText
is the EmojiEditText
that you declared in your layout xml file.Note: Instantiate the
EmojiPopup
as early as possible in the lifecycle (e.g. in onCreate
of your Activity
or onViewCreated
in your Fragment
), otherwise the keyboard detection might not work as expected.Displaying Emojis
<com.vanniktech.emoji.EmojiTextView
android:id="@+id/emojiTextView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"/>
EmojiTextView
and call setText
with the String that contains Unicode encoded Emojis. To change the size of the displayed Emojis use the lineHeight
property from TextView.Listeners
TheEmojiPopup
builder allows you to declare several listeners.setOnSoftKeyboardCloseListener(OnSoftKeyboardCloseListener listener);
setOnEmojiClickListener(OnEmojiClickListener listener);
setOnSoftKeyboardOpenListener(OnSoftKeyboardOpenListener listener);
setOnEmojiPopupShownListener(OnEmojiPopupShownListener listener);
setOnEmojiPopupDismissListener(OnEmojiPopupDismissListener listener);
setOnEmojiBackspaceClickListener(OnEmojiBackspaceClickListener listener);
Custom Recent Emoji implementation
You can pass your own implementation of the recent Emojis. Just let one of your classes implement theRecentEmoji
interface and pass it when you're building the EmojiPopup
:setRecentEmoji(yourClassThatImplementsRecentEmoji)
Custom Variant Emoji implementation
You can pass your own implementation of the variant Emojis. Just let one of your classes implement theVariantEmoji
interface and pass it when you're building the EmojiPopup
:setVariantEmoji(yourClassThatImplementsVariantEmoji)
Animations
Custom keyboard enter and exit animations
You can pass your own animation style for enter and exit transitions of the Emoji keyboard while you're building theEmojiPopup
:setKeyboardAnimationStyle(R.style.emoji_fade_animation_style);
- R.style.emoji_slide_animation_style
- R.style.emoji_fade_animation_style
Custom page transformers
You can pass your own Page Transformer for the Emoji keyboard View Pager while you're building theEmojiPopup
:setPageTransformer(new MagicTransformer());
Snapshots
This library is also distributed as a SNAPSHOT if you like to check out the latest features.Note: The API is not stable and may change and break your code at any time if you use a SNAPSHOT.Add this to your repositories:
maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
compile 'com.vanniktech:emoji-ios:0.7.0-SNAPSHOT'
compile 'com.vanniktech:emoji-google:0.7.0-SNAPSHOT'
compile 'com.vanniktech:emoji-twitter:0.7.0-SNAPSHOT'
Proguard
No configuration needed.License
Copyright (C) 2016 Vanniktech - Niklas BaudyLicensed under the Apache License, Version 2.0
Comments
Post a Comment