@ckeditor/ckeditor5-ui
Advanced tools
The UI framework and standard UI library of CKEditor 5.
@ckeditor/ckeditor5-ui is a package that provides a set of UI components and utilities for building rich text editors using CKEditor 5. It includes various UI elements like buttons, dropdowns, toolbars, and more, which can be customized and extended to create a tailored editing experience.
Button
This code demonstrates how to create a simple button using the ButtonView class from @ckeditor/ckeditor5-ui. The button is labeled 'Click me' and is appended to the document body.
const ButtonView = require('@ckeditor/ckeditor5-ui').ButtonView;
const button = new ButtonView();
button.set({
label: 'Click me',
withText: true
});
button.render();
document.body.appendChild(button.element);Toolbar
This code shows how to create a toolbar and add a button to it using the ToolbarView class from @ckeditor/ckeditor5-ui. The toolbar is then rendered and appended to the document body.
const ToolbarView = require('@ckeditor/ckeditor5-ui').ToolbarView;
const toolbar = new ToolbarView();
toolbar.items.add(button); // Assuming 'button' is a ButtonView instance
toolbar.render();
document.body.appendChild(toolbar.element);Dropdown
This code demonstrates how to create a dropdown menu using the DropdownView class from @ckeditor/ckeditor5-ui. The dropdown button is labeled 'Options' and is appended to the document body.
const DropdownView = require('@ckeditor/ckeditor5-ui').DropdownView;
const dropdown = new DropdownView();
dropdown.buttonView.set({
label: 'Options',
withText: true
});
dropdown.render();
document.body.appendChild(dropdown.element);Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides a rich API for creating and customizing the editor's UI components, similar to @ckeditor/ckeditor5-ui. However, Quill is a complete editor solution, whereas @ckeditor/ckeditor5-ui focuses on UI components for CKEditor 5.
Slate is a completely customizable framework for building rich text editors. It offers a more flexible approach to creating and managing UI components compared to @ckeditor/ckeditor5-ui, allowing developers to build their own UI from scratch or use third-party components.
Draft.js is a JavaScript rich text editor framework maintained by Facebook. It provides a set of React components and utilities for building rich text editors. While it offers similar functionalities to @ckeditor/ckeditor5-ui, it is more tightly integrated with React, making it a good choice for React-based projects.
This package implements a simple UI framework and CKEditor 5's standard UI library.
Check out the editor toolbar demo and block toolbar demo in CKEditor 5 documentation.
See the @ckeditor/ckeditor5-ui package page in CKEditor 5 documentation.
npm install ckeditor5
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.
43.3.1 (November 6, 2024)
We are happy to announce the release of CKEditor 5 v43.3.1.
We had to revert a change introduced in v43.3.0 related to the icons export in one of our packages. This was due to unforeseen TypeScript issues in some setups.
Token class is now exported as a value instead of a type only. (commit)Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Other releases:
FAQs
The UI framework and standard UI library of CKEditor 5.
The npm package @ckeditor/ckeditor5-ui receives a total of 656,435 weekly downloads. As such, @ckeditor/ckeditor5-ui popularity was classified as popular.
We found that @ckeditor/ckeditor5-ui demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.