EmojiEditorConfigs class

Configuration options for an emoji editor.

EmojiEditorConfigs allows you to define various settings for an emoji editor. You can configure features like enabling/disabling the editor, setting the initial scale, defining behavior for the recent tab, enabling skin tones, customizing text style, and more.

Example usage:

EmojiEditorConfigs(
  enabled: true,
  initScale: 5.0,
  recentTabBehavior: RecentTabBehavior.RECENT,
  enableSkinTones: true,
  recentsLimit: 28,
  textStyle: TextStyle(fontSize: 16.0),
  emojiSet: myCustomEmojiSet,
  verticalSpacing: 4.0,
  horizontalSpacing: 4.0,
  gridPadding: EdgeInsets.all(8.0),
  initCategory: Category.SMILEYS,
  replaceEmojiOnLimitExceed: false,
  categoryIcons: CategoryIcons(
    smileys: Icons.tag_faces,
    animals: Icons.pets,
  ),
  customSkinColorOverlayHorizontalOffset: 12.0,
);

Constructors

EmojiEditorConfigs({bool enabled = true, double initScale = 5.0, RecentTabBehavior recentTabBehavior = RecentTabBehavior.RECENT, bool enableSkinTones = true, int recentsLimit = 28, TextStyle textStyle = const TextStyle(fontFamilyFallback: ['Apple Color Emoji']), bool checkPlatformCompatibility = true, List<CategoryEmoji>? emojiSet, double verticalSpacing = 0, double horizontalSpacing = 0, EdgeInsets gridPadding = EdgeInsets.zero, Category initCategory = Category.RECENT, bool replaceEmojiOnLimitExceed = false, CategoryIcons categoryIcons = const CategoryIcons(), double? customSkinColorOverlayHorizontalOffset})

Creates an instance of EmojiEditorConfigs with optional settings.

const

Properties

categoryIcons → CategoryIcons

Determines the icons to display for each Category.

final

checkPlatformCompatibility → bool

Verify that emoji glyph is supported by the platform (Android only)

final

customSkinColorOverlayHorizontalOffset → double?

Customize skin color overlay horizontal offset, especially useful when EmojiPicker is not aligned to the left border of the screen.

final

emojiSet → List<CategoryEmoji>?

Custom emojis; if set, overrides default emojis provided by the library.

final

enabled → bool

Indicates whether the emoji editor is enabled.

final

enableSkinTones → bool

Enables the feature to select skin tones for certain emojis.

final

gridPadding → EdgeInsets

The padding of the GridView, default is EdgeInsets.zero.

final

hashCode → int

The hash code for this object.

no setter, inherited

horizontalSpacing → double

Horizontal spacing between emojis.

final

initCategory → Category

The initial Category that will be selected. The corresponding category button in the bottom bar will be darkened.

final

initScale → double

The initial scale for displaying emojis.

final

recentsLimit → int

Limits the number of recently used emojis that will be saved.

final

recentTabBehavior → RecentTabBehavior

Defines the behavior of the recent tab (Recent, Popular).

final

replaceEmojiOnLimitExceed → bool

Determines whether to replace the latest emoji in the recents list when the limit is exceeded.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

textStyle → TextStyle

Custom emoji text style to apply to emoji characters in the grid.

final

verticalSpacing → double

Vertical spacing between emojis.

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