@lexical/react/LexicalListPlugin

Interfaces

ListPluginProps

Defined in: packages/lexical-react/src/LexicalListPlugin.ts:24

Props for the ListPlugin component.

Properties

hasStrictIndent?

optional hasStrictIndent?: boolean

Defined in: packages/lexical-react/src/LexicalListPlugin.ts:29

When true, enforces strict indentation rules for list items, ensuring consistent structure. When false (default), indentation is more flexible.

shouldPreserveNumbering?

optional shouldPreserveNumbering?: boolean

Defined in: packages/lexical-react/src/LexicalListPlugin.ts:34

When true, splitting a numbered list will preserve the numbering continuity. When false (default), the new split list resets to 1.

Functions

ListPlugin()

ListPlugin(__namedParameters): null

Defined in: packages/lexical-react/src/LexicalListPlugin.ts:47

Enables ordered, unordered, and check list support, registering the commands and transforms that create and maintain ListNode and ListItemNode structures. The editor must have both nodes registered.

This is a legacy plugin. When building an editor with the extension API, configure ListExtension instead.

Parameters

__namedParameters

ListPluginProps

Returns

null

null, this plugin renders no DOM of its own.