Styles

The style feature lets you apply pre-configured styles to elements in your content. It works by adding one or more CSS classes to an element to change its appearance or add semantic information.

# Demo

Use the demo below to test the styles feature. Select a passage or a header and try applying various styles.

<h3 class="category">
		Opinions
	</h3>
	<h2 class="document-title">
		What we have gained from isolation
	</h2>
	<h3 class="document-subtitle">
		How work-from-home has changed the face of collaboration?
	</h3>
	<hr>
	<blockquote class="side-quote">
		<p>Collaboration is essential in today’s world with so many people working remotely.</p>
		<p>CKEditor Team</p>
	</blockquote>
	<p>
		Nowadays, <a href="https://ckeditor.com/blog/Collaborative-writing-and-how-to-implement-it-in-your-application/">writing is often a team sport</a>. The <a href="https://ckeditor.com/blog/content-publishing-during-covid-19/">worldwide pandemic</a> has completely changed the way we cooperate. It has also brought the very idea of cooperation and the demands for collaborative writing tools to a whole new level. Conference tables and whiteboards have been replaced by functions such as <a href="https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html">track changes</a> and <a href="https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments.html">comments</a> offering a perfect collaboration communication platform for writing and editing as a team. You can also easily track the progress of your work and changes to your content with the <a href="https://ckeditor.com/docs/ckeditor5/latest/features/revision-history/revision-history.html">revision history</a> feature.
	</p>
	<p class="info-box">
		<span>CKEditor 5 is an ultra-modern JavaScript rich-text editor with MVC architecture, a custom data model, and virtual DOM. It is written from scratch in JavaScript/TypeScript and has excellent webpack support. It provides every type of WYSIWYG editing solution imaginable with extensive collaboration support. </span>
	</p>
	<hr>
	<h4>
		Choose the best way to start
	</h4>
	<p>
		CKEditor 5 is a powerful tool that can be <span class="marker">tailored</span> to <a href="https://ckeditor.com/docs/ckeditor5/latest/examples/index.html">all kinds of needs and solutions</a>. There are several ways to integrate the software with your system. From the easy ones, like simply downloading a <span class="spoiler">ready-to-go</span> zip from the online builder, through predefined builds, up to advanced framework integrations and DLL solutions.
	</p>
	<p>
		Start the configuration by creating the editor:
	</p>
	<pre class="fancy-code fancy-code-bright"><code class="language-javascript">ClassicEditor.create( document.querySelector( '#editor' ) )
	.then( editor => {
		window.editor = editor;
	} );</code></pre>
	<p>
		Then enable some of the <a href="https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/collaboration.html">collaboration features</a>:
	</p>
	<pre class="fancy-code fancy-code-dark"><code class="language-javascript">ClassicEditor.create( document.querySelector( '#editor' ), {
		toolbar: [ ..., 'comment', 'trackChanges' ],
		cloudServices: {
			tokenUrl: '...',
			uploadUrl: '...',
			webSocketUrl: '...'
		}
	} )
	.then( editor => {
		window.editor = editor;
	} );</code></pre>

This demo only presents a limited set of features. Visit the feature-rich editor example to see more in action.

Configuration of the above demo

See the Configuration section to learn more about the configuration format.

The editor configuration:

// ...
style: {
    definitions: [
        {
            name: 'Article category',
            element: 'h3',
            classes: [ 'category' ]
        },
        {
            name: 'Title',
            element: 'h2',
            classes: [ 'document-title' ]
        },
        {
            name: 'Subtitle',
            element: 'h3',
            classes: [ 'document-subtitle' ]
        },
        {
            name: 'Info box',
            element: 'p',
            classes: [ 'info-box' ]
        },
        {
            name: 'Side quote',
            element: 'blockquote',
            classes: [ 'side-quote' ]
        },
        {
            name: 'Marker',
            element: 'span',
            classes: [ 'marker' ]
        },
        {
            name: 'Spoiler',
            element: 'span',
            classes: [ 'spoiler' ]
        },
        {
            name: 'Code (dark)',
            element: 'pre',
            classes: [ 'fancy-code', 'fancy-code-dark' ]
        },
        {
            name: 'Code (bright)',
            element: 'pre',
            classes: [ 'fancy-code', 'fancy-code-bright' ]
        }
    ]
},
// ...

The stylesheet:

@import url('https://fonts.googleapis.com/css2?family=Bebas+Neue&family=PT+Serif:ital,wght@0,400;0,700;1,400&display=swap');

.ck.ck-content {
    font-family: 'PT Serif', serif;
    font-size: 16px;
    line-height: 1.6;
    padding: 2em;
}

.ck-content .ck-horizontal-line {
    margin-bottom: 1em;
}

.ck.ck-content hr {
    width: 100px;
    border-top: 1px solid #aaa;
    height: 1px;
    margin: 1em auto;
}

.ck.ck-content h3.category {
    font-family: 'Bebas Neue';
    font-size: 20px;
    font-weight: bold;
    color: #d1d1d1;
    letter-spacing: 10px;
    margin: 0;
    padding: 0;
}

.ck.ck-content h2.document-title {
    font-family: 'Bebas Neue';
    font-size: 50px;
    font-weight: bold;
    margin: 0;
    padding: 0;
    border: 0;
}

.ck.ck-content h3.document-subtitle {
    font-size: 20px;
    color: #e91e63;
    margin: 0 0 1em;
    font-weight: normal;
    padding: 0;
}

.ck.ck-content p.info-box {
    --background-size: 30px;
    --background-color: #e91e63;
    padding: 1.2em 2em;
    border: 1px solid var(--background-color);
    background: linear-gradient(135deg, var(--background-color) 0%, var(--background-color) var(--background-size), transparent var(--background-size)), linear-gradient(135deg, transparent calc(100% - var(--background-size)), var(--background-color) calc(100% - var(--background-size)), var(--background-color));
    border-radius: 10px;
    margin: 1.5em 2em;
    box-shadow: 5px 5px 0 #ffe6ef;
}

.ck.ck-content blockquote.side-quote {
    font-family: 'Bebas Neue';
    font-style: normal;
    float: right;
    width: 35%;
    position: relative;
    border: 0;
    overflow: visible;
    z-index: 1;
    margin-left: 1em;
}

.ck.ck-content blockquote.side-quote::before {
    content: "“";
    position: absolute;
    top: -37px;
    left: -10px;
    display: block;
    font-size: 200px;
    color: #e7e7e7;
    z-index: -1;
    line-height: 1;
}

.ck.ck-content blockquote.side-quote p {
    font-size: 2em;
    line-height: 1;
}

.ck.ck-content blockquote.side-quote p:last-child:not(:first-child) {
    font-size: 1.3em;
    text-align: right;
    color: #555;
}

.ck.ck-content span.marker {
    background: yellow;
}

.ck.ck-content span.spoiler {
    background: #000;
    color: #000;
}

.ck.ck-content span.spoiler:hover {
    background: #000;
    color: #fff;
}

.ck.ck-content pre.fancy-code {
    border: 0;
    margin-left: 2em;
    margin-right: 2em;
    border-radius: 10px;
}

.ck.ck-content pre.fancy-code::before {
    content: "";
    display: block;
    height: 13px;
    background: url(data:image/svg+xml;base64,PHN2ZyBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA1NCAxMyI+CiAgPGNpcmNsZSBjeD0iNi41IiBjeT0iNi41IiByPSI2LjUiIGZpbGw9IiNGMzZCNUMiLz4KICA8Y2lyY2xlIGN4PSIyNi41IiBjeT0iNi41IiByPSI2LjUiIGZpbGw9IiNGOUJFNEQiLz4KICA8Y2lyY2xlIGN4PSI0Ny41IiBjeT0iNi41IiByPSI2LjUiIGZpbGw9IiM1NkM0NTMiLz4KPC9zdmc+Cg==);
    margin-bottom: 8px;
    background-repeat: no-repeat;
}

.ck.ck-content pre.fancy-code-dark {
    background: #272822;
    color: #fff;
    box-shadow: 5px 5px 0 #0000001f;
}

.ck.ck-content pre.fancy-code-bright {
    background: #dddfe0;
    color: #000;
    box-shadow: 5px 5px 0 #b3b3b3;
}

# Installation

The style feature is not available in any of the predefined builds.

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

npm install --save @ckeditor/ckeditor5-style

Then add it to the editor configuration:

import { Style } from '@ckeditor/ckeditor5-style';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Style, /* ... */ ],
        toolbar: {
            items: [
                'style',
                // More toolbar items.
                // ...
            ],
        },
        style: {
            definitions: [
                // Styles definitions.
                // ...
            ]
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# Configuration

Configuring the styles feature takes two steps. First you need to define the styles in the configuration file, for example:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ Style, /* ... */ ],
        toolbar: {
            items: [
                'style',
                // More toolbar items.
                // ...
            ],
        },
        style: {
            definitions: [
                {
                    name: 'Article category',
                    element: 'h3',
                    classes: [ 'category' ]
                },
                {
                    name: 'Info box',
                    element: 'p',
                    classes: [ 'info-box' ]
                },
            ]
        }
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

Then, corresponding CSS styles need to be defined for the document:

.ck.ck-content h3.category {
    font-family: 'Bebas Neue';
    font-size: 20px;
    font-weight: bold;
    color: #d1d1d1;
    letter-spacing: 10px;
    margin: 0;
    padding: 0;
}

.ck.ck-content p.info-box {
    padding: 1.2em 2em;
    border: 1px solid #e91e63;
    border-left: 10px solid #e91e63;
    border-radius: 5px;
    margin: 1.5em;
}

Note that the editor will automatically distinguish text and block styles and group them in the dropdown.

# Known issues

At present, the style feature may clash with other features that bring in similar content (e.g. headings). Problems with overlapping styles applied to the same element may also occur.

Check out also these CKEditor 5 features to gain better control over your content style and format:

Basic text styles – Apply the most frequently used formatting such as bold, italic, underline, etc.
Font styles – Easily and efficiently control the font family, size, text or background color.
Headings – Divide your content into sections.
Format painter – Easily copy text formatting and apply it in a different place in the edited document.
Remove format – Easily clean basic text formatting.
General HTML support – Allows enabling additional HTML, such as <style> and <classes> attributes.

# Common API

The Style plugin registers:

The 'style' command implemented by StyleCommand.
The 'style' UI drop-down.

The command can be executed using the editor.execute() method:

// Applies the style to the selected content.
// Executing the command again will remove the style from the selected content.
editor.execute( 'style', 'Article category' );

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 at https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-style.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

Styles

# Demo

# Installation

# Configuration

# Known issues

# Related features

# Common API

# Contribute