Skip to main content

Function: getPlanDependencyFromEditor()

getPlanDependencyFromEditor<Plan>(editor, plan): LexicalPlanDependency<Plan>

Get the finalized config and output of a Plan that was used to build the editor.

This is useful in the implementation of a LexicalNode or in other situations where you have an editor reference but it's not easy to pass the config or PlanRegisterState around.

It will throw if the Editor was not built using this Plan.

Type Parameters

Plan extends AnyLexicalPlan

Parameters

editor: LexicalEditor

The editor that was built using plan

plan: Plan

The concrete reference to a Plan used to build this editor

Returns

LexicalPlanDependency<Plan>

The config and output for that Plan

Defined in

lexical-builder/src/getPlanDependencyFromEditor.ts:22