Skip to content
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

Node-aware Context Menu Items #5791

Merged
merged 3 commits into from
Apr 1, 2024
Merged

Node-aware Context Menu Items #5791

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73704ae
Node-aware Context Menu Items
ivailop7 Mar 31, 2024
1dc40d0
Node-aware Context Menu Items
ivailop7 Mar 31, 2024
52c31be
PR Comments
ivailop7 Apr 1, 2024
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
28 changes: 27 additions & 1 deletion packages/lexical-playground/src/plugins/ContextMenuPlugin/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
*
*/

import {$isLinkNode, TOGGLE_LINK_COMMAND} from '@lexical/link';
import {useLexicalComposerContext} from '@lexical/react/LexicalComposerContext';
import {
LexicalContextMenuPlugin,
MenuOption,
} from '@lexical/react/LexicalContextMenuPlugin';
import {
type LexicalNode,
$getNearestNodeFromDOMNode,
$getSelection,
$isRangeSelection,
COPY_COMMAND,
Expand Down Expand Up @@ -103,7 +105,7 @@ export class ContextMenuOption extends MenuOption {
export default function ContextMenuPlugin(): JSX.Element {
const [editor] = useLexicalComposerContext();

const options = useMemo(() => {
const defaultOptions = useMemo(() => {
return [
new ContextMenuOption(`Copy`, {
onSelect: (_node) => {
Expand Down Expand Up @@ -185,6 +187,8 @@ export default function ContextMenuPlugin(): JSX.Element {
];
}, [editor]);

const [options, setOptions] = React.useState(defaultOptions);

const onSelectOption = useCallback(
(
selectedOption: ContextMenuOption,
Expand All @@ -199,10 +203,32 @@ export default function ContextMenuPlugin(): JSX.Element {
[editor],
);

const onWillOpen = (event: MouseEvent) => {
let newOptions = defaultOptions;
editor.update(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

This should probably be a read that returns the node type, then call an update onClick

Copy link
Collaborator Author

@ivailop7 ivailop7 Apr 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

$getNearestNodeFromDOMNode works only inside editor.update(), unsure on why this is the case.

const node = $getNearestNodeFromDOMNode(event.target as Element);
if (node) {
const parent = node.getParent();
if ($isLinkNode(parent)) {
newOptions = [
new ContextMenuOption(`Remove Link`, {
onSelect: (_node) => {
editor.dispatchCommand(TOGGLE_LINK_COMMAND, null);
},
}),
...defaultOptions,
];
}
}
});
setOptions(newOptions);
};

return (
<LexicalContextMenuPlugin
options={options}
onSelectOption={onSelectOption}
onWillOpen={onWillOpen}
menuRenderFn={(
anchorElementRef,
{
Expand Down
7 changes: 6 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 @@ -47,6 +47,7 @@ export type LexicalContextMenuPluginProps<TOption extends MenuOption> = {
) => void;
options: Array<TOption>;
onClose?: () => void;
onWillOpen?: (event: MouseEvent) => void;
onOpen?: (resolution: MenuResolution) => void;
menuRenderFn: ContextMenuRenderFn<TOption>;
anchorClassName?: string;
Expand All @@ -58,6 +59,7 @@ const PRE_PORTAL_DIV_SIZE = 1;

export function LexicalContextMenuPlugin<TOption extends MenuOption>({
options,
onWillOpen,
onClose,
onOpen,
onSelectOption,
Expand Down Expand Up @@ -97,6 +99,9 @@ export function LexicalContextMenuPlugin<TOption extends MenuOption>({
const handleContextMenu = useCallback(
(event: MouseEvent) => {
event.preventDefault();
if (onWillOpen) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we be strict with the check here, like for onOpen and onClose?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated

onWillOpen(event);
}
const zoom = calculateZoomLevel(event.target as Element);
openNodeMenu({
getRect: () =>
Expand All @@ -108,7 +113,7 @@ export function LexicalContextMenuPlugin<TOption extends MenuOption>({
),
});
},
[openNodeMenu],
[openNodeMenu, onWillOpen],
);

const handleClick = useCallback(
Expand Down
4 changes: 1 addition & 3 deletions packages/lexical-react/src/shared/LexicalMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,9 +494,7 @@ export function useMenuAnchorRef(
if (rootElement !== null && resolution !== null) {
const {left, top, width, height} = resolution.getRect();
const anchorHeight = anchorElementRef.current.offsetHeight; // use to position under anchor
containerDiv.style.top = `${
top + window.pageYOffset + anchorHeight + 3
}px`;
containerDiv.style.top = `${top + anchorHeight + 3}px`;
containerDiv.style.left = `${left + window.pageXOffset}px`;
containerDiv.style.height = `${height}px`;
containerDiv.style.width = `${width}px`;
Expand Down
Loading