vxe-pc-ui 1.2.0 → 1.4.0

package/types/components/toolbar.d.ts

@@ -0,0 +1,291 @@
+import { RenderFunction, SetupContext, Ref, ComponentPublicInstance, DefineComponent } from 'vue'
+import { defineVxeComponent, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'
+import { VxeButtonProps } from './button'
+import { VxeTableDefines, VxeTableConstructor, VxeTablePrivateMethods } from './table'
+
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeToolbar: defineVxeComponent<VxeToolbarProps, VxeToolbarEventProps>
+export type VxeToolbarComponent = DefineComponent<VxeToolbarProps, VxeToolbarEmits>
+
+export type VxeToolbarInstance = ComponentPublicInstance<VxeToolbarProps, VxeToolbarConstructor>
+
+export interface VxeToolbarConstructor extends VxeComponentBaseOptions, VxeToolbarMethods {
+  props: VxeToolbarProps
+  context: SetupContext<VxeToolbarEmits>
+  reactData: ToolbarReactData
+  getRefMaps(): ToolbarPrivateRef
+  getComputeMaps(): ToolbarPrivateComputed
+  renderVN: RenderFunction
+}
+
+export interface ToolbarPrivateRef {
+  refElem: Ref<HTMLDivElement | undefined>
+}
+export interface VxeToolbarPrivateRef extends ToolbarPrivateRef { }
+
+export namespace VxeToolbarPropTypes {
+  export type Size = VxeComponentSizeType
+  export type Id = string
+  export type Loading = boolean
+
+  interface ResizableConfig {
+    storage?: boolean
+  }
+  export type Resizable = boolean | ResizableConfig
+  export interface ResizableOpts extends ResizableConfig { }
+
+  interface RefreshConfig {
+    queryMethod?(params: { [key: string]: any }): any
+    code?: 'query' | 'reload' | '' | null
+    icon?: string
+    iconLoading?: string
+    /**
+     * @deprecated 请使用 queryMethod
+     */
+    query?(params: { [key: string]: any }): Promise<any>
+  }
+  export type Refresh = boolean | RefreshConfig
+  export interface RefreshOpts extends RefreshConfig { }
+
+  interface ImportConfig {
+    icon?: string
+  }
+  export type Import = boolean | ImportConfig
+  export interface ImportOpts extends ImportConfig { }
+
+  interface ExportConfig {
+    icon?: string
+  }
+  export type Export = boolean | ExportConfig
+  export interface ExportOpts extends ExportConfig { }
+
+  export interface PrintConfig {
+    icon?: string
+  }
+  export type Print = boolean | PrintConfig
+  export interface PrintOpts extends PrintConfig { }
+
+  interface ZoomConfig {
+    iconIn?: string
+    iconOut?: string
+  }
+  export type Zoom = boolean | ZoomConfig
+  export interface ZoomOpts extends ZoomConfig { }
+
+  interface CustomConfig {
+    icon?: string
+
+    /**
+     * 已废弃，请使用 custom-config.trigger
+     * @deprecated
+     */
+    trigger?: string,
+    /**
+     * 已废弃，请使用 custom-config.immediate
+     * @deprecated
+     */
+    immediate?: boolean
+    /**
+     * 已废弃，请使用 custom-config.storage
+     * @deprecated
+     */
+    storage?: boolean
+    /**
+     * 已废弃，请使用 custom-config.checkMethod
+     * @deprecated
+     */
+    checkMethod?(params: { column: VxeTableDefines.ColumnInfo }): boolean
+    /**
+     * 已废弃，请使用 custom-config.showFooter
+     * @deprecated
+     */
+    showFooter?: boolean
+    /**
+     * 已废弃，请使用 custom-config.allowFixed
+     * @deprecated
+     */
+    allowFixed?: boolean
+    /**
+     * 已废弃，请使用 custom-config.resetButtonText
+     * @deprecated
+     */
+    resetButtonText?: string
+    /**
+     * 已废弃，请使用 custom-config.confirmButtonText
+     * @deprecated
+     */
+    confirmButtonText?: string
+    /**
+     * 已废弃，请使用 custom-config.showFooter
+     * @deprecated
+     */
+    isFooter?: boolean
+  }
+  export type Custom = boolean | CustomConfig
+  export interface CustomOpts extends CustomConfig { }
+
+  interface ButtonAndToolConfig extends VxeButtonProps {
+    code?: string
+    visible?: boolean
+    params?: any
+  }
+
+  export interface ButtonRender {
+    /**
+     * 渲染器名称
+     */
+    name?: string
+    /**
+     * 目标组件渲染的参数
+     */
+    props?: { [key: string]: any }
+    /**
+     * 目标组件渲染的属性
+     */
+    attrs?: { [key: string]: any }
+    /**
+     * 目标组件渲染的事件
+     */
+    events?: { [key: string]: (...args: any[]) => any }
+  }
+  export interface ButtonConfig extends ButtonAndToolConfig {
+    dropdowns?: ButtonConfig[]
+    buttonRender?: ButtonRender
+  }
+  export type Buttons = ButtonConfig[]
+
+  export interface ToolRender {
+    /**
+     * 渲染器名称
+     */
+    name?: string
+    /**
+     * 目标组件渲染的参数
+     */
+    props?: { [key: string]: any }
+    /**
+     * 目标组件渲染的属性
+     */
+    attrs?: { [key: string]: any }
+    /**
+     * 目标组件渲染的事件
+     */
+    events?: { [key: string]: (...args: any[]) => any }
+  }
+  export interface ToolConfig extends ButtonAndToolConfig {
+    dropdowns?: ToolConfig[]
+    toolRender?: ToolRender
+  }
+  export type Tools = ToolConfig[]
+
+  export type Perfect = boolean
+
+  export type ClassName = string | ((params: {
+    $toolbar: VxeToolbarConstructor
+  }) => string)
+}
+
+export type VxeToolbarProps = {
+  size?: VxeToolbarPropTypes.Size
+  /**
+   * 唯一 ID 标识
+   */
+  id?: VxeToolbarPropTypes.Id
+  /**
+   * 是否加载中
+   */
+  loading?: VxeToolbarPropTypes.Loading
+  /**
+   * 列宽拖动配置
+   */
+  resizable?: VxeToolbarPropTypes.Resizable
+  /**
+   * 刷新按钮配置
+   */
+  refresh?: VxeToolbarPropTypes.Refresh
+  /**
+   * 导入按钮配置
+   */
+  import?: VxeToolbarPropTypes.Import
+  /**
+   * 导出按钮配置
+   */
+  export?: VxeToolbarPropTypes.Export
+  print?: VxeToolbarPropTypes.Print
+  zoom?: VxeToolbarPropTypes.Zoom
+  /**
+   * 自定义列配置
+   */
+  custom?: VxeToolbarPropTypes.Custom
+  /**
+   * 按钮列表
+   */
+  buttons?: VxeToolbarPropTypes.Buttons
+  tools?: VxeToolbarPropTypes.Tools
+  /**
+   * 配套的样式
+   */
+  perfect?: VxeToolbarPropTypes.Perfect
+  className?: VxeToolbarPropTypes.ClassName
+}
+
+export interface ToolbarPrivateComputed {
+}
+export interface VxeToolbarPrivateComputed extends ToolbarPrivateComputed { }
+
+export interface ToolbarReactData {
+  isRefresh: boolean
+  columns: VxeTableDefines.ColumnInfo[]
+}
+
+export interface ToolbarMethods {
+  dispatchEvent(type: ValueOf<VxeToolbarEmits>, params: Record<string, any>, evnt: Event | null): void
+  syncUpdate(params: {
+    collectColumn: VxeTableDefines.ColumnInfo<any>[]
+    $table: VxeTableConstructor<any> & VxeTablePrivateMethods<any>
+  }): void
+}
+export interface VxeToolbarMethods extends ToolbarMethods { }
+
+export interface ToolbarPrivateMethods { }
+export interface VxeToolbarPrivateMethods extends ToolbarPrivateMethods { }
+
+export type VxeToolbarEmits = [
+  'button-click',
+  'tool-click'
+]
+
+export namespace VxeToolbarDefines {
+  export interface ToolbarEventParams extends VxeComponentEventParams {
+    $toolbar: VxeToolbarConstructor
+  }
+}
+
+export type VxeToolbarEventProps = {}
+
+export interface VxeToolbarListeners { }
+
+export namespace VxeToolbarEvents { }
+
+export namespace VxeToolbarSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeToolbarSlots {
+  /**
+   * 自定义左侧按钮列表
+   */
+  buttons: (params: {
+    [key: string]: any
+  }) => any
+  /**
+   * 自定义右侧工具列表
+   */
+  tools: ((params: {
+    [key: string]: any
+  }) => any) | undefined
+}
+
+export const Toolbar: typeof VxeToolbar
+export default VxeToolbar

package/types/components/tooltip.d.ts

@@ -26,7 +26,7 @@ export namespace VxeTooltipPropTypes {
   export type Size = VxeComponentSizeType
   export type ModelValue = boolean
   export type Trigger = 'hover' | 'click' | 'manual' | '' | null
-  export type Theme = string
+  export type Theme = '' | 'light' | 'dark'
   export type Content = string | number
   export type UseHTML = boolean
   export type ZIndex = string | number

package/types/ui/commands.d.ts

@@ -0,0 +1,13 @@
+import { VxeGridConstructor } from '../components/grid'
+import { VxeToolbarPropTypes } from '../components/toolbar'
+import { VxeTableConstructor } from '../components/table'
+
+declare module '@vxe-ui/core' {
+  export namespace VxeGlobalCommandsHandles {
+    export interface CommandMethodParams {
+      $grid: VxeGridConstructor | null
+      $table: VxeTableConstructor
+      button?: VxeToolbarPropTypes.ButtonConfig | null
+    }
+  }
+}

package/types/ui/formats.d.ts

@@ -0,0 +1,11 @@
+import { VxeTableDefines } from '../components/table'
+
+declare module '@vxe-ui/core' {
+  export namespace VxeGlobalFormatsHandles {
+    export interface FormatMethodParams {
+      cellValue: any
+      row: any
+      column: VxeTableDefines.ColumnInfo
+    }
+  }
+}

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

@@ -7,11 +7,16 @@ import { VxeButtonGroupProps } from '../components/button-group'
 import { VxeCheckboxProps } from '../components/checkbox'
 import { VxeCheckboxGroupProps } from '../components/checkbox-group'
 import { VxeColProps } from '../components/col'
+import { VxeColgroupProps } from '../components/colgroup'
+import { VxeCollapseProps } from '../components/collapse'
+import { VxeCollapsePaneProps } from '../components/collapse-pane'
+import { VxeColumnProps } from '../components/column'
 import { VxeDrawerProps } from '../components/drawer'
 import { VxeFormProps } from '../components/form'
 import { VxeFormDesignProps } from '../components/form-design'
 import { VxeFormGatherProps } from '../components/form-gather'
 import { VxeFormItemProps } from '../components/form-item'
+import { VxeGridProps } from '../components/grid'
 import { VxeIconProps } from '../components/icon'
 import { VxeInputProps } from '../components/input'
 import { VxeLayoutAsideProps } from '../components/layout-aside'
@@ -34,8 +39,10 @@ import { VxeRowProps } from '../components/row'
 import { VxeSelectProps } from '../components/select'
 import { VxeSwitchProps } from '../components/switch'
 import { VxeTabPaneProps } from '../components/tab-pane'
+import { VxeTableProps } from '../components/table'
 import { VxeTabsProps } from '../components/tabs'
 import { VxeTextareaProps } from '../components/textarea'
+import { VxeToolbarProps } from '../components/toolbar'
 import { VxeTooltipProps } from '../components/tooltip'
 
 declare module '@vxe-ui/core' {
@@ -49,11 +56,16 @@ declare module '@vxe-ui/core' {
     checkbox?: VxeCheckboxProps
     checkboxGroup?: VxeCheckboxGroupProps
     col?: VxeColProps
+    colgroup?: VxeColgroupProps
+    collapse?: VxeCollapseProps
+    collapsePane?: VxeCollapsePaneProps
+    column?: VxeColumnProps
     drawer?: VxeDrawerProps
     form?: VxeFormProps
     formDesign?: VxeFormDesignProps
     formGather?: VxeFormGatherProps
     formItem?: VxeFormItemProps
+    grid?: VxeGridProps
     icon?: VxeIconProps
     input?: VxeInputProps
     layoutAside?: VxeLayoutAsideProps
@@ -76,8 +88,39 @@ declare module '@vxe-ui/core' {
     select?: VxeSelectProps
     switch?: VxeSwitchProps
     tabPane?: VxeTabPaneProps
+    table?: VxeTableProps
     tabs?: VxeTabsProps
     textarea?: VxeTextareaProps
+    toolbar?: VxeToolbarProps
     tooltip?: VxeTooltipProps
+
+    /**
+     * 获取导出的所有文件类型
+     * @deprecated
+     */
+    exportTypes?: string[]
+    /**
+     * 获取导入的所有文件类型
+     * @deprecated
+     */
+    importTypes?: string[]
+    /**
+     * @deprecated
+     */
+    emptyCell?: string
+    /**
+     * @deprecated
+     */
+    translate?(key: string, args?: any): string
+    /**
+     * 还原成老的校验样式
+     * @deprecated
+     */
+    cellVaildMode?: 'obsolete'
+    /**
+     * 返回老的校验结果
+     * @deprecated
+     */
+    validToReject?: 'obsolete'
   }
 }

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

@@ -2,6 +2,40 @@ import '@vxe-ui/core'
 
 declare module '@vxe-ui/core' {
   export interface VxeGlobalIcon {
+    // table
+    TABLE_SORT_ASC?: string
+    TABLE_SORT_DESC?: string
+    TABLE_FILTER_NONE?: string
+    TABLE_FILTER_MATCH?: string
+    TABLE_EDIT?: string
+    TABLE_TITLE_PREFIX?: string
+    TABLE_TITLE_SUFFIX?: string
+    TABLE_TREE_LOADED?: string
+    TABLE_TREE_OPEN?: string
+    TABLE_TREE_CLOSE?: string
+    TABLE_EXPAND_LOADED?: string
+    TABLE_EXPAND_OPEN?: string
+    TABLE_EXPAND_CLOSE?: string
+    TABLE_CHECKBOX_CHECKED?: string
+    TABLE_CHECKBOX_UNCHECKED?: string
+    TABLE_CHECKBOX_INDETERMINATE?: string
+    TABLE_RADIO_CHECKED?: string
+    TABLE_RADIO_UNCHECKED?: string
+
+    // toolbar
+    TOOLBAR_TOOLS_REFRESH?: string
+    TOOLBAR_TOOLS_REFRESH_LOADING?: string
+    TOOLBAR_TOOLS_IMPORT?: string
+    TOOLBAR_TOOLS_EXPORT?: string
+    TOOLBAR_TOOLS_PRINT?: string
+    TOOLBAR_TOOLS_FULLSCREEN?: string
+    TOOLBAR_TOOLS_MINIMIZE?: string
+    TOOLBAR_TOOLS_CUSTOM?: string
+    TOOLBAR_TOOLS_FIXED_LEFT?: string
+    TOOLBAR_TOOLS_FIXED_LEFT_ACTIVED?: string
+    TOOLBAR_TOOLS_FIXED_RIGHT?: string
+    TOOLBAR_TOOLS_FIXED_RIGHT_ACTIVED?: string
+
     // loading
     LOADING?: string
 

package/types/ui/hooks.d.ts

@@ -0,0 +1,11 @@
+import { VxeTableConstructor, VxeTableMethods, VxeTablePrivateMethods } from '../components/table'
+import { VxeGridConstructor, VxeGridPrivateMethods } from '../components/grid'
+
+declare module '@vxe-ui/core' {
+  export namespace VxeGlobalHooksHandles {
+    export interface HookOptions {
+      setupTable?($table: VxeTableConstructor & VxeTableMethods & VxeTablePrivateMethods<any>): void | Record<string, any>
+      setupGrid?($grid: VxeGridConstructor & VxeGridPrivateMethods): void | Record<string, any>
+    }
+  }
+}

package/types/ui/index.d.ts

@@ -4,17 +4,10 @@ import { DrawerController } from '../components/drawer'
 import { VxePrintDefines } from '../components/print'
 import { VxeUploadDefines } from '../components/upload'
 
-export const uiVersion: string
-export const modal: ModalController
-export const drawer: DrawerController
-export const dynamicApp: App<Element>
-export const print: VxePrintDefines.PrintFunction
-export const saveFile: VxeUploadDefines.SaveFileFunction
-export const readFile: VxeUploadDefines.ReadFileFunction
-
 declare module '@vxe-ui/core' {
   export interface VxeUIExport {
     uiVersion: string
+    tableVersion: string
     modal: ModalController
     drawer: DrawerController
     dynamicApp: App<Element>
@@ -27,7 +20,12 @@ declare module '@vxe-ui/core' {
 export * from './global-config'
 export * from './global-icon'
 export * from './renderer'
+export * from './interceptor'
+export * from './commands'
+export * from './formats'
+export * from './menus'
 export * from './validators'
+export * from './hooks'
 
 export * from '@vxe-ui/core'
 export default VxeUI

package/types/ui/interceptor.d.ts

@@ -0,0 +1,47 @@
+import { VxeTableConstructor, VxeTableDefines, VxeTablePropTypes, VxeTablePrivateMethods } from '../components/table'
+import { VxeGridConstructor, VxeGridPrivateMethods } from '../components/grid'
+
+declare module '@vxe-ui/core' {
+  export namespace VxeGlobalInterceptorHandles {
+    export type HookType = 'created' | 'mounted' | 'activated' | 'beforeUnmount' | 'unmounted'
+    export type EventType = 'event.clearEdit' | 'event.clearActived' | 'event.clearFilter' | 'event.clearAreas' | 'event.showMenu' | 'event.keydown' | 'event.export' | 'event.import'
+    export type Type = HookType | EventType
+
+    export type InterceptorCallback = (params: any) => any
+
+    interface InterceptorParams {
+      $grid?: VxeGridConstructor<any> & VxeGridPrivateMethods<any>
+      $table: VxeTableConstructor<any> & VxeTablePrivateMethods<any>
+      $event: Event
+    }
+
+    export interface InterceptorKeydownParams extends InterceptorParams { }
+    export interface InterceptorClearFilterParams extends InterceptorParams { }
+    export interface InterceptorClearEditParams extends InterceptorParams { }
+    export interface InterceptorClearAreasParams extends InterceptorParams { }
+
+    export interface InterceptorExportParams extends InterceptorParams {
+      options: VxeTablePropTypes.ExportHandleOptions
+      columns: VxeTableDefines.ColumnInfo<any>[]
+      colgroups: VxeTableDefines.ColumnInfo<any>[][]
+      datas: any[]
+    }
+
+    export interface InterceptorImportParams extends InterceptorParams {
+      file: File
+      options: VxeTablePropTypes.ExportHandleOptions
+      columns: VxeTableDefines.ColumnInfo<any>[]
+      datas: any[]
+    }
+
+    export interface InterceptorShowMenuParams extends InterceptorParams {
+      type: 'header' | 'body' | 'footer'
+      options: VxeTableDefines.MenuFirstOption[][]
+      columns: VxeTableDefines.ColumnInfo<any>[]
+      row?: any
+      rowIndex?: number
+      column?: VxeTableDefines.ColumnInfo<any>
+      columnIndex?: number
+    }
+  }
+}

package/types/ui/menus.d.ts

@@ -0,0 +1,14 @@
+import { VxeTableConstructor, VxeTableDefines, VxeTablePrivateMethods } from '../components/table'
+import { VxeGridConstructor } from '../components/grid'
+import { VxeGlobalRendererHandles } from './renderer'
+
+declare module '@vxe-ui/core' {
+  export namespace VxeGlobalMenusHandles {
+    export interface MenuMethodParams extends VxeGlobalRendererHandles.RenderCellParams {
+      $grid: VxeGridConstructor | null
+      $table: VxeTableConstructor & VxeTablePrivateMethods
+      $event: MouseEvent
+      menu: VxeTableDefines.MenuFirstOption | VxeTableDefines.MenuChildOption
+    }
+  }
+}