vxe-pc-ui 4.12.0 → 4.12.1

package/types/components/form-design.d.ts

@@ -1,6 +1,7 @@
 import { RenderFunction, SetupContext, Ref, ComputedRef } from 'vue'
 import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'
 import { VxeFormPropTypes } from '../components/form'
+import { VxeContextMenuPropTypes, VxeContextMenuDefines } from './context-menu'
 
 /* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
 
@@ -44,6 +45,24 @@ export namespace VxeFormDesignPropTypes {
   export interface FormRender {
     name?: string
   }
+  export interface MenuConfig<D = any> {
+    /**
+     * 是否启用
+     */
+    enabled?: boolean
+    /**
+     * 菜单配置
+     */
+    options: VxeContextMenuPropTypes.Options
+    /**
+     * 该函数的返回值用来决定是否允许显示右键菜单（对于需要对菜单进行权限控制时可能会用到）
+     */
+    visibleMethod?(params: {
+      $formDesign: VxeFormDesignConstructor
+      options: VxeContextMenuPropTypes.Options
+      widget: VxeFormDesignDefines.WidgetObjItem<D>
+    }): boolean
+  }
 }
 
 export interface VxeFormDesignProps {
@@ -56,6 +75,7 @@ export interface VxeFormDesignProps {
   showMobile?: VxeFormDesignPropTypes.ShowMobile
   formData?: VxeFormDesignPropTypes.FormData
   formRender?: VxeFormDesignPropTypes.FormRender
+  menuConfig?: VxeFormDesignPropTypes.MenuConfig
 }
 
 export interface FormDesignPrivateComputed {
@@ -140,6 +160,7 @@ export interface VxeFormDesignMethods extends FormDesignMethods { }
 
 export interface FormDesignPrivateMethods {
   validWidgetUnique(widgetName: string): boolean
+  handleContextmenuWidget (evnt: MouseEvent, item: VxeFormDesignDefines.WidgetObjItem): void
   handleClickWidget (evnt: Event, item: VxeFormDesignDefines.WidgetObjItem): void
   handleCopyWidget (evnt: Event, item: VxeFormDesignDefines.WidgetObjItem): void
   handleRemoveWidget (evnt: Event, item: VxeFormDesignDefines.WidgetObjItem): void
@@ -147,6 +168,14 @@ export interface FormDesignPrivateMethods {
 export interface VxeFormDesignPrivateMethods extends FormDesignPrivateMethods { }
 
 export type VxeFormDesignEmits = [
+  'widget-click',
+  'widget-add',
+  'widget-copy',
+  'widget-remove',
+  'widget-drag',
+  'widget-menu',
+  'menu-click',
+
   'click-widget',
   'add-widget',
   'copy-widget',
@@ -218,49 +247,105 @@ export namespace VxeFormDesignDefines {
     mobileTitleWidthUnit: null | '' | 'px' | '%'
   }
 
-  export interface ClickWidgetParams<D = any> {
+  export interface WidgetClickParams<D = any> {
     widget: VxeFormDesignDefines.WidgetObjItem<D>
   }
-  export interface ClickWidgetEventParams<D = any> extends FormDesignEventParams, ClickWidgetParams<D> { }
+  export interface WidgetClickEventParams<D = any> extends FormDesignEventParams, WidgetClickParams<D> { }
 
-  export interface AddWidgetEventParams<D = any> extends FormDesignEventParams {
+  export interface WidgetAddEventParams<D = any> extends FormDesignEventParams {
     newWidget: VxeFormDesignDefines.WidgetObjItem<D>
   }
-  export interface CopyWidgetEventParams<D = any> extends FormDesignEventParams {
+  export interface WidgetCopyEventParams<D = any> extends FormDesignEventParams {
     widget: VxeFormDesignDefines.WidgetObjItem<D>
     newWidget: VxeFormDesignDefines.WidgetObjItem<D>
   }
-  export interface RemoveWidgetEventParams<D = any> extends FormDesignEventParams {
+  export interface WidgetRemoveEventParams<D = any> extends FormDesignEventParams {
+    widget: VxeFormDesignDefines.WidgetObjItem<D>
+  }
+
+  export interface WidgetDragEventParams<D = any> extends FormDesignEventParams {
     widget: VxeFormDesignDefines.WidgetObjItem<D>
   }
 
-  export interface DragWidgetEventParams<D = any> extends FormDesignEventParams {
+  export interface WidgetMenuEventParams<D = any> extends FormDesignEventParams {
     widget: VxeFormDesignDefines.WidgetObjItem<D>
   }
+  export interface MenuClickEventParams<D = any> extends FormDesignEventParams {
+    widget: VxeFormDesignDefines.WidgetObjItem<D>
+    option: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+  }
 }
 
 export type VxeFormDesignEventProps = {
-  onClickWidget?: VxeFormDesignEvents.ClickWidget
-  onAddWidget?: VxeFormDesignEvents.AddWidget
-  onCopyWidget?: VxeFormDesignEvents.CopyWidget
-  onRemoveWidget?: VxeFormDesignEvents.RemoveWidget
-  onDragWidget?: VxeFormDesignEvents.DragWidget
+  onWidgetClick?: VxeFormDesignEvents.WidgetClick
+  onWidgetAdd?: VxeFormDesignEvents.WidgetAdd
+  onWidgetCopy?: VxeFormDesignEvents.WidgetCopy
+  onWidgetRemove?: VxeFormDesignEvents.WidgetRemove
+  onWidgetDrag?: VxeFormDesignEvents.WidgetDrag
+  onWidgetMenu?: VxeFormDesignEvents.WidgetMenu
+  onMenuClick?: VxeFormDesignEvents.MenuClick
+
+  /**
+   * @deprecated
+   */
+  onClickWidget?: VxeFormDesignEvents.WidgetClick
+  /**
+   * @deprecated
+   */
+  onAddWidget?: VxeFormDesignEvents.WidgetAdd
+  /**
+   * @deprecated
+   */
+  onCopyWidget?: VxeFormDesignEvents.WidgetCopy
+  /**
+   * @deprecated
+   */
+  onRemoveWidget?: VxeFormDesignEvents.WidgetRemove
+  /**
+   * @deprecated
+   */
+  onDragWidget?: VxeFormDesignEvents.WidgetDrag
 }
 
 export interface VxeFormDesignListeners {
-  clickWidget?: VxeFormDesignEvents.ClickWidget
-  addWidget?: VxeFormDesignEvents.AddWidget
-  copyWidget?: VxeFormDesignEvents.CopyWidget
-  removeWidget?: VxeFormDesignEvents.RemoveWidget
-  dragWidget?: VxeFormDesignEvents.DragWidget
+  widgetClick?: VxeFormDesignEvents.WidgetClick
+  widgetAdd?: VxeFormDesignEvents.WidgetAdd
+  widgetCopy?: VxeFormDesignEvents.WidgetCopy
+  widgetRemove?: VxeFormDesignEvents.WidgetRemove
+  widgetDrag?: VxeFormDesignEvents.WidgetDrag
+  widgetMenu?: VxeFormDesignEvents.WidgetMenu
+  menuClick?: VxeFormDesignEvents.MenuClick
+
+  /**
+   * @deprecated
+   */
+  clickWidget?: VxeFormDesignEvents.WidgetClick
+  /**
+   * @deprecated
+   */
+  addWidget?: VxeFormDesignEvents.WidgetAdd
+  /**
+   * @deprecated
+   */
+  copyWidget?: VxeFormDesignEvents.WidgetCopy
+  /**
+   * @deprecated
+   */
+  removeWidget?: VxeFormDesignEvents.WidgetRemove
+  /**
+   * @deprecated
+   */
+  dragWidget?: VxeFormDesignEvents.WidgetDrag
 }
 
 export namespace VxeFormDesignEvents {
-  export type ClickWidget<D = any> = (params: VxeFormDesignDefines.ClickWidgetEventParams<D>) => void
-  export type AddWidget<D = any> = (params: VxeFormDesignDefines.AddWidgetEventParams<D>) => void
-  export type CopyWidget<D = any> = (params: VxeFormDesignDefines.CopyWidgetEventParams<D>) => void
-  export type RemoveWidget<D = any> = (params: VxeFormDesignDefines.RemoveWidgetEventParams<D>) => void
-  export type DragWidget<D = any> = (params: VxeFormDesignDefines.DragWidgetEventParams<D>) => void
+  export type WidgetClick<D = any> = (params: VxeFormDesignDefines.WidgetClickEventParams<D>) => void
+  export type WidgetAdd<D = any> = (params: VxeFormDesignDefines.WidgetAddEventParams<D>) => void
+  export type WidgetCopy<D = any> = (params: VxeFormDesignDefines.WidgetCopyEventParams<D>) => void
+  export type WidgetRemove<D = any> = (params: VxeFormDesignDefines.WidgetRemoveEventParams<D>) => void
+  export type WidgetDrag<D = any> = (params: VxeFormDesignDefines.WidgetDragEventParams<D>) => void
+  export type WidgetMenu = (params: VxeFormDesignDefines.WidgetMenuEventParams) => void
+  export type MenuClick = (params: VxeFormDesignDefines.MenuClickEventParams) => void
  }
 
 export namespace VxeFormDesignSlotTypes {

package/types/components/menu.d.ts

@@ -1,6 +1,7 @@
 import { RenderFunction, SetupContext, Ref } from 'vue'
 import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentSlotType, VxeComponentStyleType, VxeComponentBaseOptions, VxeComponentEventParams, ValueOf, VxeComponentSizeType, VxeComponentPermissionCodeType } from '@vxe-ui/core'
 import { VxeLinkPropTypes } from './link'
+import { VxeContextMenuPropTypes, VxeContextMenuDefines } from './context-menu'
 
 /* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
 
@@ -48,6 +49,24 @@ export namespace VxeMenuPropTypes {
   export type CollapseFixed = boolean
   export type ExpandAll = boolean
   export type Options = MenuOption[]
+  export interface MenuConfig {
+    /**
+     * 是否启用
+     */
+    enabled?: boolean
+    /**
+     * 菜单配置
+     */
+    options: VxeContextMenuPropTypes.Options
+    /**
+     * 该函数的返回值用来决定是否允许显示右键菜单（对于需要对菜单进行权限控制时可能会用到）
+     */
+    visibleMethod?(params: {
+      $menu: VxeMenuConstructor
+      options: VxeContextMenuPropTypes.Options
+      currentMenu: VxeMenuDefines.MenuItem
+    }): boolean
+  }
 }
 
 export interface VxeMenuProps {
@@ -59,6 +78,7 @@ export interface VxeMenuProps {
   CollapseFixed?: VxeMenuPropTypes.CollapseFixed
   expandAll?: VxeMenuPropTypes.ExpandAll
   options?: VxeMenuPropTypes.Options
+  menuConfig?: VxeMenuPropTypes.MenuConfig
 }
 
 export interface MenuPrivateComputed {
@@ -85,7 +105,9 @@ export interface VxeMenuPrivateMethods extends MenuPrivateMethods { }
 
 export type VxeMenuEmits = [
   'update:modelValue',
-  'click'
+  'click',
+  'option-menu',
+  'menu-click'
 ]
 
 export namespace VxeMenuDefines {
@@ -107,30 +129,56 @@ export namespace VxeMenuDefines {
   }
 
   export interface ClickParams {
+    currentMenu: VxeMenuDefines.MenuItem
+
+    /**
+     * 已废弃，请使用 currentMenu
+     * @deprecated
+     */
     menu: VxeMenuDefines.MenuItem
   }
   export interface ClickEventParams extends MenuEventParams, ClickParams { }
+
+  export interface OptionMenuEventParams extends MenuEventParams {
+    currentMenu: VxeMenuDefines.MenuItem
+  }
+  export interface MenuClickEventParams extends MenuEventParams {
+    currentMenu: VxeMenuDefines.MenuItem
+    option: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+  }
 }
 
 export type VxeMenuEventProps = {
   'onUpdate:modelValue'?: VxeMenuEvents.UpdateModelValue
   onClick?: VxeMenuEvents.Click
+  onOptionMenu?: VxeMenuEvents.OptionMenu
+  onMenuClick?: VxeMenuEvents.MenuClick
 }
 
 export interface VxeMenuListeners {
   'update:modelValue'?: VxeMenuEvents.UpdateModelValue
   click?: VxeMenuEvents.Click
+  optioMenu?: VxeMenuEvents.OptionMenu
+  menuClick?: VxeMenuEvents.MenuClick
 }
 
 export namespace VxeMenuEvents {
   export type UpdateModelValue = (modelValue: VxeMenuPropTypes.ModelValue) => void
   export type Click = (params: VxeMenuDefines.ClickEventParams) => void
+  export type OptionMenu = (params: VxeMenuDefines.OptionMenuEventParams) => void
+  export type MenuClick = (params: VxeMenuDefines.MenuClickEventParams) => void
 }
 
 export namespace VxeMenuSlotTypes {
   export interface DefaultSlotParams {
-    option: Required<VxeMenuPropTypes.MenuOption>
+    currentMenu: Required<VxeMenuPropTypes.MenuOption>
     collapsed: boolean
+
+    /**
+     * 已废弃，请使用 currentMenu
+     * @deprecated
+     */
+    option: Required<VxeMenuPropTypes.MenuOption>
   }
   export interface IconSlotParams extends DefaultSlotParams {}
   export interface TitleSlotParams extends DefaultSlotParams {}

package/types/ui/menus.d.ts

@@ -1,5 +1,10 @@
 import { VxeTableConstructor, VxeTableDefines } from '../components/table'
 import { VxeGridConstructor } from '../components/grid'
+import { VxeTreeConstructor } from '../components/tree'
+import { VxeCalendarConstructor } from '../components/calendar'
+import { VxeFormDesignConstructor, VxeFormDesignDefines } from '../components/form-design'
+import { VxeMenuConstructor, VxeMenuPropTypes } from '../components/menu'
+import { VxeContextMenuDefines } from '../components/context-menu'
 
 /* eslint-disable no-use-before-define */
 
@@ -9,20 +14,64 @@ declare module '@vxe-ui/core' {
       /**
        * 表格 - 自定义菜单方法
        */
-      tableMenuMethod?: (params: TableMenuMethodParams, event: Event) => any
+      tableMenuMethod?: (params: TableMenuMethodParams, event: Event) => void
+      /**
+       * 树 - 自定义菜单方法
+       */
+      treeMenuMethod?: (params: TreeMenuMethodParams, event: Event) => void
+      /**
+       * 日历 - 自定义菜单方法
+       */
+      calendarMenuMethod?: (params: CalendarMenuMethodParams, event: Event) => void
+      /**
+       * 菜单 - 自定义菜单方法
+       */
+      menuMenuMethod?: (params: MenuMenuMethodParams, event: Event) => void
+      /**
+       * 表单设计器 - 自定义菜单方法
+       */
+      formDesignMenuMethod?: (params: FormDesignMenuMethodParams, event: Event) => void
 
       /**
        * 已废弃，请使用 tableMenuMethod
        * @deprecated
        */
-      menuMethod?: (params: TableMenuMethodParams, event: Event) => any
+      menuMethod?: (params: TableMenuMethodParams, event: Event) => void
     }
 
-    export interface TableMenuMethodParams extends VxeGlobalRendererHandles.RenderCellParams {
-      $grid: VxeGridConstructor | null | undefined
-      $table: VxeTableConstructor
+    export interface TableMenuMethodParams<D = any> extends VxeGlobalRendererHandles.RenderTableCellParams<D> {
+      $grid: VxeGridConstructor<D> | null | undefined
+      $table: VxeTableConstructor<D>
       $event: MouseEvent
       menu: VxeTableDefines.MenuFirstOption | VxeTableDefines.MenuChildOption
     }
+
+    export interface TreeMenuMethodParams<D = any> {
+      $tree: VxeTreeConstructor
+      $event: MouseEvent
+      node: D
+      menu: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+    }
+
+    export interface CalendarMenuMethodParams {
+      $calendar: VxeCalendarConstructor
+      $event: MouseEvent
+      date: Date
+      menu: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+    }
+
+    export interface MenuMenuMethodParams {
+      $menu: VxeMenuConstructor
+      $event: MouseEvent
+      currentMenu: VxeMenuPropTypes.MenuOption
+      menu: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+    }
+
+    export interface FormDesignMenuMethodParams<D = any> {
+      $formDesign: VxeFormDesignConstructor
+      $event: MouseEvent
+      widget: VxeFormDesignDefines.WidgetObjItem<D>
+      menu: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+    }
   }
 }