Skip to content

[lexical-react] Annotate @deprecated to menuRenderFn with NodeContext… #8001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thatmichael85 wants to merge 5 commits into
base: main
Choose a base branch
from
+31 −1
Open

[lexical-react] Annotate @deprecated to menuRenderFn with NodeContext… #8001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c8faf7b
[lexical-react] Annotate @deprecate to menuRenderFn with NodeContext…
thatmichael85 Nov 21, 2025
09e2956
updated deprecated comments for packages/lexical-react/src/LexicalCon…
thatmichael85 Nov 21, 2025
3c65431
Update packages/lexical-react/src/LexicalContextMenuPlugin.tsx
thatmichael85 Nov 21, 2025
fe42bf8
Update packages/lexical-react/flow/LexicalTypeaheadMenuPlugin.js.flow
thatmichael85 Nov 21, 2025
6f8689b
Update packages/lexical-react/flow/LexicalAutoEmbedPlugin.js.flow
thatmichael85 Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/lexical-react/flow/LexicalAutoEmbedPlugin.js.flow
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ type LexicalAutoEmbedPluginProps<TEmbedConfig> = {
embedFn: () => void,
dismissFn: () => void,
) => Array<AutoEmbedOption>,
/**
* @deprecated Use NodeContextMenuPlugin instead. Here is an example for using NodeContextMenuPlugin:
Copy link
Collaborator

@ivailop7 ivailop7 Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct. NodeContextMenuPlugin is not a replacement for AutoEmbedPlugin

* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
menuRenderFn: MenuRenderFn<AutoEmbedOption>,
};

Expand Down
4 changes: 4 additions & 0 deletions packages/lexical-react/flow/LexicalNodeMenuPlugin.js.flow
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ type NodeMenuPluginProps<TOption> = {
nodeKey: NodeKey | null,
onClose?: () => void,
onOpen?: (resolution: MenuResolution) => void,
/**
* @deprecated Use NodeContextMenuPlugin instead. Here is an example for using NodeContextMenuPlugin:
Copy link
Collaborator

@ivailop7 ivailop7 Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also not correct. NodeContextMenuPlugin is a replacement only for ContextMenuPlugin, nothing else.

* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
menuRenderFn: MenuRenderFn<TOption>,
anchorClassName?: string,
};
Expand Down
4 changes: 4 additions & 0 deletions packages/lexical-react/flow/LexicalTypeaheadMenuPlugin.js.flow
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ export type TypeaheadMenuPluginProps<TOption> = {
matchingString: string,
) => void,
options: Array<TOption>,
/**
Copy link
Collaborator

@ivailop7 ivailop7 Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this one as well please.

* @deprecated Use NodeContextMenuPlugin instead. Here is an example for using NodeContextMenuPlugin:
* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
menuRenderFn: MenuRenderFn<TOption>,
triggerFn: TriggerFn,
onOpen?: (resolution: MenuResolution) => void,
Expand Down
4 changes: 4 additions & 0 deletions packages/lexical-react/src/LexicalAutoEmbedPlugin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ type LexicalAutoEmbedPluginProps<TEmbedConfig extends EmbedConfig> = {
embedFn: () => void,
dismissFn: () => void,
) => Array<AutoEmbedOption>;
/**
Copy link
Collaborator

@ivailop7 ivailop7 Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect as well.

* @deprecated Use NodeContextMenuPlugin instead. Here is an example for using NodeContextMenuPlugin:
* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
menuRenderFn: MenuRenderFn<AutoEmbedOption>;
menuCommandPriority?: CommandListenerPriority;
};
Expand Down
8 changes: 7 additions & 1 deletion packages/lexical-react/src/LexicalContextMenuPlugin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ export type LexicalContextMenuPluginProps<TOption extends MenuOption> = {
onClose?: () => void;
onWillOpen?: (event: MouseEvent) => void;
onOpen?: (resolution: MenuResolution) => void;
/**
* @deprecated Use LexicalNodeContextMenuPlugin instead. Here is an example for using NodeContextMenuPlugin:
* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
menuRenderFn: ContextMenuRenderFn<TOption>;
Copy link
Member

@zurfyx zurfyx Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides marking it as deprecated, is it possible to restore the new API that @ivailop7 introduced so that we only get to this as a workaround for surfaces that are time-consuming to migrate? I see there's still a few playground callsites that are using this property already.

anchorClassName?: string;
commandPriority?: CommandListenerPriority;
Expand All @@ -54,7 +58,9 @@ export type LexicalContextMenuPluginProps<TOption extends MenuOption> = {
const PRE_PORTAL_DIV_SIZE = 1;

/**
* @deprecated Use LexicalNodeContextMenuPlugin instead.
* @deprecated Use LexicalNodeContextMenuPlugin instead. It will be removed soon.
* Here is an example for using NodeContextMenuPlugin:
* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
export function LexicalContextMenuPlugin<TOption extends MenuOption>({
options,
Expand Down
4 changes: 4 additions & 0 deletions packages/lexical-react/src/LexicalNodeMenuPlugin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ export type NodeMenuPluginProps<TOption extends MenuOption> = {
nodeKey: NodeKey | null;
onClose?: () => void;
onOpen?: (resolution: MenuResolution) => void;
/**
Copy link
Collaborator

@ivailop7 ivailop7 Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not true

* @deprecated Use NodeContextMenuPlugin instead. Here is an example for using NodeContextMenuPlugin:
* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
menuRenderFn: MenuRenderFn<TOption>;
anchorClassName?: string;
commandPriority?: CommandListenerPriority;
Expand Down
4 changes: 4 additions & 0 deletions packages/lexical-react/src/LexicalTypeaheadMenuPlugin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,10 @@ export type TypeaheadMenuPluginProps<TOption extends MenuOption> = {
matchingString: string,
) => void;
options: Array<TOption>;
/**
Copy link
Collaborator

@ivailop7 ivailop7 Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this as well.

* @deprecated Use NodeContextMenuPlugin instead. Here is an example for using NodeContextMenuPlugin:
* https://github.com/facebook/lexical/blob/main/packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
*/
menuRenderFn: MenuRenderFn<TOption>;
triggerFn: TriggerFn;
onOpen?: (resolution: MenuResolution) => void;
Expand Down