Block indentation

The block indentation feature allows you to set indentation for text blocks such as paragraphs or headings and lists. It is implemented by three plugins: Indent, IndentBlock and List.

# Demo

# Configuring the block indentation feature

This feature offers a few configuration options that can be used to adjust the text block indentation behavior.

# Using offset and unit

By default, the block indentation feature increases or decreases the current indentation by the given offset, using the given unit.

The rich-text editor from the demo section above uses the default configuration, which defines a 40px indentation step.

You can change that value to, for example, 1em:

import Indent from '@ckeditor/ckeditor5-indent/src/indent';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Indent, ... ],
        toolbar: {
            items: [ 'heading', '|', 'outdent', 'indent', '|', 'bulletedList', 'numberedList', '|', 'undo', 'redo' ]
        },
        indentBlock: {
            offset: 1,
            unit: 'em'
        }
    } )
    .then( ... )
    .catch( ... );

# Using CSS classes

If you want more semantics in your content, use CSS classes instead of fixed indentation units. You can then adjust the levels in the style sheets of your application whenever you want.

Here is how you can configure the block indentation feature to set indentation by applying one of the defined CSS classes:

import Indent from '@ckeditor/ckeditor5-indent/src/indent';
import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Indent, IndentBlock, ... ],
        toolbar: {
            items: [ 'heading', '|', 'outdent', 'indent', '|', 'bulletedList', 'numberedList', '|', 'undo', 'redo' ]
        },
        indentBlock: {
            classes: [
                'custom-block-indent-a', // First step - smallest indentation.
                'custom-block-indent-b',
                'custom-block-indent-c'  // Last step - biggest indentation.
            ]
        }
    } )
    .then( ... )
    .catch( ... );

Using classes instead of fixed units (px or em) has another advantage — you retain control over what indentation levels are used in the documents. For instance, you can limit indentation to 2 or 3 different levels and there is no way the users can go beyond that. In the example above, the .custom-block-indent-c class level is the maximum allowed indentation value. This should help keep your content clean and predictable.

In this configuration the WYSIWYG editor will restrict indentation levels to the set of provided classes. The class with the last index in the array has the biggest indentation.

In the demo below the CSS classes are defined as follows:

.custom-block-indent-a {
    margin-left: 10%;
}

.custom-block-indent-b {
    margin-left: 20%;
}

.custom-block-indent-c {
    margin-left: 30%;
}

# Indenting lists

Besides controlling text block indentation, the same set of buttons (outdent, indent) allows for indenting list items (nesting them).

This mechanism is completely transparent to the user. From the code perspective, the buttons are implemented by the Indent plugin, but neither these buttons nor the respective commands implement any functionality by default.

The target behavior comes from two other plugins:

• IndentBlock – The indent block feature controls the indentation of elements such as paragraphs and headings.
• List – The list feature implements the indentation (nesting) of lists.

This means that if you want to allow indenting lists only, you can do that by loading only the Indent and List plugins. If you want the full behavior, you need to load all 3 plugins (Indent, IndentBlock and List).

# Installation

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

npm install --save @ckeditor/ckeditor5-indent

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

import Indent from '@ckeditor/ckeditor5-indent/src/indent';
import IndentBlock from '@ckeditor/ckeditor5-indent/src/indentblock';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Indent, IndentBlock, ... ],
        toolbar: [ 'outdent', 'indent', ... ]
    } )
    .then( ... )
    .catch( ... );

# Common API

The Indent plugin registers the following components:

• The 'indent' command.

  This command does not implement any indentation behavior by itself. It executes either indentBlock (described below) or indentList, depending on which of these commands is enabled.

  Read more in the Indenting lists section above.

• The 'outdent' command.

  This command does not implement any indentation behavior by itself. It executes either outdentBlock (described below) or outdentList, depending on which of these commands is enabled.

  Read more in the Indenting lists section above.

The IndentBlock plugin registers the following components:

• The 'indentBlock' command.

  You can increase the indentation of the text block that contains the selection by:

  editor.execute( 'indentBlock' );
  

• The 'outdentBlock' command.

  You can decrease the indentation of the text block that contains the selection by:

  editor.execute( 'outdentBlock' );
  

# Contribute

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