Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@lexical/utils
Advanced tools
@lexical/utils is a utility package for the Lexical framework, which is a modern, extensible text editor framework. This package provides various utility functions to facilitate the manipulation and management of Lexical nodes, editors, and other related components.
Node Manipulation
This feature allows you to create and manipulate nodes within the Lexical editor. In this example, a text node is created and appended to the root node.
const { $createTextNode, $getRoot } = require('@lexical/utils');
const root = $getRoot();
const textNode = $createTextNode('Hello, world!');
root.append(textNode);
Editor State Management
This feature provides functions to get and set the editor state, allowing for more controlled and dynamic updates to the editor's content.
const { $getEditorState, $setEditorState } = require('@lexical/utils');
const editorState = $getEditorState();
// Modify the editor state as needed
$setEditorState(editorState);
Event Handling
This feature allows you to add and remove event listeners to the Lexical editor, enabling custom event handling and interaction.
const { $addEventListener, $removeEventListener } = require('@lexical/utils');
const handleClick = (event) => {
console.log('Editor clicked!', event);
};
$addEventListener('click', handleClick);
// Later, if needed
$removeEventListener('click', handleClick);
Draft.js is a rich text editor framework for React. It provides a set of tools for building complex text editors with features like text formatting, media embedding, and more. Compared to @lexical/utils, Draft.js offers a more comprehensive set of features for building rich text editors but may be more complex to use.
Slate is another framework for building rich text editors in React. It is highly customizable and provides a lot of flexibility in terms of editor behavior and appearance. Slate is similar to @lexical/utils in that it offers utilities for managing editor state and nodes, but it is generally more flexible and powerful.
ProseMirror is a toolkit for building rich text editors with a focus on extensibility and performance. It provides a robust set of tools for manipulating document structures and handling complex editor interactions. ProseMirror is more feature-rich and versatile compared to @lexical/utils, but it also comes with a steeper learning curve.
@lexical/utils
This package contains misc utilities for Lexical.
v0.7.0 (2022-12-09)
Lexical 0.7 includes some breaking changes, including:
$cloneContents
from @lexical/selection
PlainTextPlugin
and RichTextPlugin
with regards to how placeholders are handledRichTextPlugin
no longer indents by default, use the LexicalTabIndentationPlugin
for this behavior.unstable_convertLegacyJSONEditorState
has been removed. This was always meant to be a temporary work-around to allow developers to convert their formats to the new JSON format rather than using the actual editor state internals directly.Lexical 0.7 includes performance and usability improvements. Notably, Lexical has a new internal architecture that allows for
much better performance with large documents of content. Lexical also now provides a way to handle selection between blocks
of content by providing an emulated cursor (make sure you add a blockCursor
theme to your editor config to use it).
FAQs
This package contains misc utilities for Lexical.
We found that @lexical/utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers 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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.