@lexical/react/LexicalNestedComposer

Interfaces

LexicalNestedComposerProps

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:51

Properties

children?

optional children: ReactNode

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:59

Any children (e.g. plug-ins) for this editor. Note that the nested editor does not inherit any plug-ins or registrations from those plug-ins (such as transforms and command listeners that may be necessary for correct operation of those nodes) from the parent editor. If you are using nodes that require plug-ins they must also be instantiated here.

initialEditor

initialEditor: LexicalEditor

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:64

The nested editor, created outside of this component (typically in the implementation of a LexicalNode) with createEditor

initialNodes?

optional initialNodes: readonly (KlassConstructor<typeof LexicalNode> | LexicalNodeReplacement)[]

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:81

Deprecated

This feature is not safe or correctly implemented and will be removed in v0.32.0. The only correct time to configure the nodes is when creating the initialEditor.

Example

// This is normally in the implementation of a LexicalNode that
// owns the nested editor
editor = createEditor({nodes: [], parentEditor: $getEditor()});

initialTheme?

optional initialTheme: EditorThemeClasses

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:68

Optionally overwrite the theme of the initialEditor

skipCollabChecks?

optional skipCollabChecks: true

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:86

If this is not explicitly set to true, and the collab plugin is active, rendering the children of this component will not happen until collab is ready.

skipEditableListener?

optional skipEditableListener: true

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:95

If this is not explicitly set to true, the editable state of the nested editor will automatically follow the parent editor's editable state. When set to true, the nested editor is responsible for managing its own editable state.

Available since v0.29.0

Functions

LexicalNestedComposer()

LexicalNestedComposer(__namedParameters): Element

Defined in: packages/lexical-react/src/LexicalNestedComposer.tsx:105

Parameters

__namedParameters

LexicalNestedComposerProps

Returns

Element