Sign up (with export icon)

Document title

Contribute to this guide Show the table of contents

The title feature lets you add a single title field at the beginning of your document. This way you can clearly divide your content into the title and body sections.

Demo

Copy link

Use the editor below to create a document with distinct title and body sections. You can check the content of the title and body elements in the console below.

Copy code
Copy code
Copy code

Keyboard navigation

Copy link

The title plugin lets you move from the title to the body element using the Tab key, providing form-like experience. When the selection is at the beginning of the first body element, you can go back to the title element using Shift+Tab. You can also use Enter and Backspace keys to move the caret between the title and the body.

Installation

Copy link

After installing the editor, add the feature to your plugin list and toolbar configuration:

import { ClassicEditor, Title } from 'ckeditor5';

ClassicEditor
	.create( document.querySelector( '#editor' ), {
		licenseKey: '<YOUR_LICENSE_KEY>', // Or 'GPL'.
		plugins: [ Title, /* ... */ ]
		title: {
			// Configuration.
		}
	} )
	.then( /* ... */ )
	.catch( /* ... */ );
Copy code

Placeholder integration

Copy link

The title plugin is integrated with the placeholder configuration. If you define it, the placeholder text will be used for the body element.

To change the title placeholder, use the title.placeholder configuration option. For instance:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        // ... Other configuration options ...
        title: {
            placeholder: 'My custom placeholder for the title'
        },
        placeholder: 'My custom placeholder for the body'
    } )
    .then( /* ... */ )
    .catch( /* ... */ );
Copy code

HTML structure

Copy link

When you call editor.getData(), the document title will be represented as the following HTML:

<h1>Feasibility Study</h1>
Copy code

Model representation

Copy link

In the CKEditor 5 data model the document title is represented as follows:

<title>
    <title-content>
        Feasibility Study
    </title-content>
</title>
Copy code
Note

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.

Known issues

Copy link

The feature is not compatible with the pagination feature.

Copy link

CKEditor 5 has more features that can help you structure your document better:

  • Headings – Divide your content into sections.
  • Block indentation – Organize your content into visually separated blocks, indent crucial paragraphs, etc.
  • Editor placeholder – Set placeholder text to display when the content is empty. It helps users locate the editor in the application and prompts to input the content.

Contribute

Copy link

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