@ckeditor/ckeditor5-autoformat

What is @ckeditor/ckeditor5-autoformat?

@ckeditor/ckeditor5-autoformat is a plugin for CKEditor 5 that allows for automatic formatting of text as you type. It provides a user-friendly way to apply formatting like bold, italic, and headings without needing to use toolbar buttons or keyboard shortcuts.

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

Bold Formatting

Automatically formats text to bold when surrounded by double asterisks (**bold**).

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Autoformat, Bold, Essentials, Paragraph ], toolbar: [ 'bold' ] });

Italic Formatting

Automatically formats text to italic when surrounded by single asterisks (*italic*).

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Autoformat, Italic, Essentials, Paragraph ], toolbar: [ 'italic' ] });

Heading Formatting

Automatically formats text to headings when prefixed with hash symbols (## Heading).

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

Other packages similar to @ckeditor/ckeditor5-autoformat

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It offers similar autoformatting features through its modules and can be customized to provide automatic text formatting.

tinymce

TinyMCE is a popular rich text editor that provides a wide range of formatting options, including autoformatting through plugins. It is highly customizable and can be extended to include features similar to @ckeditor/ckeditor5-autoformat.

draft-js

Draft.js is a JavaScript rich text editor framework, built for React. It allows for extensive customization and can be configured to support autoformatting features similar to those provided by @ckeditor/ckeditor5-autoformat.

README

CKEditor 5 autoformat feature

This package implements the autoformatting feature for CKEditor 5. It allows styling text by typing sequences like **bold this**.

Demo

Check out the demo in the autoformat feature guide.

Documentation

See the @ckeditor/ckeditor5-autoformat 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.