KeyboardConfig class
KeyboardConfig for customizations
Constructors
-
KeyboardConfig({bool useEmoji = true, bool useGif = true, bool useSticker = true, String? giphyAPIKey, List<
String> gifTabs = const ['Haha', 'Sad', 'Love', 'Reaction'], int gifColumns = 3, double gifVerticalSpacing = 5, double gifHorizontalSpacing = 5, int stickerColumns = 4, String gifLang = GiphyLanguage.english, double stickerHorizontalSpacing = 5, double stickerVerticalSpacing = 5, int emojiColumns = 7, double emojiSizeMax = 32.0, double emojiVerticalSpacing = 0, double emojiHorizontalSpacing = 0, EdgeInsets gridPadding = EdgeInsets.zero, Category initCategory = Category.RECENT, Color bgColor = const Color(0xFFEBEFF2), Color indicatorColor = Colors.blue, Color iconColor = Colors.grey, Color iconColorSelected = Colors.blue, Color progressIndicatorColor = Colors.blue, Color backspaceColor = Colors.blue, Color skinToneDialogBgColor = Colors.white, Color skinToneIndicatorColor = Colors.grey, bool enableSkinTones = true, bool showRecentsTab = true, int recentsLimit = 28, bool replaceRecentOnLimitExceed = false, Widget noRecents = const Text('No Recents', style: TextStyle(fontSize: 20, color: Colors.black26), textAlign: TextAlign.center), Duration tabIndicatorAnimDuration = kTabScrollDuration, CategoryIcons categoryIcons = const CategoryIcons(), ButtonMode buttonMode = ButtonMode.MATERIAL, bool withSafeArea = true, bool showBackSpace = true, bool showSearchButton = true}) -
Constructor
const
Properties
- backspaceColor → Color
-
The color of the backspace icon button
final
- bgColor → Color
-
The background color of the Widget
final
-
Change between Material and Cupertino button style
final
- categoryIcons → CategoryIcons
-
Determines the icon to display for each Category
final
- emojiColumns → int
-
Number of emojis per row
final
- emojiHorizontalSpacing → double
-
Horizontal spacing between emojis
final
- emojiSizeMax → double
-
Width and height the emoji will be maximal displayed
Can be smaller due to screen size and amount of columns
final
- emojiVerticalSpacing → double
-
Vertical spacing between emojis
final
- enableSkinTones → bool
-
Enable feature to select a skin tone of certain emoji's
final
- gifColumns → int
-
Number of gifs per row
final
- gifHorizontalSpacing → double
-
Horizontal spacing between gifs
final
- gifLang → String
-
Language giphy suppose to use in search
Default is english GiphyLanguage.english
final
-
gifTabs
→ List<
String> -
Create tabs that would serve as categories for gifs from giphy
Default is
'Haha', 'Sad', 'Love', 'Reaction'final - gifVerticalSpacing → double
-
Vertical spacing between gifs
final
- giphyAPIKey → String?
-
Your Giphy API Key
It is required when using gif
You can get one from https://developers.giphy.com/dashboard
final
- gridPadding → EdgeInsets
-
The padding of GridView, default is EdgeInsets.zero
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- iconColor → Color
-
The color of the category icons
final
- iconColorSelected → Color
-
The color of the category icon when selected
final
- indicatorColor → Color
-
The color of the category indicator
final
- initCategory → Category
-
The initial Category that will be selected
This Category will have its button in the bottomBar darkened
final
- noRecents → Widget
-
A widget (usually Text) to be displayed if no recent emojis to display
final
- progressIndicatorColor → Color
-
The color of the loading indicator during initialization
final
- recentsLimit → int
-
Limit of recently used emoji that will be saved
final
- replaceRecentOnLimitExceed → bool
-
Replace latest emoji/gif/sticker on recents list on limit exceed
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showBackSpace → bool
-
Show backspace button on the bottom nav
Backspace is normally used for deleting characters/emojis
final
- showRecentsTab → bool
-
Show extra tab with recently used emoji
final
- showSearchButton → bool
-
Show search button on the bottom nav
final
- skinToneDialogBgColor → Color
-
The background color of the skin tone dialog
final
- skinToneIndicatorColor → Color
-
Color of the small triangle next to multiple skin tone emoji
final
- stickerColumns → int
-
Number of stickers per row
final
- stickerHorizontalSpacing → double
-
Horizontal spacing between stickers
final
- stickerVerticalSpacing → double
-
Vertical spacing between stickers
final
- tabIndicatorAnimDuration → Duration
-
Duration of tab indicator to animate to next category
final
- useEmoji → bool
-
Enable Emoji keyboard
final
- useGif → bool
-
Enable gif keyboard
final
- useSticker → bool
-
Enable sticker keyboard
final
- withSafeArea → bool
-
Apply SafeArea widget around keyboard
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited