@ckeditor/ckeditor5-theme-lark

What is @ckeditor/ckeditor5-theme-lark?

@ckeditor/ckeditor5-theme-lark is a theme package for CKEditor 5, providing a modern and clean design for the editor. It includes styles for the editor's UI components, ensuring a consistent look and feel across different platforms and devices.

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

Basic Theme Integration

This code demonstrates how to integrate the Lark theme into a CKEditor 5 instance. It imports the necessary editor and plugin modules, as well as the Lark theme CSS, and initializes the editor with a basic toolbar.

import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
import '@ckeditor/ckeditor5-theme-lark/theme/ckeditor.css';

ClassicEditor.create(document.querySelector('#editor'), {
    plugins: [ Essentials, Paragraph, Bold, Italic ],
    toolbar: [ 'bold', 'italic' ]
})
.then(editor => {
    console.log('Editor was initialized', editor);
})
.catch(error => {
    console.error(error.stack);
});

Customizing Theme Styles

This code sample shows how to customize the default styles provided by the Lark theme. It imports the Lark theme CSS and then adds custom styles to override the default appearance of the editor's editable area and toolbar.

import '@ckeditor/ckeditor5-theme-lark/theme/ckeditor.css';

const customStyles = `
.ck-editor__editable {
    background-color: #f0f0f0;
    border: 1px solid #ccc;
    padding: 10px;
}

.ck-toolbar {
    background-color: #333;
    color: #fff;
}
`;

const styleSheet = document.createElement('style');
styleSheet.type = 'text/css';
styleSheet.innerText = customStyles;
document.head.appendChild(styleSheet);

Other packages similar to @ckeditor/ckeditor5-theme-lark

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It offers a different set of themes and customization options compared to CKEditor 5's Lark theme. Quill's themes are less integrated with the editor's core functionality, making it more flexible but potentially requiring more effort to achieve a cohesive design.

tinymce

TinyMCE is another popular WYSIWYG editor that provides various themes and skins. It offers a wide range of customization options and plugins, similar to CKEditor 5. However, TinyMCE's themes are more modular, allowing for greater flexibility in design but potentially requiring more configuration.

README

CKEditor 5 lark theme

This package implements lark theme – the default CKEditor 5 theme.

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.

Documentation

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