Contribute to this guideReport an issue

guideFont

The Font plugin enables the following features in the editor:

  • FontFamily – Allows to change the font family by applying inline <span> elements with a font-family in the style attribute.
  • FontSize – Allows to control the font size by applying inline <span> elements that either have a CSS class or a font-size in the style attribute.
  • FontColor – Allows to control the font color by applying inline <span> elements with a color in the style attribute.
  • FontBackgroundColor – Allows to control the font background color by applying inline <span> elements with a background-color in the style attribute.

# Demo

This is a mixed text with different font sizes: tiny, small, big and huge.

This text has the "Arial, Helvetica, sans-serif" family set.

This text has the "Courier New, Courier, monospace" family set.

This text has light green color and blue background.

This text has white color and black background.

This text has custom color used for text and background. Those colors are available in the "document colors" section.

# Configuring the font family feature

It is possible to configure which font family options are supported by the editor. Use the fontFamily.options configuration option to do so.

Use the special 'default' keyword to use the default font family defined in the web page styles. It removes any custom font family.

For example, the following editor supports only two font families besides the default one:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        fontFamily: {
            options: [
                'default',
                'Ubuntu, Arial, sans-serif',
                'Ubuntu Mono, Courier New, Courier, monospace'
            ]
        },
        toolbar: [
            'heading', 'bulletedList', 'numberedList', 'fontFamily', 'undo', 'redo'
        ]
    } )
    .then( ... )
    .catch( ... );

This text has the "Ubuntu, Arial, sans-serif" font family set.

This text has the "Ubuntu Mono, Courier New, Courier, monospace" font family set.

# Configuring the font size feature

It is possible to configure which font size options are supported by the editor. Use the fontSize.options configuration option to do so.

Use the special 'default' keyword to use the default font size defined in the web page styles. It removes any custom font size.

The font size feature supports two ways of defining the configuration: using predefined (named) presets or simple numeric values.

# Using the predefined presets

The font size feature defines 4 named presets:

  • 'tiny'
  • 'small'
  • 'big'
  • 'huge'

Each size is represented in the view as a <span> element with the text-* class. For example, the 'tiny' preset looks as follows in the editor data:

<span class="text-tiny">...</span>

The CSS definition for the classes (presets) must be included in the web page styles where the edited content is rendered.

Here is an example of the font size CSS classes:

.text-tiny {
    font-size: 0.7em;
}

.text-small {
    font-size: 0.85em;
}

.text-big {
    font-size: 1.4em;
}

.text-huge {
    font-size: 1.8em;
}

An example of the editor that supports only two font sizes:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        fontSize: {
            options: [
                'tiny',
                'default',
                'big'
            ]
        },
        toolbar: [
            'heading', 'bulletedList', 'numberedList', 'fontSize', 'undo', 'redo'
        ]
    } )
    .then( ... )
    .catch( ... );

This is a mixed text with different font sizes: small and big

# Using numerical values

The font feature also supports numerical values.

In this case, each size is represented in the view as a <span> element with the font-size style set in px. For example, 14 will be represented in the editor data as:

<span style="font-size: 14px">...</span>

Here is an example of the editor that supports numerical font sizes. Note that 'default' is controlled by the default styles of the web page:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        fontSize: {
            options: [
                9,
                11,
                13,
                'default',
                17,
                19,
                21
            ]
        },
        toolbar: [
            'heading', 'bulletedList', 'numberedList', 'fontSize', 'undo', 'redo'
        ]
    } )
    .then( ... )
    .catch( ... );

9px

11px

13px

Normal

17px

19px

21px

# Configuring the font color and font background color features

Both font color and font background color features are configurable and share the same configuration format.

Please note that font color and font background color are separate plugins. They must be enabled and configured individually.

Check out the editor below with both features customized using the editor configuration:

Text in this sample has multiple font colors and font background colors.

Here are some examples of custom colors not defined in configuration which might be recognized and used in the "document colors" section.

# Specifying available colors

It is possible to configure which colors are available in the color dropdown. Use the fontColor.colors and fontBackgroundColor.colors configuration options to do so.

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        fontColor: {
            colors: [
                {
                    color: 'hsl(0, 0%, 0%)',
                    label: 'Black'
                },
                {
                    color: 'hsl(0, 0%, 30%)',
                    label: 'Dim grey'
                },
                {
                    color: 'hsl(0, 0%, 60%)',
                    label: 'Grey'
                },
                {
                    color: 'hsl(0, 0%, 90%)',
                    label: 'Light grey'
                },
                {
                    color: 'hsl(0, 0%, 100%)',
                    label: 'White',
                    hasBorder: true
                },

                // ...
            ]
        },
        fontBackgroundColor: {
            colors: [
                {
                    color: 'hsl(0, 75%, 60%)',
                    label: 'Red'
                },
                {
                    color: 'hsl(30, 75%, 60%)',
                    label: 'Orange'
                },
                {
                    color: 'hsl(60, 75%, 60%)',
                    label: 'Yellow'
                },
                {
                    color: 'hsl(90, 75%, 60%)',
                    label: 'Light green'
                },
                {
                    color: 'hsl(120, 75%, 60%)',
                    label: 'Green'
                },

                // ...
            ]
        },
        toolbar: [
            'heading', 'bulletedList', 'numberedList', 'fontColor', 'fontBackgroundColor', 'undo', 'redo'
        ]
    } )
    .then( ... )
    .catch( ... );

# Changing the geometry of the color grid

You can set the number of columns in the color picker by setting fontColor.columns and fontBackgroundColor.columns.

Usually, you will want to use this option when changing the number of available colors.

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        fontColor: {
            colors: [
                // 9 colors defined here...
            ]

            columns: 3, // so, let's display them in 3 columns

            // ...
        },
        fontBackgroundColor: {
            columns: 6,

            // ...
        },
        toolbar: [
            'heading', 'bulletedList', 'numberedList', 'fontColor', 'fontBackgroundColor', 'undo', 'redo'
        ]
    } )
    .then( ... )
    .catch( ... );

# Documents colors

The font and font background color pickers contain the Document colors section. It lists the colors already used in the document for the users to be able to easily reuse them (for consistency purposes).

By default the number of displayed document colors is limited to one row, but you can adjust it (or remove the whole section) by using fontColor.documentColors or fontBackgroundColor.documentColors options.

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        fontColor: {
            // Display 6 columns in the color grid.
            columns: 6,

            // And 12 document colors (2 rows of them).
            documentColors: 12,

            // ...
        },
        fontBackgroundColor: {
            // Remove the "Document colors" section.
            documentColors: 0,

            // ...
        },
        toolbar: [
            'heading', 'bulletedList', 'numberedList', 'fontColor', 'fontBackgroundColor', 'undo', 'redo'
        ]
    } )
    .then( ... )
    .catch( ... );

# Installation

To add this feature to your editor, install the @ckeditor/ckeditor5-font package:

npm install --save @ckeditor/ckeditor5-font

Then add it to your plugin list and the toolbar configuration:

import Font from '@ckeditor/ckeditor5-font/src/font';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Font, ... ],
        toolbar: [ 'fontSize', 'fontFamily', 'fontColor', 'fontBackgroundColor', ... ]
    } )
    .then( ... )
    .catch( ... );

You can also add just one or a selected few of the font features to your plugin list and the toolbar configuration:

import FontFamily from '@ckeditor/ckeditor5-font/src/fontfamily';

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

Read more about installing plugins.

# Common API

The FontFamily plugin registers the following components:

  • The 'fontFamily' dropdown.

  • The 'fontFamily' command.

    The number of options and their names correspond to the fontFamily.options configuration option.

    You can change the font family of the current selection by executing the command with a desired value:

    editor.execute( 'fontFamily', { value: 'Arial' } );
    

    The value must correspond to the first font name in the configuration string. For the following default configuration:

    fontFamily.options = [
        'default',
        'Arial, Helvetica, sans-serif',
        'Courier New, Courier, monospace',
        'Georgia, serif',
        'Lucida Sans Unicode, Lucida Grande, sans-serif',
        'Tahoma, Geneva, sans-serif',
        'Times New Roman, Times, serif',
        'Trebuchet MS, Helvetica, sans-serif',
        'Verdana, Geneva, sans-serif'
    ]
    

    the 'fontFamily' command will accept the corresponding strings as values:

    • 'Arial'
    • 'Courier New'
    • 'Georgia'
    • 'Lucida Sans Unicode'
    • 'Tahoma'
    • 'Times New Roman'
    • 'Trebuchet MS'
    • 'Verdana'

    Note that passing an empty value will remove the fontFamily attribute from the selection (default):

    editor.execute( 'fontFamily' );
    

The FontSize plugin registers the following components:

  • The 'fontSize' dropdown.

  • The 'fontSize' command.

    The number of options and their names correspond to the fontSize.options configuration option.

    You can change the font size of the current selection by executing the command with a desired value:

    // For numerical values:
    editor.execute( 'fontSize', { value: 10 } );
    
    // For named presets:
    editor.execute( 'fontSize', { value: 'small' } );
    

    Passing an empty value will remove any fontSize set:

    editor.execute( 'fontSize' );
    

The FontColor plugin registers the following components:

  • The 'fontColor' dropdown.

  • The 'fontColor' command.

    You can change the font color of the current selection by executing the command with a desired value:

    editor.execute( 'fontColor', { value: 'rgb(30, 188, 97)' } );
    

    Passing an empty value will remove the font color from the selection:

    editor.execute( 'fontColor' );
    

The FontBackgroundColor plugin registers the following components:

  • The 'fontBackgroundColor' dropdown.

  • The 'fontBackgroundColor' command.

    You can change the font background color of the current selection by executing the command with a desired value:

    editor.execute( 'fontBackgroundColor', { value: 'rgb(30, 188, 97)' } );
    

    Passing an empty value will remove the font background color from the selection:

    editor.execute( 'fontBackgroundColor' );
    

We recommend using the official CKEditor 5 inspector for development and debugging. It will give you tons of useful information about the state of the editor such as internal data structures, selection, commands, and many more.

# Contribute

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