Sign up (with export icon)

EmojiConfig

Api-interface iconinterface

The configuration of the Emoji feature.

Read more about configuring the Emoji feature.

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

See all editor configuration options.

Properties

  • Chevron-right icon

    The emoji definitions to use instead of downloading them from URL.

    Use this option to bundle the emoji database with your application, for example, when the Content Security Policy of the page does not allow downloading it. The definitions must have the same structure as the database hosted on the CKEditor 5 CDN.

    import definitions from './emoji/en.json';
    
    	ClassicEditor
    		.create( {
    			plugins: [ Emoji, ... ],
    			emoji: {
    				definitions
    			}
    		} )
    		.then( ... )
    		.catch( ... );
    Copy code

    If this option is provided, it takes precedence over the emoji.definitionsUrl and emoji.version options, which are ignored.

  • Chevron-right icon

    The URL from which the emoji definitions should be loaded.

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

    If the emoji.definitions option is provided, definitionsUrl is ignored as the passed definitions take precedence over the URL.

  • Chevron-right icon

    The maximum number of emojis displayed in the dropdown list.

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

    Defaults to 6

  • Chevron-right icon

    Initial skin tone for the emojis that support skin tones.

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

    Defaults to 'default'

  • Chevron-right icon

    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

    The emoji database version.

    ClassicEditor
    		.create( {
    			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. The same applies to the emoji.definitions option.