Sign up (with export icon)

EmojiConfig

Api-interface icon interface

The configuration of the Emoji feature.

Read more about configuring the Emoji feature.

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

See all editor configuration options.

Properties

  • Chevron-right icon

    definitionsUrl : string | undefined

    The URL from which the emoji definitions should be loaded.

    	ClassicEditor
    		.create( editorElement, {
    			plugins: [ Emoji, ... ],
    			emoji: {
    				definitionsUrl: ''
    			}
    		} )
    		.then( ... )
    		.catch( ... );
    
    Copy code
  • Chevron-right icon

    dropdownLimit : number | undefined

    The maximum number of emojis displayed in the dropdown list.

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

    Defaults to 6

  • Chevron-right icon

    skinTone : EmojiSkinToneId | undefined

    Initial skin tone for the emojis that support skin tones.

    	ClassicEditor
    		.create( editorElement, {
    			plugins: [ Emoji, ... ],
    			emoji: {
    				skinTone: 'medium'
    			}
    		} )
    		.then( ... )
    		.catch( ... );
    
    Copy code

    Defaults to 'default'

  • Chevron-right icon

    useCustomFont : boolean | undefined

    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.

  • Chevron-right icon

    version : EmojiVersion | undefined

    The emoji database version.

    	ClassicEditor
    		.create( editorElement, {
    			plugins: [ Emoji, ... ],
    			emoji: {
    				version: 15
    			}
    		} )
    		.then( ... )
    		.catch( ... );
    
    Copy code

    If the emoji.definitionsUrl option is provided, version is ignored as the defined URL takes precedence over the version.