Block quote

The block quote feature lets you easily include block quotations or pull quotes in your content. It is also an attractive way to draw the readers’ attention to selected parts of the text.

# Demo

Use the block quote toolbar button in the editor below to see the feature in action. You can also type > followed by a space before the quotation to format it on the go thanks to the autoformatting feature.

# Nested block quotes

Starting from version 27.1.0, CKEditor 5 will properly display a block quote nested in another block quote. This sort of structure is indispensable in email editors or discussion forums. The ability to cite previous messages and preserve a correct quotation structure is often crucial to maintain the flow of communication. Nested block quotes may also prove useful for scientific or academic papers, but articles citing sources and referring to previous writing would often use it, too.

Support for nested block quotes is provided as backward compatibility for loading pre-existing content, for example created in CKEditor 4. Additionally, pasting content with nested block quotes is supported. You can also nest a block quote in another block quote using the drag and drop mechanism – just select an existing block quote and drag it into another.

# Installation

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

npm install --save @ckeditor/ckeditor5-block-quote

And add it to your plugin list configuration:

import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ BlockQuote, /* ... */ ],
        toolbar: [ 'blockQuote', /* ... */ ]
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# Configuration

# Disallow nesting block quotes

By default, the editor supports inserting a block quote into another block quote.

To disallow nesting block quotes, you need to register an additional schema rule. It needs to be added before the data is loaded into the editor, hence it is best to implement it as a plugin:

function DisallowNestingBlockQuotes( editor ) {
    editor.model.schema.addChildCheck( ( context, childDefinition ) => {
        if ( context.endsWith( 'blockQuote' ) && childDefinition.name == 'blockQuote' ) {
            return false;
        }
    } );
}

// Pass it via config.extraPlugins or config.plugins:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        extraPlugins: [ DisallowNestingBlockQuotes ],

        // The rest of the configuration.
        // ...
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# Related features

Here are some other CKEditor 5 features that you can use similarly to the block quote plugin to structure your text better:

• Block indentation – Set indentation for text blocks such as paragraphs or lists.
• Code block – Insert longer, multiline code listings.
• Text alignment – Align your content left, right, center it, or justify.
• Autoformatting – Add formatting elements (such as block quotes) as you type with Markdown code.

# Common API

The BlockQuote plugin registers:

• the 'blockQuote' UI button component implemented by the block quote UI feature,
• the 'blockQuote' command implemented by the block quote editing feature.

You can execute the command using the editor.execute() method:

// Applies block quote to the selected content.
editor.execute( 'blockQuote' );

# Contribute

The source code of the feature is available on GitHub at https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-block-quote.