| description | keywords | label | order | title |
|---|---|---|---|---|
The Payload editor, based on Lexical, allows for great customization with unparalleled ease. |
lexical, rich text, editor, headless cms |
Overview |
10 |
Rich Text Editor |
This documentation is about our new editor, based on Lexical (Meta's rich text editor). The previous default editor was based on Slate and is still supported. You can read its documentation, or the optional migration guide to migrate from Slate to Lexical (recommended).
The editor is the most important property of the rich text field.
As a key part of Payload, we are proud to offer you the best editing experience you can imagine. With healthy defaults out of the box, but also with the flexibility to customize every detail: from the “/” menu and toolbars (whether inline or fixed) to inserting any component or subfield you can imagine.
To use the rich text editor, first you need to install it:
pnpm install @payloadcms/richtext-lexicalOnce you have it installed, you can pass it to your top-level Payload Config as follows:
import { buildConfig } from 'payload'
import { lexicalEditor } from '@payloadcms/richtext-lexical'
export default buildConfig({
collections: [
// your collections here
],
// Pass the Lexical editor to the root config
editor: lexicalEditor({}),
})You can also override Lexical settings on a field-by-field basis as follows:
import type { CollectionConfig } from 'payload'
import { lexicalEditor } from '@payloadcms/richtext-lexical'
export const Pages: CollectionConfig = {
slug: 'pages',
fields: [
{
name: 'content',
type: 'richText',
// Pass the Lexical editor here and override base settings as necessary
editor: lexicalEditor({}),
},
],
}Lexical has been designed with extensibility in mind. Whether you're aiming to introduce new functionalities or tweak the existing ones, Lexical makes it seamless for you to bring those changes to life.
At the heart of Lexical's customization potential are "features". While Lexical ships with a set of default features we believe are essential for most use cases, the true power lies in your ability to redefine, expand, or prune these as needed.
If you remove all the default features, you're left with a blank editor. You can then add in only the features you need, or you can build your own custom features from scratch.
To weave in your custom features, utilize the features prop when initializing the Lexical Editor. Here's a basic example of how this is done:
import {
BlocksFeature,
LinkFeature,
UploadFeature,
lexicalEditor,
} from '@payloadcms/richtext-lexical'
import { Banner } from '../blocks/Banner'
import { CallToAction } from '../blocks/CallToAction'
{
editor: lexicalEditor({
features: ({ defaultFeatures, rootFeatures }) => [
...defaultFeatures,
LinkFeature({
// Example showing how to customize the built-in fields
// of the Link feature
fields: ({ defaultFields }) => [
...defaultFields,
{
name: 'rel',
label: 'Rel Attribute',
type: 'select',
hasMany: true,
options: ['noopener', 'noreferrer', 'nofollow'],
admin: {
description:
'The rel attribute defines the relationship between a linked resource and the current document. This is a custom link field.',
},
},
],
}),
UploadFeature({
collections: {
uploads: {
// Example showing how to customize the built-in fields
// of the Upload feature
fields: [
{
name: 'caption',
type: 'richText',
editor: lexicalEditor(),
},
],
},
},
}),
// This is incredibly powerful. You can re-use your Payload blocks
// directly in the Lexical editor as follows:
BlocksFeature({
blocks: [Banner, CallToAction],
}),
],
})
}features can be both an array of features, or a function returning an array of features. The function provides the following props:
| Prop | Description |
|---|---|
defaultFeatures |
This opinionated array contains all "recommended" default features. You can see which features are included in the default features in the table below. |
rootFeatures |
This array contains all features that are enabled in the root richText editor (the one defined in the payload.config.ts). If this field is the root richText editor, or if the root richText editor is not a lexical editor, this array will be empty. |
Here's an overview of all the included features:
| Feature Name | Included by default | Description |
|---|---|---|
BoldTextFeature |
Yes | Handles the bold text format |
ItalicTextFeature |
Yes | Handles the italic text format |
UnderlineTextFeature |
Yes | Handles the underline text format |
StrikethroughTextFeature |
Yes | Handles the strikethrough text format |
SubscriptTextFeature |
Yes | Handles the subscript text format |
SuperscriptTextFeature |
Yes | Handles the superscript text format |
InlineCodeTextFeature |
Yes | Handles the inline-code text format |
ParagraphFeature |
Yes | Handles paragraphs. Since they are already a key feature of lexical itself, this Feature mainly handles the Slash and Add-Block menu entries for paragraphs |
HeadingFeature |
Yes | Adds Heading Nodes (by default, H1 - H6, but that can be customized) |
AlignFeature |
Yes | Allows you to align text left, centered and right |
IndentFeature |
Yes | Allows you to indent text with the tab key |
UnorderedListFeature |
Yes | Adds unordered lists (ul) |
OrderedListFeature |
Yes | Adds ordered lists (ol) |
CheckListFeature |
Yes | Adds checklists |
LinkFeature |
Yes | Allows you to create internal and external links |
RelationshipFeature |
Yes | Allows you to create block-level (not inline) relationships to other documents |
BlockQuoteFeature |
Yes | Allows you to create block-level quotes |
UploadFeature |
Yes | Allows you to create block-level upload nodes - this supports all kinds of uploads, not just images |
HorizontalRuleFeature |
Yes | Horizontal rules / separators. Basically displays an <hr> element |
InlineToolbarFeature |
Yes | The inline toolbar is the floating toolbar which appears when you select text. This toolbar only contains actions relevant for selected text |
FixedToolbarFeature |
No | This classic toolbar is pinned to the top and always visible. Both inline and fixed toolbars can be enabled at the same time. |
BlocksFeature |
No | Allows you to use Payload's Blocks Field directly inside your editor. In the feature props, you can specify the allowed blocks - just like in the Blocks field. |
TreeViewFeature |
No | Adds a debug box under the editor, which allows you to see the current editor state live, the dom, as well as time travel. Very useful for debugging |
EXPERIMENTAL_TableFeature |
No | Adds support for tables. This feature may be removed or receive breaking changes in the future - even within a stable lexical release, without needing a major release. |
Notice how even the toolbars are features? That's how extensible our lexical editor is - you could theoretically create your own toolbar if you wanted to!
You can find more information about creating your own feature in our building custom feature docs.
Every single piece of saved data is 100% fully typed within lexical. It provides a type for every single node, which can be imported from @payloadcms/richtext-lexical - each type is prefixed with Serialized, e.g., SerializedUploadNode.
To fully type the entire editor JSON, you can use our TypedEditorState helper type, which accepts a union of all possible node types as a generic. We don't provide a type that already contains all possible node types because they depend on which features you have enabled in your editor. Here is an example:
import type {
SerializedAutoLinkNode,
SerializedBlockNode,
SerializedHorizontalRuleNode,
SerializedLinkNode,
SerializedListItemNode,
SerializedListNode,
SerializedParagraphNode,
SerializedQuoteNode,
SerializedRelationshipNode,
SerializedTextNode,
SerializedUploadNode,
TypedEditorState,
SerializedHeadingNode,
} from '@payloadcms/richtext-lexical'
const editorState: TypedEditorState<
| SerializedAutoLinkNode
| SerializedBlockNode
| SerializedHorizontalRuleNode
| SerializedLinkNode
| SerializedListItemNode
| SerializedListNode
| SerializedParagraphNode
| SerializedQuoteNode
| SerializedRelationshipNode
| SerializedTextNode
| SerializedUploadNode
| SerializedHeadingNode
> = {
root: {
type: 'root',
direction: 'ltr',
format: '',
indent: 0,
version: 1,
children: [
{
children: [
{
detail: 0,
format: 0,
mode: 'normal',
style: '',
text: 'Some text. Every property here is fully-typed',
type: 'text',
version: 1,
},
],
direction: 'ltr',
format: '',
indent: 0,
type: 'paragraph',
textFormat: 0,
version: 1,
},
],
},
}Alternatively, you can use the DefaultTypedEditorState type, which includes all types for all nodes included in the defaultFeatures:
import type {
DefaultTypedEditorState
} from '@payloadcms/richtext-lexical'
const editorState: DefaultTypedEditorState = {
root: {
type: 'root',
direction: 'ltr',
format: '',
indent: 0,
version: 1,
children: [
{
children: [
{
detail: 0,
format: 0,
mode: 'normal',
style: '',
text: 'Some text. Every property here is fully-typed',
type: 'text',
version: 1,
},
],
direction: 'ltr',
format: '',
indent: 0,
type: 'paragraph',
textFormat: 0,
version: 1,
},
],
},
}Just like TypedEditorState, the DefaultTypedEditorState also accepts an optional node type union as a generic. Here, this would add the specified node types to the default ones. Example:
DefaultTypedEditorState<SerializedBlockNode | YourCustomSerializedNode>This is a type-safe representation of the editor state. If you look at the auto suggestions of a node's type property, you will see all the possible node types you can use.
Make sure to only use types exported from @payloadcms/richtext-lexical, not from the lexical core packages. We only have control over the types we export and can make sure they're correct, even though the lexical core may export types with identical names.
Lexical does not generate accurate type definitions for your richText fields for you yet - this will be improved in the future. Currently, it only outputs the rough shape of the editor JSON, which you can enhance using type assertions.
The Rich Text Field editor configuration has an admin property with the following options:
| Property | Description |
|---|---|
placeholder |
Set this property to define a placeholder string for the field. |
hideGutter |
Set this property to true to hide this field's gutter within the Admin Panel. |
hideInsertParagraphAtEnd |
Set this property to true to hide the "+" button that appears at the end of the editor |
You can disable the gutter (the vertical line padding between the editor and the left edge of the screen) by setting the hideGutter prop to true:
{
name: 'richText',
type: 'richText',
editor: lexicalEditor({
admin: {
hideGutter: true
},
}),
}You can customize the placeholder (the text that appears in the editor when it's empty) by setting the placeholder prop:
{
name: 'richText',
type: 'richText',
editor: lexicalEditor({
admin: {
placeholder: 'Type your content here...'
},
}),
}