Skip to main content

@lexical/react/LexicalMarkdownShortcutPlugin

Variables

DEFAULT_TRANSFORMERS

const DEFAULT_TRANSFORMERS: Transformer[]

Defined in: packages/lexical-react/src/LexicalMarkdownShortcutPlugin.tsx:47

The default set of Markdown Transformers used by MarkdownShortcutPlugin: the core @lexical/markdown TRANSFORMERS plus a transformer that turns ---, ***, or ___ into a horizontal rule.

Functions

MarkdownShortcutPlugin()

MarkdownShortcutPlugin(__namedParameters): null

Defined in: packages/lexical-react/src/LexicalMarkdownShortcutPlugin.tsx:57

Registers Markdown shortcuts so that typing Markdown syntax (for example # for a heading or - for a list item) is automatically converted into the corresponding nodes as you type. Pass transformers to customize which shortcuts are active; it defaults to DEFAULT_TRANSFORMERS.

Parameters

__namedParameters

Readonly<{ transformers?: Transformer[]; }>

Returns

null

null, this plugin renders no DOM of its own.