vxe-pc-ui 4.11.30 → 4.11.32

package/types/components/button.d.ts

@@ -79,6 +79,7 @@ export namespace VxeButtonPropTypes {
   export type PrefixTooltip = VxeTooltipDefines.TooltipHelperOption
   export type SuffixTooltip = VxeTooltipDefines.TooltipHelperOption
 
+  export type ShowDropdownIcon = boolean
   export type DestroyOnClose = boolean
   export type Transfer = boolean
 }
@@ -159,6 +160,7 @@ export interface VxeButtonProps {
 
   prefixTooltip?: VxeButtonPropTypes.PrefixTooltip
   suffixTooltip?: VxeButtonPropTypes.SuffixTooltip
+  showDropdownIcon?: VxeButtonPropTypes.ShowDropdownIcon
   /**
    * 在下拉面板关闭时销毁内容
    */
@@ -223,7 +225,7 @@ export namespace VxeButtonDefines {
 
   export interface ClickParams { }
   export interface ClickEventParams extends ButtonEventParams, ClickParams {
-    $event: KeyboardEvent
+    $event: MouseEvent
   }
 
   export interface MouseenterParams { }

package/types/components/context-menu.d.ts

@@ -0,0 +1,286 @@
+import { RenderFunction, SetupContext, Ref } from 'vue'
+import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, ValueOf, VxeComponentSlotType, VxeComponentSizeType } from '@vxe-ui/core'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeContextMenu: DefineVxeComponentApp<VxeContextMenuProps, VxeContextMenuEventProps, VxeContextMenuSlots, VxeContextMenuMethods>
+export type VxeContextMenuComponent = DefineVxeComponentOptions<VxeContextMenuProps, VxeContextMenuEventProps>
+
+export type VxeContextMenuInstance = DefineVxeComponentInstance<VxeContextMenuProps, VxeContextMenuConstructor>
+
+export interface VxeContextMenuConstructor extends VxeComponentBaseOptions, VxeContextMenuMethods {
+  props: VxeContextMenuProps
+  context: SetupContext<VxeContextMenuEmits>
+  internalData: ContextMenuInternalData
+  reactData: ContextMenuReactData
+  getRefMaps(): ContextMenuPrivateRef
+  getComputeMaps(): ContextMenuPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface ContextMenuPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+}
+export interface VxeContextMenuPrivateRef extends ContextMenuPrivateRef { }
+
+export namespace VxeContextMenuPropTypes {
+  export type ModelValue = boolean
+  export type X = string | number
+  export type Y = string | number
+  export type ClassName = string
+  export type Size = VxeComponentSizeType
+  export type Options = VxeContextMenuDefines.MenuFirstOption[][]
+  export type Position = null | '' | 'absolute' | 'fixed'
+  export type ZIndex = string | number
+  export type DestroyOnClose = boolean
+  export type Transfer = boolean
+}
+
+export type VxeContextMenuProps = {
+  modelValue?: VxeContextMenuPropTypes.ModelValue
+  x?: VxeContextMenuPropTypes.X
+  y?: VxeContextMenuPropTypes.Y
+  className?: VxeContextMenuPropTypes.ClassName
+  size?: VxeContextMenuPropTypes.Size
+  options?: VxeContextMenuPropTypes.Options
+  position?: VxeContextMenuPropTypes.Position
+  zIndex?: VxeContextMenuPropTypes.ZIndex
+  destroyOnClose?: VxeContextMenuPropTypes.DestroyOnClose
+  transfer?: VxeContextMenuPropTypes.Transfer
+}
+
+export interface ContextMenuPrivateComputed {
+}
+export interface VxeContextMenuPrivateComputed extends ContextMenuPrivateComputed { }
+
+export interface ContextMenuInternalData {
+}
+
+export interface ContextMenuReactData {
+  visible: boolean
+  activeOption: any
+  activeChildOption: any
+  popupStyle: {
+    top: string
+    left: string
+    zIndex: number
+  }
+  childPos: '' | 'left' | 'right'
+}
+
+export interface ContextMenuMethods {
+  dispatchEvent(type: ValueOf<VxeContextMenuEmits>, params: Record<string, any>, evnt: Event | null): void
+  open(): Promise<void>
+  close(): Promise<void>
+}
+export interface VxeContextMenuMethods extends ContextMenuMethods { }
+
+export interface ContextMenuPrivateMethods { }
+export interface VxeContextMenuPrivateMethods extends ContextMenuPrivateMethods { }
+
+export type VxeContextMenuEmits = [
+  'update:modelValue',
+  'option-click',
+  'change',
+  'show',
+  'hide'
+]
+
+export namespace VxeContextMenuDefines {
+  export type ContextMenuOpenOptions = Pick<VxeContextMenuProps, 'options' | 'x' | 'y' | 'className' | 'size' | 'zIndex'> & {
+    events?: VxeContextMenuListeners
+  }
+  export type ContextMenuEventOpenOptions = Omit<ContextMenuOpenOptions, 'x' | 'y'>
+
+  export interface MenuFirstOption {
+    /**
+     * 菜单唯一编码
+     */
+    code?: string
+    /**
+     * 菜单名称
+     */
+    name?: string
+    /**
+     * 前缀配置项
+     */
+    prefixConfig?: {
+      icon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+      content?: string
+      className?: string
+    }
+    /**
+     * 前缀图标 prefixConfig.icon 的简写
+     */
+    prefixIcon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+    /**
+     * 后缀配置项
+     */
+    suffixConfig?: {
+      icon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+      content?: string
+      className?: string
+    }
+    /**
+     * 后缀图标 suffixConfig.icon 的简写
+     */
+    suffixIcon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+    className?: string
+    /**
+     * 是否加载中
+     */
+    loading?: boolean
+    /**
+     * 是否显示
+     */
+    visible?: boolean
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean
+    /**
+     * 二级菜单列表
+     */
+    children?: MenuChildOption[]
+    params?: any
+    /**
+     * 自定义插槽模板
+     */
+    slots?: {
+      content?: string | ((params: VxeContextMenuSlotTypes.ContentSlotParams) => VxeComponentSlotType | VxeComponentSlotType[])
+    }
+    [key: string]: any
+  }
+  export interface MenuChildOption {
+    /**
+     * 菜单唯一编码
+     */
+    code?: string
+    /**
+     * 菜单名称
+     */
+    name?: string
+    /**
+     * 前缀配置项
+     */
+    prefixConfig?: {
+      icon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+      content?: string
+      className?: string
+    }
+    /**
+     * 前缀图标 prefixConfig.icon 的简写
+     */
+    prefixIcon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+    /**
+     * 后缀配置项
+     */
+    suffixConfig?: {
+      icon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+      content?: string
+      className?: string
+    }
+    /**
+     * 后缀图标 suffixConfig.icon 的简写
+     */
+    suffixIcon?: string | ((params: {}) => VxeComponentSlotType[] | VxeComponentSlotType)
+    className?: string
+    /**
+     * 是否加载中
+     */
+    loading?: boolean
+    /**
+     * 是否显示
+     */
+    visible?: boolean
+    /**
+     * 是否禁用
+     */
+    disabled?: boolean
+    params?: any
+    /**
+     * 自定义插槽模板
+     */
+    slots?: {
+      content?: string | ((params: VxeContextMenuSlotTypes.ContentSlotParams) => VxeComponentSlotType | VxeComponentSlotType[])
+    }
+    [key: string]: any
+  }
+
+  export interface ContextMenuEventParams extends VxeComponentEventParams {
+    $contextMenu: VxeContextMenuConstructor
+  }
+
+  export interface ChangeEventParams extends ContextMenuEventParams {
+    value: boolean
+  }
+
+  export interface OptionClickEventParams extends ContextMenuEventParams {
+    option: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+  }
+
+  export interface ShowEventParams extends ContextMenuEventParams {
+    visible: boolean
+  }
+  export interface HideEventParams extends ShowEventParams {}
+}
+
+export type VxeContextMenuEventProps = {
+  'onUpdate:modelValue'?: VxeContextMenuEvents.UpdateModelValue
+  onChange?: VxeContextMenuEvents.Change
+  onOptionClick?: VxeContextMenuEvents.OptionClick
+  onShow?: VxeContextMenuEvents.Show
+  onHide?: VxeContextMenuEvents.Hide
+}
+
+export interface VxeContextMenuListeners {
+  'update:modelValue'?: VxeContextMenuEvents.UpdateModelValue
+  change?: VxeContextMenuEvents.Change
+  optionClick?: VxeContextMenuEvents.OptionClick
+  show?: VxeContextMenuEvents.Show
+  hide?: VxeContextMenuEvents.Hide
+}
+
+export namespace VxeContextMenuEvents {
+  export type UpdateModelValue = (modelValue: VxeContextMenuPropTypes.ModelValue) => void
+  export type Change = (params: VxeContextMenuDefines.ChangeEventParams) => void
+  export type OptionClick = (params: VxeContextMenuDefines.OptionClickEventParams) => void
+  export type Show = (params: VxeContextMenuDefines.ShowEventParams) => void
+  export type Hide = (params: VxeContextMenuDefines.HideEventParams) => void
+}
+
+export namespace VxeContextMenuSlotTypes {
+  export interface DefaultSlotParams {}
+
+  export interface ContentSlotParams {
+    option: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+  }
+}
+
+export interface VxeContextMenuSlots {
+  [key: string]: ((params: VxeContextMenuSlotTypes.DefaultSlotParams) => any) | undefined
+}
+
+/**
+ * 全局右键菜单
+ */
+export interface ContextMenuController {
+  /**
+   * 通过传 x,y 坐标打开
+   * @param options 参数
+   */
+  open(options: VxeContextMenuDefines.ContextMenuOpenOptions): void
+  /**
+   * 通过事件打开
+   * @param evnt 事件
+   * @param options 参数
+   */
+  openByEvent(evnt: MouseEvent, options: VxeContextMenuDefines.ContextMenuEventOpenOptions): void
+  /**
+   * 关闭
+   */
+  close(): void
+}
+
+export const ContextMenu: typeof VxeContextMenu
+export default VxeContextMenu

package/types/components/password-input.d.ts

@@ -134,6 +134,8 @@ export namespace VxePasswordInputSlotTypes {
 
 export interface VxePasswordInputSlots {
   default?: (params: VxePasswordInputSlotTypes.DefaultSlotParams) => any
+  prefix: (params: VxePasswordInputSlotTypes.DefaultSlotParams) => any
+  suffix: (params: VxePasswordInputSlotTypes.DefaultSlotParams) => any
 }
 
 export const PasswordInput: typeof VxePasswordInput

package/types/components/print.d.ts

@@ -61,6 +61,7 @@ export namespace VxePrintPropTypes {
     }
   }
   export type CustomStyle = string
+  export type StyleUrls = string[]
   export type ShowAllPageTitle = boolean
   export type HeaderHtml = string | ((params: VxePrintDefines.PageBreakParams) => string)
   export type FooterHtml = string | ((params: VxePrintDefines.PageBreakParams) => string)
@@ -87,7 +88,14 @@ export interface VxePrintProps {
   showPageNumber?: VxePrintPropTypes.ShowPageNumber
   footerAlign?: VxePrintPropTypes.FooterAlign
   pageStyle?: VxePrintPropTypes.PageStyle
+  /**
+   * 自定义 css 规则
+   */
   customStyle?: VxePrintPropTypes.CustomStyle
+  /**
+   * 引入 css 文件的 url
+   */
+  styleUrls?: VxePrintPropTypes.StyleUrls
   headerHtml?: VxePrintPropTypes.HeaderHtml
   footerHtml?: VxePrintPropTypes.FooterHtml
   leftHtml?: VxePrintPropTypes.LeftHtml

package/types/components/table.d.ts

@@ -5186,6 +5186,14 @@ export interface TablePrivateMethods<D = any> {
    * @private
    */
   triggerCellDblclickEvent(evnt: MouseEvent, params: VxeTableDefines.CellRenderBodyParams<any>): void
+  /**
+   * @private
+   */
+  triggerFooterCellClickEvent(evnt: MouseEvent, params: VxeTableDefines.CellRenderFooterParams<any>): void
+  /**
+   * @private
+   */
+  triggerFooterCellDblclickEvent(evnt: MouseEvent, params: VxeTableDefines.CellRenderFooterParams<any>): void
   /**
    * @private
    */

package/types/components/tree.d.ts

@@ -1,5 +1,6 @@
 import { RenderFunction, SetupContext, Ref, ComputedRef } from 'vue'
 import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'
+import { VxeContextMenuPropTypes, VxeContextMenuDefines } from './context-menu'
 
 /* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
 
@@ -200,6 +201,25 @@ export namespace VxeTreePropTypes {
     dragToChildMethod?(params: Omit<VxeTreeDefines.NodeDragToChildMethod<D>, '_index'>): boolean
   }
 
+  export interface MenuConfig<D = any> {
+    /**
+     * 是否启用
+     */
+    enabled?: boolean
+    /**
+     * 菜单配置
+     */
+    options: VxeContextMenuPropTypes.Options
+    /**
+     * 该函数的返回值用来决定是否允许显示右键菜单（对于需要对菜单进行权限控制时可能会用到）
+     */
+    visibleMethod?(params: {
+      $tree: VxeTreeConstructor
+      options: VxeContextMenuPropTypes.Options
+      node: D
+    }): boolean
+  }
+
   /**
    * 根据指定值来筛选数据
    */
@@ -294,6 +314,7 @@ export interface VxeTreeProps<D = any> {
   checkNodeKeys?: VxeTreePropTypes.CheckNodeKeys
   checkboxConfig?: VxeTreePropTypes.CheckboxConfig<D>
   nodeConfig?: VxeTreePropTypes.NodeConfig<D>
+  menuConfig?: VxeTreePropTypes.MenuConfig<D>
   filterValue?: VxeTreePropTypes.FilterValue
   filterConfig?: VxeTreePropTypes.FilterConfig
   lazy?: VxeTreePropTypes.Lazy
@@ -633,7 +654,10 @@ export type VxeTreeEmits = [
   'scroll',
   'node-dragstart',
   'node-dragover',
-  'node-dragend'
+  'node-dragend',
+  'node-expand',
+  'node-menu',
+  'menu-click'
 ]
 
 export namespace VxeTreeDefines {
@@ -712,6 +736,18 @@ export namespace VxeTreeDefines {
   export interface LoadErrorEventParams<D = any> extends TreeEventParams<D> {
     node: D
   }
+
+  export interface NodeExpandEventParams<D = any> extends NodeClickEventParams<D> {
+    expanded: boolean
+  }
+
+  export interface NodeMenuEventParams<D = any> extends TreeEventParams<D> {
+    node: D
+  }
+  export interface MenuClickEventParams<D = any> extends TreeEventParams<D> {
+    node: D
+    option: VxeContextMenuDefines.MenuFirstOption | VxeContextMenuDefines.MenuChildOption
+  }
 }
 
 export type VxeTreeEventProps<D = any> = {
@@ -725,6 +761,9 @@ export type VxeTreeEventProps<D = any> = {
   onNodeDragstart?: VxeTreeEvents.NodeDragstart<D>
   onNodeDragover?: VxeTreeEvents.NodeDragover<D>
   onNodeDragend?: VxeTreeEvents.NodeDragend<D>
+  onNodeExpand?: VxeTreeEvents.NodeExpand<D>
+  onNodeMenu?: VxeTreeEvents.NodeMenu<D>
+  onMenuClick?: VxeTreeEvents.MenuClick<D>
 }
 
 export interface VxeTreeListeners<D = any> {
@@ -738,6 +777,9 @@ export interface VxeTreeListeners<D = any> {
   nodeDragstart?: VxeTreeEvents.NodeDragstart<D>
   nodeDragover?: VxeTreeEvents.NodeDragover<D>
   nodeDragend?: VxeTreeEvents.NodeDragend<D>
+  nodeExpand?: VxeTreeEvents.NodeExpand<D>
+  nodeMenu?: VxeTreeEvents.NodeMenu<D>
+  menuClick?: VxeTreeEvents.MenuClick<D>
 }
 
 export namespace VxeTreeEvents {
@@ -751,6 +793,9 @@ export namespace VxeTreeEvents {
   export type NodeDragstart<D = any> = (params: VxeTreeDefines.NodeDragstartEventParams<D>) => void
   export type NodeDragover<D = any> = (params: VxeTreeDefines.NodeDragoverEventParams<D>) => void
   export type NodeDragend<D = any> = (params: VxeTreeDefines.NodeDragendEventParams<D>) => void
+  export type NodeExpand<D = any> = (params: VxeTreeDefines.NodeExpandEventParams<D>) => void
+  export type NodeMenu<D = any> = (params: VxeTreeDefines.NodeMenuEventParams<D>) => void
+  export type MenuClick<D = any> = (params: VxeTreeDefines.MenuClickEventParams<D>) => void
 }
 
 export namespace VxeTreeSlotTypes {

package/types/ui/global-config.d.ts

@@ -21,6 +21,7 @@ import { VxeColProps } from '../components/col'
 import { VxeCollapseProps } from '../components/collapse'
 import { VxeCollapsePaneProps } from '../components/collapse-pane'
 import { VxeColorPickerProps } from '../components/color-picker'
+import { VxeContextMenuProps } from '../components/context-menu'
 import { VxeCountdownProps } from '../components/countdown'
 import { VxeDatePanelProps } from '../components/date-panel'
 import { VxeDatePickerProps } from '../components/date-picker'
@@ -131,6 +132,7 @@ declare module '@vxe-ui/core' {
     collapse?: VxeCollapseProps
     collapsePane?: VxeCollapsePaneProps
     colorPicker?: VxeColorPickerProps
+    contextMenu?: VxeContextMenuProps
     countdown?: VxeCountdownProps
     datePanel?: VxeDatePanelProps
     datePicker?: VxeDatePickerProps

package/types/ui/global-icon.d.ts

@@ -284,5 +284,9 @@ declare module '@vxe-ui/core' {
 
     // backtop
     BACKTOP_TOP?: string
+
+    // context-menu
+    CONTEXT_MENU_OPTION_LOADING?: string
+    CONTEXT_MENU_CHILDREN?: string
   }
 }

package/types/ui/index.d.ts

@@ -4,6 +4,7 @@ import { LoadingController } from '../components/loading'
 import { ModalController } from '../components/modal'
 import { DrawerController } from '../components/drawer'
 import { WatermarkController } from '../components/watermark'
+import { ContextMenuController } from '../components/context-menu'
 import { VxePrintDefines } from '../components/print'
 import { VxeUploadDefines } from '../components/upload'
 import { VxeImageDefines } from '../components/image'
@@ -25,6 +26,7 @@ export const loading: LoadingController
 export const modal: ModalController
 export const drawer: DrawerController
 export const watermark: WatermarkController
+export const contextMenu: ContextMenuController
 export const print: VxePrintDefines.PrintFunction
 export const saveFile: VxeUploadDefines.SaveFileFunction
 export const readFile: VxeUploadDefines.ReadFileFunction
@@ -35,6 +37,7 @@ declare module '@vxe-ui/core' {
     modal: ModalController
     drawer: DrawerController
     watermark: WatermarkController
+    contextMenu: ContextMenuController
     dynamicApp: App<Element>
 
     formDesignHandle: FormDesignHandleExport