KeyboardConfig class

Configuration options for the sticker keyboard.

Constructors

KeyboardConfig({int stickerColumns = 4, double stickerHorizontalSpacing = 5, double stickerVerticalSpacing = 5, EdgeInsets gridPadding = EdgeInsets.zero, 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, 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, bool withSafeArea = true, bool showBackSpace = false, bool showSearchButton = true, bool showBottomNav = true, List<CategorySticker> stickers = const [], CategoryTabBuilder? categoryTabBuilder, List<CustomKeyboardTab> customTabs = const [], CustomTabPlacement customTabPlacement = CustomTabPlacement.afterCategories})
Constructor
const

Properties

backspaceColor Color
The color of the backspace icon button
final
bgColor Color
The background color of the Widget
final
categoryTabBuilder CategoryTabBuilder?
Optional builder to customize category tabs. When null, the default text-based tabs are shown.
final
customTabPlacement CustomTabPlacement
Placement of custom tabs in the tab bar.
final
customTabs List<CustomKeyboardTab>
Optional custom tabs to render alongside categories.
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
noRecents Widget
A widget (usually Text) to be displayed if no recent stickers to display
final
progressIndicatorColor Color
The color of the loading indicator during initialization
final
recentsLimit int
Limit of recently used stickers that will be saved
final
replaceRecentOnLimitExceed bool
Replace latest 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.
final
showBottomNav bool
Show bottom navigation bar.
final
showRecentsTab bool
Show extra tab with recently used stickers
final
showSearchButton bool
Show search button on the bottom nav
final
stickerColumns int
Number of stickers per row
final
stickerHorizontalSpacing double
Horizontal spacing between stickers
final
stickers List<CategorySticker>
Initial stickers
final
stickerVerticalSpacing double
Vertical spacing between stickers
final
tabIndicatorAnimDuration Duration
Duration of tab indicator to animate to next category
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