Skip to main content

@lexical/react/LexicalCharacterLimitPlugin

Functions

CharacterLimitPlugin()

CharacterLimitPlugin(__namedParameters): Element

Defined in: packages/lexical-react/src/LexicalCharacterLimitPlugin.tsx:65

Tracks the length of the editor's text content against maxLength and renders the number of remaining characters, marking any overflowing text so it can be styled. Length is measured in either 'UTF-8' or 'UTF-16' (default) code units via the charset prop, and the display can be customized with the renderer prop.

Parameters

__namedParameters
charset

"UTF-8" | "UTF-16" = 'UTF-16'

maxLength

number = CHARACTER_LIMIT

renderer?

(__namedParameters) => Element = DefaultRenderer

Returns

Element

The element produced by renderer (by default a <span> showing the number of remaining characters).