Skip to main content

Interface: LexicalNestedComposerProps

@lexical/react/LexicalNestedComposer.LexicalNestedComposerProps

Properties

children

Optional children: ReactNode

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.

Defined in

packages/lexical-react/src/LexicalNestedComposer.tsx:45


initialEditor

initialEditor: LexicalEditor

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

Defined in

packages/lexical-react/src/LexicalNestedComposer.tsx:50


initialNodes

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

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()});

Defined in

packages/lexical-react/src/LexicalNestedComposer.tsx:67


initialTheme

Optional initialTheme: EditorThemeClasses

Optionally overwrite the theme of the initialEditor

Defined in

packages/lexical-react/src/LexicalNestedComposer.tsx:54


skipCollabChecks

Optional skipCollabChecks: true

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.

Defined in

packages/lexical-react/src/LexicalNestedComposer.tsx:72


skipEditableListener

Optional skipEditableListener: true

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

Defined in

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