[0.8] Allow the format property to be omitted

[Karibash]

The current behavior

The format property allows undefined, but cannot be omitted because it is not optional.

lexical/packages/lexical-react/src/LexicalBlockWithAlignableContents.tsx

Line 35 in 98bba10

format: ElementFormatType | null | undefined;

class LinkCardNode extends DecoratorNode<React.ReactElement> {
  public decorate(editor: LexicalEditor, config: EditorConfig): React.ReactElement {
    return (
      <BlockWithAlignableContents
        className={className}
        format={undefined} // undefined must be specified.
        nodeKey={this.getKey()}
      >
        text
      </BlockWithAlignableContents>
    );
  }
}

The expected behavior

Change the format property to optional so that it can be omitted.

type Props = Readonly<{
  format?: ElementFormatType | null;
}>;

class LinkCardNode extends DecoratorNode<React.ReactElement> {
  public decorate(editor: LexicalEditor, config: EditorConfig): React.ReactElement {
    return (
      <BlockWithAlignableContents
        className={className}
        nodeKey={this.getKey()}
      >
        text
      </BlockWithAlignableContents>
    );
  }
}

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
lexical	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 3, 2023 at 3:49AM (UTC)
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 3, 2023 at 3:49AM (UTC)

[thegreatercurve]

Thanks. This looks fine to me! We'll include it in a 0.8 release as it constitutes a break change.