CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

EmojiConfig (emoji)

@ckeditor/ckeditor5-emoji/src/emojiconfig

interface
See source

The configuration of the Emoji feature.

Read more about configuring the Emoji feature.

	ClassicEditor
		.create( editorElement, {
			emoji: ... // Emoji feature options.
		} )
		.then( ... )
		.catch( ... );

See all editor configuration options.

Filtering

Properties

  • definitionsUrl : string | undefined

    See source

    The URL from which the emoji definitions should be loaded.

    	ClassicEditor
		.create( editorElement, {
			plugins: [ Emoji, ... ],
			emoji: {
				definitionsUrl: ''
			}
		} )
		.then( ... )
		.catch( ... );

  • dropdownLimit : number | undefined

    See source

    The maximum number of emojis displayed in the dropdown list.

    	ClassicEditor
		.create( editorElement, {
			plugins: [ Emoji, ... ],
			emoji: {
				dropdownLimit: 4
			}
		} )
		.then( ... )
		.catch( ... );

    Defaults to 6

  • skinTone : SkinToneId | undefined

    See source

    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

    See source

    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

    See source

    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 the version.