Skip to main content

@lexical/react/LexicalTabIndentationPlugin

Functions​

TabIndentationPlugin()​

TabIndentationPlugin(__namedParameters): null

Defined in: packages/lexical-react/src/LexicalTabIndentationPlugin.tsx:26

This plugin adds the ability to indent content using the tab key. Generally, we don't recommend using this plugin as it could negatively affect accessibility for keyboard users, causing focus to become trapped within the editor.

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

Parameters​

__namedParameters​
$canIndent?​

CanIndentPredicate

By default, indents are set on all elements for which the ElementNode.canIndent returns true. This option allows you to set indents for specific nodes without overriding the method for others.

maxIndent?​

number

Returns​

null

References​

registerTabIndentation​

Re-exports registerTabIndentation