import type { RuntimeContext } from '../../runtime/types'; import type { Element } from '../../types'; import type { IElementEvent } from '../../types/event'; import type { BasePluginOptions } from '../base-plugin'; import { BasePlugin } from '../base-plugin'; import { createPluginContainer, insertDOM } from '../utils/dom'; import type { Item } from './util'; import { CONTEXTMENU_CSS, getContentFromItems } from './util'; /** * 上下文菜单配置项 * * Contextmenu options */ export interface ContextmenuOptions extends BasePluginOptions { /** * 给菜单的 DOM 追加的类名 * * The class name appended to the menu DOM for custom styles * @defaultValue 'g6-contextmenu' */ className?: string; /** * 如何触发右键菜单 * - `'click'` : 点击触发 * - `'contextmenu'` : 右键触发 * * How to trigger the context menu * - `'click'` : Click trigger * - `'contextmenu'` : Right-click trigger * @defaultValue 'contextmenu' */ trigger?: 'click' | 'contextmenu'; /** * 菜单显式 X、Y 方向的偏移量 * * The offset X, y direction of the menu * @defaultValue [4, 4] */ offset?: [number, number]; /** * 当菜单被点击后,触发的回调方法 * * The callback method triggered when the menu is clicked */ onClick?: (value: string, target: HTMLElement, current: Element) => void; /** * 返回菜单的项目列表,支持 `Promise` 类型的返回值。是 `getContent` 的快捷配置 * * Return the list of menu items, support the `Promise` type return value. It is a shortcut configuration of `getContent` */ getItems?: (event: IElementEvent) => Item[] | Promise; /** * 返回菜单的内容,支持 `Promise` 类型的返回值,也可以使用 `getItems` 进行快捷配置 * * Return the content of menu, support the `Promise` type return value, you can also use `getItems` for shortcut configuration */ getContent?: (event: IElementEvent) => HTMLElement | string | Promise; /** * 当 `getContent` 返回一个 `Promise` 时,使用的菜单内容 * * The menu content when loading is used when getContent returns a Promise */ loadingContent?: HTMLElement | string; /** * 是否可用,通过参数判断是否支持右键菜单,默认是全部可用 * * Whether the plugin is available, determine whether the right-click menu is supported through parameters, The default is all available * @defaultValue true */ enable?: boolean | ((event: IElementEvent) => boolean); } /** * 上下文菜单 * * Contextmenu * @remarks * 上下文菜单,也被称为右键菜单,是当用户在某个特定区域上点击后出现的一个菜单。支持在点击前后,触发自定义事件。 * * Contextmenu, also known as the right-click menu , is a menu that appears when a user clicks on a specific area. Supports triggering custom events before and after clicking. */ export class Contextmenu extends BasePlugin { static defaultOptions: Partial = { trigger: 'contextmenu', offset: [4, 4], loadingContent: '
Loading...
', getContent: () => 'It is a empty context menu.', enable: () => true, }; private $element!: HTMLElement; private targetElement: Element | null = null; private wheelHandler = (e: WheelEvent) => { e.stopPropagation(); }; constructor(context: RuntimeContext, options: ContextmenuOptions) { super(context, Object.assign({}, Contextmenu.defaultOptions, options)); this.initElement(); this.update(options); } private initElement() { this.$element = createPluginContainer('contextmenu', false, { zIndex: '99' }); const { className } = this.options; if (className) this.$element.classList.add(className); // 阻止滚轮事件冒泡,防止触发画布的 zoom-canvas 拦截逻辑 this.$element.addEventListener('wheel', this.wheelHandler); const $container = this.context.canvas.getContainer(); $container!.appendChild(this.$element); insertDOM('g6-contextmenu-css', 'style', {}, CONTEXTMENU_CSS, document.head); } /** * 显示上下文菜单 * * Show the contextmenu * @param event - 元素指针事件 | Element pointer event * @internal */ public async show(event: IElementEvent) { const { enable, offset } = this.options; if ((typeof enable === 'function' && !enable(event)) || !enable) { this.hide(); return; } const content = await this.getDOMContent(event); if (content instanceof HTMLElement) { this.$element.innerHTML = ''; this.$element.appendChild(content); } else { this.$element.innerHTML = content; } // NOTICE: 为什么事件中的 client 是相对浏览器,而不是画布容器? const $container = this.context.graph.getCanvas().getContainer()!; const clientRect = $container.getBoundingClientRect(); let left = event.client.x - clientRect.left + offset[0]; let top = event.client.y - clientRect.top + offset[1]; this.$element.style.display = 'block'; // 限制菜单位于画布容器范围内 const menuWidth = this.$element.offsetWidth; const menuHeight = this.$element.offsetHeight; const containerWidth = clientRect.width; const containerHeight = clientRect.height; const padding = 4; left = Math.max(padding, Math.min(left, containerWidth - menuWidth - padding)); top = Math.max(padding, Math.min(top, containerHeight - menuHeight - padding)); this.$element.style.left = `${left}px`; this.$element.style.top = `${top}px`; this.targetElement = event.target; } /** * 隐藏上下文菜单 * * Hide the contextmenu */ public hide() { this.$element.style.display = 'none'; this.targetElement = null; } /** * 更新上下文菜单的配置项 * * Update the contextmenu options * @param options - 配置项 | Options * @internal */ public update(options: Partial) { this.unbindEvents(); super.update(options); this.bindEvents(); } /** * 销毁上下文菜单 * * Destroy the contextmenu * @internal */ public destroy(): void { this.unbindEvents(); super.destroy(); this.$element.remove(); } private async getDOMContent(event: IElementEvent) { const { getContent, getItems } = this.options; if (getItems) { return getContentFromItems(await getItems(event)); } return await getContent(event); } private bindEvents() { const { graph } = this.context; const { trigger } = this.options; graph.on(`canvas:${trigger}`, this.onTriggerEvent); graph.on(`node:${trigger}`, this.onTriggerEvent); graph.on(`edge:${trigger}`, this.onTriggerEvent); graph.on(`combo:${trigger}`, this.onTriggerEvent); document.addEventListener('click', this.onMenuItemClick); } private unbindEvents() { const { graph } = this.context; const { trigger } = this.options; graph.off(`canvas:${trigger}`, this.onTriggerEvent); graph.off(`node:${trigger}`, this.onTriggerEvent); graph.off(`edge:${trigger}`, this.onTriggerEvent); graph.off(`combo:${trigger}`, this.onTriggerEvent); document.removeEventListener('click', this.onMenuItemClick); this.$element.removeEventListener('wheel', this.wheelHandler); } private onTriggerEvent = (event: IElementEvent) => { // `contextmenu` 事件默认会触发浏览器的右键菜单,需要阻止默认事件 // `click` 事件不需要阻止默认事件 event.preventDefault?.(); this.show(event); }; private onMenuItemClick = (event: MouseEvent) => { const { onClick, trigger } = this.options; if (event.target instanceof HTMLElement) { if (event.target.className.includes('g6-contextmenu-li')) { const value = event.target.getAttribute('value') as string; onClick?.(value, event.target, this.targetElement!); this.hide(); } } if (trigger !== 'click') this.hide(); }; }