Breaking Changes

LexicalNestedComposer manipulates internal data structures of the LexicalEditor in ways that are unsafe and lead to incorrect behavior.

The initialNodes prop is deprecated and will be removed in v0.32.0. The functionality it had can be achieved by configuring the nodes array of the editor correctly when it is created.

Similarly, the forced inheritance of namespace is incorrect whenever the nodes configuration differs at all from the parent. It is always safer and more correct to explicitly specify a namespace.

Before

<LexicalNestedComposer initialEditor={caption} initialNodes={[/* … */]}>
  {/* … */}
</LexicalNestedComposer>

class ImageNode extends DecoratorNode<JSX.Element> {
  constructor(/* … */) {
      // …
      this.__caption = caption || createEditor();
  }
}

After

<LexicalNestedComposer initialEditor={caption}>
  {/* … */}
</LexicalNestedComposer>

class ImageNode extends DecoratorNode<JSX.Element> {
  constructor(/* … */) {
      // …
      this.__caption = caption || createEditor({
        namespace: 'Playground/ImageNodeCaption',
        nodes: [/* … */],
      });
  }
}

New APIs

There's a new skipEditableListener property of LexicalNestedComposerProps that allows you to manually control the editable state of the nested editor. Previously the editable state of the nested editors was always forced to follow the parent editor's editable state.

Description

initialNodes doesn't work correctly, never really has, and should be deprecated. This deprecates that feature, provides a warning in __DEV__ with planned removal for v0.32.0.

Additionally other misfeatures of LexicalNestedComposer have been cleaned up allowing for more explicit control over the nested editor's configuration (namespace, editable state).

Internally this was implemented by storing the arguments used to create the editor so that it can be determined whether a value was set explicitly or implicitly (e.g. the automatically created namespace). This will also be useful as an internal implementation detail for other features.

Test plan

Unit tests for skipEditableListener and the warnings (with a warnOnlyOnce mock that always warns)