Special characters

The SpecialCharacters plugin provides a possibility to insert a special character into the rich-text editor.

# Demo

Use the editor below to see the special characters plugin in action.

# Configuration

By default, a few categories of special characters have been defined. You can easily customize the special characters available in your WYSIWYG editor installation by adding new categories, extending the existing ones or removing them altogether.

# Adding a new category

You can define a new special characters category using the SpecialCharacters#addItems() function.

For example, the following plugin adds the “Emoji” category to the special characters dropdown.

import SpecialCharacters from '@ckeditor/ckeditor5-special-characters/src/specialcharacters';
import SpecialCharactersEssentials from '@ckeditor/ckeditor5-special-characters/src/specialcharactersessentials';

function SpecialCharactersEmoji( editor ) {
    editor.plugins.get( 'SpecialCharacters' ).addItems( 'Emoji', [
        { title: 'smiley face', character: '😊' },
        { title: 'rocket', character: '🚀' },
        { title: 'wind blowing face', character: '🌬️' },
        { title: 'floppy disk', character: '💾' },
        { title: 'heart', character: '❤️' }
    ] );
}

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [
            SpecialCharacters, SpecialCharactersEssentials, SpecialCharactersEmoji,

            // Other plugins...
        ],
        toolbar: [ 'specialCharacters', ... ],
    } )
    .then( ... )
    .catch( ... );

After adding the above plugin to the editor configuration, the new category will become available in the special characters dropdown.

Below you can see a demo based on the example shown above. Use the special characters icon in the editor toolbar and then select “Emoji” in the select dropdown in order to insert an emoji into the WYSIWYG editor.

# Adding characters to an existing category

By using the SpecialCharacters#addItems() function you can also add new special characters into an existing category.

import SpecialCharacters from '@ckeditor/ckeditor5-special-characters/src/specialcharacters';
import SpecialCharactersEssentials from '@ckeditor/ckeditor5-special-characters/src/specialcharactersessentials';

function SpecialCharactersArrowsExtended( editor ) {
    editor.plugins.get( 'SpecialCharacters' ).addItems( 'Arrows', [
        { title: 'simple arrow left', character: '←' },
        { title: 'simple arrow up', character: '↑' },
        { title: 'simple arrow right', character: '→' },
        { title: 'simple arrow down', character: '↓' }
    ] );
}

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [
            SpecialCharacters, SpecialCharactersEssentials, SpecialCharactersArrowsExtended,

            // Other plugins...
        ],
        toolbar: [ 'specialCharacters', ... ],
    } )
    .then( ... )
    .catch( ... );

Below, you can see a demo based on the example shown above. Use the special characters icon in the editor toolbar and then select “Arrows” in the select dropdown. You will see that the category now contains the additional arrow characters added in the configuration above.

# Removing categories

The special characters feature exposes each category as a separate plugin. While the SpecialCharactersEssentials plugin can be used to conveniently include all of them, you can customize the category list by adding individual plugins with particular categories.

By default, the @ckeditor/ckeditor5-special-characters package provides special characters grouped into the following categories:

• SpecialCharactersArrows – Arrows special characters.
• SpecialCharactersCurrency – Currency special characters.
• SpecialCharactersLatin – Latin special characters.
• SpecialCharactersMathematical – Mathematical special characters.
• SpecialCharactersText – Text special characters.
• SpecialCharactersEssentials – Combines the plugins listed above.

For example, you can limit the categories to “Mathematical” and “Currency” only by picking the SpecialCharactersMathematical and SpecialCharactersCurrency plugins, like so:

import SpecialCharacters from '@ckeditor/ckeditor5-special-characters/src/specialcharacters';
import SpecialCharactersCurrency from '@ckeditor/ckeditor5-special-characters/src/specialcharacterscurrency';
import SpecialCharactersMathematical from '@ckeditor/ckeditor5-special-characters/src/specialcharactersmathematical';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [
            SpecialCharacters, SpecialCharactersCurrency, SpecialCharactersMathematical,

            // Other plugins...
        ],
        toolbar: [ 'specialCharacters', ... ],
    } )
    .then( ... )
    .catch( ... );

Below, you can see a demo based on the example shown above. After clicking the special character icon in the editor toolbar you can see that it contains fewer categories compared to other editors on this page.

# Installation

To add this feature to your rich-text editor, install the @ckeditor/ckeditor5-special-characters package:

npm install --save @ckeditor/ckeditor5-special-characters

And add it to your plugin list configuration:

// Core plugin that provides the API for the management of special characters and their categories.
import SpecialCharacters from '@ckeditor/ckeditor5-special-characters/src/specialcharacters';
// A plugin that combines a basic set of special characters.
import SpecialCharactersEssentials from '@ckeditor/ckeditor5-special-characters/src/specialcharactersessentials';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ SpecialCharacters, SpecialCharactersEssentials, ... ],
        toolbar: [ 'specialCharacters', ... ],
    } )
    .then( ... )
    .catch( ... );

# Common API

The SpecialCharacters plugin registers the UI button component ('specialCharacters').

# Contribute

The source code of the feature is available on GitHub in https://github.com/ckeditor/ckeditor5-special-characters.