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 | undefinedmodule:emoji/emojiconfig~EmojiConfig#definitionsUrlThe URL from which the emoji definitions should be loaded.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { definitionsUrl: '' } } ) .then( ... ) .catch( ... );Copy codedropdownLimit : number | undefinedmodule:emoji/emojiconfig~EmojiConfig#dropdownLimitThe maximum number of emojis displayed in the dropdown list.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { dropdownLimit: 4 } } ) .then( ... ) .catch( ... );Copy codeDefaults to
6skinTone : EmojiSkinToneId | undefinedmodule:emoji/emojiconfig~EmojiConfig#skinToneInitial skin tone for the emojis that support skin tones.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { skinTone: 'medium' } } ) .then( ... ) .catch( ... );Copy codeDefaults to
'default'useCustomFont : boolean | undefinedmodule:emoji/emojiconfig~EmojiConfig#useCustomFontThe 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 | undefinedmodule:emoji/emojiconfig~EmojiConfig#versionThe emoji database version.
ClassicEditor .create( editorElement, { plugins: [ Emoji, ... ], emoji: { version: 15 } } ) .then( ... ) .catch( ... );Copy codeIf the
emoji.definitionsUrloption is provided,versionis ignored as the defined URL takes precedence over theversion.