@ckeditor/ckeditor5-heading

What is @ckeditor/ckeditor5-heading?

@ckeditor/ckeditor5-heading is a plugin for CKEditor 5 that provides heading functionality. It allows users to format text as headings of various levels, which is essential for structuring content in a meaningful way.

What are @ckeditor/ckeditor5-heading's main functionalities?

Basic Heading

This code initializes a CKEditor instance with the Heading plugin enabled. The toolbar includes a heading button that allows users to apply different heading levels to their text.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Heading ], toolbar: [ 'heading' ] })

Custom Heading Options

This code initializes a CKEditor instance with custom heading options. Users can choose from Paragraph, Heading 1, and Heading 2, each with its own styling.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Heading ], toolbar: [ 'heading' ], heading: { options: [ { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' }, { model: 'heading1', view: 'h1', title: 'Heading 1', class: 'ck-heading_heading1' }, { model: 'heading2', view: 'h2', title: 'Heading 2', class: 'ck-heading_heading2' } ] } })

Advanced Heading Configuration

This code demonstrates an advanced configuration where additional heading levels (e.g., Heading 3) are added to the editor. This allows for more granular content structuring.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Heading ], toolbar: [ 'heading' ], heading: { options: [ { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' }, { model: 'heading1', view: 'h1', title: 'Heading 1', class: 'ck-heading_heading1' }, { model: 'heading2', view: 'h2', title: 'Heading 2', class: 'ck-heading_heading2' }, { model: 'heading3', view: 'h3', title: 'Heading 3', class: 'ck-heading_heading3' } ] } })

Other packages similar to @ckeditor/ckeditor5-heading

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides similar heading functionalities through its built-in formats and can be customized with modules. Compared to @ckeditor/ckeditor5-heading, Quill offers a more lightweight and flexible approach but may require more configuration for advanced use cases.

tinymce

TinyMCE is a popular rich text editor that offers comprehensive heading options out of the box. It is highly customizable and supports a wide range of plugins. Compared to @ckeditor/ckeditor5-heading, TinyMCE provides a more extensive set of features but can be more complex to integrate and configure.

draft-js

Draft.js is a JavaScript rich text editor framework maintained by Facebook. It allows for extensive customization and control over content editing, including heading functionalities. Unlike @ckeditor/ckeditor5-heading, Draft.js is more of a framework than a ready-to-use editor, requiring more development effort to achieve similar results.

README

CKEditor 5 headings feature

This package implements the headings feature for CKEditor 5.

Demo

Check out the demo in the heading feature guide.

Documentation

See the @ckeditor/ckeditor5-heading package page in CKEditor 5 documentation.

Installation

npm install ckeditor5

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.

Changelog

43.1.0 (September 5, 2024)

We are happy to announce the release of CKEditor 5 v43.1.0.

Release highlights

This release includes important bug fixes and enhancements for the editor:

• Block merge fields: In contrast to regular, inline merge fields, the block merge fields are designed to represent complex, block-level structures, such as a dynamically generated table, a row of products, or a personalized call-to-action segment. Block merge fields are supposed to be replaced by arbitrary HTML data when the document template is post-processed or exported to a PDF or Word file.

• Nested dropdown menus: this release introduces a new UI component: nested dropdown menus. They can be used by feature developers to easily provide an advanced user interface where UI elements are organized into a nested menu structure.

• Customizable accessible label: You can now configure the label for the accessible editable area through the editor settings, ensuring it fits your system’s needs.

• Improved table and cell border controls: It is now easier to manage both table and cell borders. The table user interface now clearly indicates the default border settings, allowing you to set “no borders” (None) for tables and cells without any additional configuration.

  ⚠️ In some cases this update may lead to data changes in the tables’ HTML markup when the editor loads them. However, visually nothing will change, and the experience will be the same.

The full list of enhancements can be found below.