@lexical/react/LexicalTableOfContentsPlugin
Type Aliases
TableOfContentsEntry
TableOfContentsEntry = [
NodeKey,string,HeadingTagType]
Defined in: packages/lexical-react/src/LexicalTableOfContentsPlugin.tsx:32
A single entry in the table of contents, as a tuple of the heading node's
NodeKey, its text content, and its heading tag (for example 'h1').
Functions
TableOfContentsPlugin()
TableOfContentsPlugin(
__namedParameters):Element
Defined in: packages/lexical-react/src/LexicalTableOfContentsPlugin.tsx:160
Tracks every HeadingNode in the editor and keeps an ordered list of
TableOfContentsEntrys in sync as headings are added, removed, edited,
or moved. It is a render-prop component: children receives the current
entries and the editor and returns the element used to render the table of
contents.
Parameters
__namedParameters
Props
Returns
Element
The element returned by the children render prop.