# EmojiConfig

interface

The configuration of the Emoji feature.

Read more about [configuring the Emoji feature](../features/emoji.md#configuration).

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

See [all editor configuration options](module_core_editor_editorconfig-EditorConfig.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-emoji/src/emojiconfig.ts#L26)

<a id="properties">

## Properties

<a id="member-definitionsUrl">

### `definitionsUrl?: string`

The URL from which the emoji definitions should be loaded.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-emoji/src/emojiconfig.ts#L81)

<a id="member-dropdownLimit">

### `dropdownLimit?: number`

The maximum number of emojis displayed in the dropdown list.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-emoji/src/emojiconfig.ts#L45)

Defaults to `6`

<a id="member-skinTone">

### `skinTone?: EmojiSkinToneId`

Initial skin tone for the emojis that support skin tones.

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

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-emoji/src/emojiconfig.ts#L64)

Defaults to `'default'`

<a id="member-useCustomFont">

### `useCustomFont?: boolean`

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](../features/emoji.md#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.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-emoji/src/emojiconfig.ts#L113)

<a id="member-version">

### `version?: EmojiVersion`

The emoji database version.

```typescript
ClassicEditor
		.create( {
			plugins: [ Emoji, ... ],
			emoji: {
				version: 15
			}
		} )
		.then( ... )
		.catch( ... );
```

If the [`emoji.definitionsUrl`](#member-definitionsUrl) option is provided, `version` is ignored as the defined URL takes precedence over the `version`.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-emoji/src/emojiconfig.ts#L101)

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)