@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**.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Demo

Check out the demo in the autoformat feature guide.

Documentation

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

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.

Changelog

44.0.0 (December 2, 2024)

Release Highlights

We are excited to introduce CKEditor 5 v44.0.0, a release packed with high impact updates designed to enhance your editing experience and simplify access to our premium offers. Here's what’s new:

🚀 Self-service plans: Simplified access to premium features

We are introducing flexible self-service plans that put you in control with full transparency. Now, you can:

• Choose the plan that fits your needs, pay only for what you use, and get started instantly with a commitment-free trial.
• Seamlessly manage your license keys, track usage, and more in the new Customer Portal.

💡 Important for current users:

If you are upgrading to v44.0.0+, ensure a smooth transition by updating your license keys in the editor, as we implemented a new format of the key. To get the new key, visit the Customer Portal. You can also refer to our license key and activation guide for help with logging in to the portal.

📣 The open-source licensing remains unchanged. However, config.licenseKey is now a required property in the editor configuration. Use 'GPL' for installations under the GPL terms. Read more in the update guide.

🔖 Bookmarks: Organize your content with ease

Say hello to Bookmarks, a long-awaited feature that simplifies content navigation within the editor. With this release, you can:

• Add anchors as reference points within text.
• Link to the newly created bookmarks in the editor to navigate to specific locations within complex documents, such as contracts or technical manuals.

📍 Future updates to Bookmarks and the linking experience are planned for the upcoming releases. Follow progress and share your feedback on GitHub.

⚡ Performance improvements: Faster table rendering

The current release includes another stride towards improving the performance aspect of the editor, this time focusing on how tables are handled in the content. Implemented optimizations have made table rendering 3x faster, with the average load time of a document with a very long, complex tables dropping from around 4.5 seconds to just 1.5 seconds.