@lexical/utils

What is @lexical/utils?

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

What are @lexical/utils's main functionalities?

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);

Other packages similar to @lexical/utils

draft-js

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

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

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.

README

@lexical/utils

This package contains misc utilities for Lexical.

Changelog

0.10.0 (2023-04-18)

Breaking Changes

@lexical/link will now sanitize anchor tag hrefs before rendering them to the DOM. This provides a measure of protection against XSS attacks that rely on inlining javascript in that attribute. However, it means that links using less common protocols will now be sanitized (converted to about:blank), which will be a breaking change for any existing links.

Like most other node-based logic in Lexical, the sanitization logic can be overriden by overriding LinkNode using the Node Overrides API and replacing it with a node that implements the sanitizeUrl method differently.

Fixes CVE-2023-30792

• Table feature: background color (#4345) Gerard Rovira
• Add @react/LexicalClickableLinkPlugin (#4316) Gerard Rovira
• TablePlugin feature: cell merge (#4343) Gerard Rovira
• Ban javascript URLs in @lexical/link (#4342) Acy Watson
• Table Cell Background Color (#4306) Gerard Rovira
• ExportDOM in Debug Tree View (#4307) Ivaylo Pavlov