EmojiConfig
The configuration of the Emoji feature.
Read more about configuring the Emoji feature.
ClassicEditor
.create( editorElement, {
emoji: ... // Emoji feature options.
} )
.then( ... )
.catch( ... );
Properties
-
definitionsUrl : string | undefined
module:emoji/emojiconfig~EmojiConfig#definitionsUrl
The URL from which the emoji definitions should be loaded.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { definitionsUrl: '' } } ) .then( ... ) .catch( ... );
-
dropdownLimit : number | undefined
module:emoji/emojiconfig~EmojiConfig#dropdownLimit
The maximum number of emojis displayed in the dropdown list.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { dropdownLimit: 4 } } ) .then( ... ) .catch( ... );
Defaults to
6
-
skinTone : EmojiSkinToneId | undefined
module:emoji/emojiconfig~EmojiConfig#skinTone
Initial skin tone for the emojis that support skin tones.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { skinTone: 'medium' } } ) .then( ... ) .catch( ... );
Defaults to
'default'
-
useCustomFont : boolean | undefined
module:emoji/emojiconfig~EmojiConfig#useCustomFont
The availability of the emoji depends on the operating system. Different systems will have different Unicode support.
By default, the feature tries to filter out emojis not supported by your operating system. This means that instead of previewing an emoji, the feature renders a black square.
If you customize the emoji availability and appearance, it is highly recommended to disable the filtering mechanism because it uses a font built into your system instead of the provided custom font.
-
version : EmojiVersion | undefined
module:emoji/emojiconfig~EmojiConfig#version
The emoji database version.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { version: 15 } } ) .then( ... ) .catch( ... );
If the
emoji.definitionsUrl
option is provided,version
is ignored as the defined URL takes precedence over theversion
.