vxe-pc-ui 3.15.11 → 3.15.13

package/types/components/list.d.ts

@@ -1,15 +1,15 @@
 import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'
 
-/* eslint-disable @typescript-eslint/no-empty-interface,no-use-before-define,@typescript-eslint/ban-types */
+/* eslint-disable @typescript-eslint/no-empty-interface,no-use-before-define,@typescript-eslint/ban-types,@typescript-eslint/no-unused-vars */
 
 export declare const VxeList: DefineVxeComponentApp<VxeListProps, VxeListEventProps, VxeListSlots, VxeListMethods>
 export type VxeListComponent = DefineVxeComponentOptions<VxeListProps>
 
-export type VxeListInstance = DefineVxeComponentInstance<{
+export type VxeListInstance<D = any> = DefineVxeComponentInstance<{
   reactData: ListReactData
-}, VxeListProps, VxeListPrivateComputed, VxeListMethods>
+}, VxeListProps, VxeListPrivateComputed, VxeListMethods<D>>
 
-export type VxeListConstructor = VxeListInstance
+export type VxeListConstructor<D = any> = VxeListInstance<D>
 
 export interface ListPrivateRef {
 }
@@ -25,6 +25,133 @@ export namespace VxeListPropTypes {
   export type ClassName = string | ((params: { $list: VxeListConstructor }) => string)
   export type SyncResize = boolean | string | number
 
+  export type ShowRadio = boolean
+  export type CheckRowKey = string | number | null
+  export interface RadioConfig<D = any> {
+    strict?: boolean
+    visibleMethod?: (params: {
+      $list: VxeListConstructor
+      row: D
+    }) => boolean
+    checkMethod?: (params: {
+      $list: VxeListConstructor
+      row: D
+    }) => boolean
+    highlight?: boolean
+    showIcon?: boolean
+    trigger?: '' | 'default' | 'row'
+  }
+  export type CheckRowKeys = (string | number | null)[]
+  export type ShowCheckbox = boolean
+  export interface CheckboxConfig<D = any> {
+    showHeader?: boolean
+    headerTitle?: string | number
+    highlight?: boolean
+    visibleMethod?: (params: {
+      $list: VxeListConstructor
+      row: D
+    }) => boolean
+    checkMethod?: (params: {
+      $list: VxeListConstructor
+      row: D
+    }) => boolean
+    showIcon?: boolean
+    trigger?: '' | 'default' | 'row'
+  }
+
+  export interface RowConfig<D = any> {
+    /**
+     * 是否需要为每一行的 VNode 设置 key 属性
+     */
+    useKey?: boolean
+    /**
+     * 自定义行数据唯一主键的字段名（默认自动生成）
+     */
+    keyField?: string
+    /**
+     * 显示字段
+     */
+    contentField?: string
+    /**
+     * 每一行的高度
+     */
+    height?: number | string
+    /**
+     * 给每一行的附加 className
+     */
+    className?: string | ((params: { row: D, $list: VxeListConstructor }) => string)
+    /**
+     * 当鼠标移到每一行时，是否要高亮当前头
+     */
+    isHover?: boolean
+    isCurrent?: boolean
+    padding?: boolean
+    currentMethod?: (params: { row: D }) => boolean
+  }
+
+  /**
+   * 拖拽排序配置项
+   */
+  export interface DragConfig<D = any>{
+    /**
+     * 是否启用
+     */
+    enabled?: boolean
+    /**
+     * 自定义图标
+     */
+    icon?: string
+    /**
+     * 是否显示拖拽按钮图标
+     */
+    showIcon?: boolean
+    /**
+     * 显示拖拽提示，拖拽过程中显示信息
+     */
+    showDragTip?: boolean
+    /**
+     * 触发拖拽方式
+     */
+    trigger?: 'default' | 'row' | '' | null
+    /**
+     * 是否显示拖拽辅助状态显示
+     */
+    showGuidesStatus?: boolean
+    /**
+     * 是否显示拖拽动画，启用后由数据量的大小来影响渲染性能
+     */
+    animation?: boolean
+    /**
+     * 是否禁用拖拽按钮
+     */
+    disabledMethod?(params: {
+      $list: VxeListConstructor
+      row: D
+    }): boolean
+    /**
+     * 是否显示拖拽按钮
+     */
+    visibleMethod?(params: {
+      $list: VxeListConstructor
+      row: D
+    }): boolean
+    /**
+     * 自定义提示内容
+     */
+    tooltipMethod?(params: {
+      $list: VxeListConstructor
+      row: D
+    }): string | number | null
+    /**
+     * 拖拽开始时是否允许行拖拽调整顺序的方法，该方法的返回值用来决定是否允许被拖拽
+     */
+    dragStartMethod?(params: VxeListDefines.RowDragstartEventParams<D>): boolean
+    /**
+     * 拖拽结束时是否允许行拖拽调整顺序的方法，该方法的返回值用来决定是否允许被拖拽调整顺序
+     */
+    dragEndMethod?(params: Omit<VxeListDefines.RowDragendEventParams<D>, '_index'>): Promise<boolean> | boolean
+  }
+
   export interface VirtualYConfig {
     /**
      * 指定大于指定行时自动启动纵向虚拟滚动，如果为 0 则总是启用，如果为 -1 则关闭
@@ -35,7 +162,7 @@ export namespace VxeListPropTypes {
      */
     oSize?: number
     /**
-     * 指定列表项的 className
+     * 指定行的 className
      */
     sItem?: string
     /**
@@ -58,7 +185,7 @@ export namespace VxeListPropTypes {
      */
     oSize?: number
     /**
-     * 指定列表项的 className
+     * 指定行的 className
      */
     sItem?: string
     /**
@@ -77,6 +204,14 @@ export interface VxeListProps<D = any> {
   autoResize?: VxeListPropTypes.AutoResize
   syncResize?: VxeListPropTypes.SyncResize
   className?: VxeListPropTypes.ClassName
+  showRadio?: VxeListPropTypes.ShowRadio
+  checkRowKey?: VxeListPropTypes.CheckRowKey
+  radioConfig?: VxeListPropTypes.RadioConfig
+  showCheckbox?: VxeListPropTypes.ShowCheckbox
+  checkRowKeys?: VxeListPropTypes.CheckRowKeys
+  checkboxConfig?: VxeListPropTypes.CheckboxConfig
+  rowConfig?: VxeListPropTypes.RowConfig
+  dragConfig?: VxeListPropTypes.DragConfig
   virtualYConfig?: VxeListPropTypes.VirtualYConfig
 
   /**
@@ -93,16 +228,27 @@ export interface VxeListPrivateComputed extends ListPrivateComputed { }
 export interface ListReactData {
   scrollYLoad: boolean
   bodyHeight: number
+  headHeight: number
+  footHeight: number
   customHeight: number
   customMaxHeight: number
   parentHeight: number
   topSpaceHeight: number
-  items: any[]
+  rowList: any[]
+  selectRadioRow: any
+  currRowFlag: number
+  updateCheckboxFlag: number
+  isAllChecked: boolean
+  isAllIndeterminate: boolean
+
+  dragRow: any
+  dragTipText: string
 }
 
 export interface ListInternalData {
   resizeObserver: ResizeObserver | undefined
   fullData: any[]
+  fullKeyMaps: Record<string, any>
   lastScrollLeft: number
   lastScrollTop: number
   scrollYStore: {
@@ -112,27 +258,33 @@ export interface ListInternalData {
     offsetSize: number
     rowHeight: number
   }
+  currentRow: any
+  selectCheckboxMaps: Record<string, any>
+
+  prevDragRow?: any
+  prevDragPos?: 'top' | 'bottom' | ''
 }
 
-export interface ListMethods {
+export interface ListMethods<D = any> {
   dispatchEvent(type: ValueOf<VxeListEmits>, params: Record<string, any>, evnt: Event | null): void
   /**
    * 加载数据
    * @param data 列表数据
    */
   loadData(data: any[]): Promise<any>
-
   /**
    * 加载数据
    * @param data 列表数据
    */
   reloadData(data: any[]): Promise<any>
-
+  /**
+   * 获取列表的全量数据
+   */
+  getFullData(): D[]
   /**
    * 重新计算列表
    */
   recalculate(): Promise<void>
-
   /**
    * 如果有滚动条，则滚动到对应的位置
    */
@@ -140,24 +292,153 @@ export interface ListMethods {
     top?: number | null
     left?: number | null
   } | number | null | undefined, y?: number | null): Promise<void>
-
   /**
    * 刷新滚动操作，手动同步滚动相关位置
    */
   refreshScroll(): Promise<void>
-
   /**
    * 手动清除滚动相关信息，还原到初始状态
    */
   clearScroll(): Promise<void>
+  /**
+   * 刷新滚动操作，手动同步滚动相关位置
+   */
+  refreshScroll(): Promise<void>
+  /**
+   * 手动清除滚动相关信息，还原到初始状态
+   */
+  clearScroll(): Promise<void>
+  /**
+   * 获取主键
+   */
+  getRowKey(row: D): string
+  /**
+   * 判断主键是否相同
+   */
+  eqRowKey(rowKey1: string | number | null | undefined, rowKey2: string | number | null | undefined): boolean
+  /**
+   * 判断行是否相同
+   */
+  eqRow(row1: D, row2: D): boolean
+  /**
+   * 根据行判断主键是否相同
+   */
+  eqRowByKey(row1: D, rowKey2: string | number | null | undefined): boolean
+  /**
+   * 根据行查找
+   */
+  findRow(list: D[], row: D): D
+  /**
+   * 根据主键查找
+   */
+  findRowByKey(list: D[], rowKey: string | number | null | undefined): D
+  /**
+   * 根据行查找索引
+   */
+  findRowIndexOf(list: D[], row: D): number
+  /**
+   * 根据主键查找索引
+   */
+  findRowIndexOfByKey(list: D[], rowKey: string | number | null | undefined): number
+  /**
+   * 根据主键判断单选框行是否选中
+   */
+  isCheckedByRadioRowKey(rowKey: string | number | null | undefined): boolean
+  /**
+   * 判断单选框行是否选中
+   */
+  isCheckedByRadioRow(row: D): boolean
+  /**
+   * 根据主键判断复选框行是否选中
+   */
+  isCheckedByCheckboxRowKey(rowKey: string | number | null | undefined): boolean
+  /**
+   * 判断复选框行是否选中
+   */
+  isCheckedByCheckboxRow(row: D): boolean
+  /**
+   * 只对 row-config.isCurrent 有效，设置已选的当前行
+   */
+  setCurrentRow(row: D): Promise<void>
+  /**
+   * 只对 show-radio 有效，根据主键设置当前行
+   */
+  setCurrentRowByKey(rowKey: string | number | null | undefined): Promise<void>
+  /**
+   * 只对 show-radio 有效，获取当前行已选的行
+   */
+  getCurrentRow(): D | null
+  /**
+   * 只对 show-radio 有效，获取当前行已选的主键
+   */
+  getCurrentRowKey(): string | number | null
+  /**
+   * 只对 show-radio 有效，手动清空当前行
+   */
+  clearCurrentRow(): Promise<void>
+  /**
+   * 只对 show-radio 有效，设置单选框已选的行
+   */
+  setRadioRow(row: D): Promise<void>
+  /**
+   * 只对 show-radio 有效，根据主键设置单选
+   */
+  setRadioRowByKey(rowKey: string | number | null | undefined): Promise<void>
+  /**
+   * 只对 show-radio 有效，获取单选框已选的行
+   */
+  getRadioRow(): D | null
+  /**
+   * 只对 show-radio 有效，获取单选框已选的主键
+   */
+  getRadioRowKey(): string | number | null
+  /**
+   * 只对 show-radio 有效，手动清空单选框
+   */
+  clearRadioRow(): Promise<void>
+  /**
+   * 只对 show-checkbox 有效，设置单选框已选的行
+   */
+  setCheckboxRow(rows: D | D[], checked: boolean): Promise<void>
+  /**
+   * 只对 show-checkbox 有效，根据主键设置单选
+   */
+  setCheckboxRowByKey(rowKeys: string | number | null | undefined | (string | number | null | undefined)[], checked: boolean): Promise<void>
+  /**
+   * 只对 show-checkbox 有效，获取复选框已选的行
+   */
+  getCheckboxRows(): D[]
+  /**
+   * 只对 show-checkbox 有效，获取复选框已选的主键
+   */
+  getCheckboxRowKeys(): (string | number)[]
+  /**
+   * 只对 show-checkbox 有效，手动清空复选框
+   */
+  clearCheckboxRow(): Promise<void>
+  /**
+   * 只对 show-checkbox 有效，设置所有行的选中状态
+   */
+  setAllCheckboxRow(checked: boolean): Promise<void>
 }
-export interface VxeListMethods extends ListMethods { }
+export interface VxeListMethods<D = any> extends ListMethods<D> { }
 
-export interface ListPrivateMethods { }
-export interface VxeListPrivateMethods extends ListPrivateMethods { }
+export interface ListPrivateMethods<D = any> {}
+export interface VxeListPrivateMethods<D = any> extends ListPrivateMethods<D> { }
 
 export type VxeListEmits = [
-  'scroll'
+  'update:checkRowKey',
+  'update:checkRowKeys',
+  'row-click',
+  'row-dblclick',
+  'current-change',
+  'radio-change',
+  'checkbox-change',
+  'checkbox-all',
+  'scroll',
+  'row-dragstart',
+  'row-dragover',
+  'row-dragend'
 ]
 
 export namespace VxeListDefines {
@@ -165,20 +446,66 @@ export namespace VxeListDefines {
     $list: VxeListConstructor
   }
 
+  export interface RowClickParams<D = any> {
+    row: D
+  }
+  export interface RowClickEventParams<D = any> extends ListEventParams, RowClickParams<D> { }
+
+  export interface RowDblclickEventParams<D = any> extends RowClickEventParams<D> { }
+
+  export interface RowDragstartEventParams<D = any> {
+    row: D
+  }
+
+  export interface RowDragoverEventParams<D = any> {
+    oldRow: D
+    targetRow: D
+    dragRow: D
+    dragPos: 'top' | 'bottom'
+    offsetIndex: 0 | 1
+  }
+
+  export interface RowDragendEventParams<D = any> {
+    newRow: D
+    oldRow: D
+    dragRow: D
+    dragPos: 'top' | 'bottom'
+    offsetIndex: 0 | 1
+    _index: {
+      newIndex: number
+      oldIndex: number
+    }
+  }
+
   export interface ScrollParams { }
   export interface ScrollEventParams extends ListEventParams, ScrollParams { }
 }
 
-export type VxeListEventProps = {
+export type VxeListEventProps<D = any> = {
+  onRowClick?: VxeListEvents.RowClick<D>
+  onRowDblclick?: VxeListEvents.RowDblclick<D>
   onScroll?: VxeListEvents.Scroll
+  onRowDragstart?: VxeListEvents.RowDragstart<D>
+  onRowDragover?: VxeListEvents.RowDragover<D>
+  onRowDragend?: VxeListEvents.RowDragend<D>
 }
 
-export interface VxeListListeners {
+export interface VxeListListeners<D = any> {
+  rowClick?: VxeListEvents.RowClick<D>
+  rowDblclick?: VxeListEvents.RowDblclick<D>
   scroll?: VxeListEvents.Scroll
+  rowDragstart?: VxeListEvents.RowDragstart<D>
+  rowDragover?: VxeListEvents.RowDragover<D>
+  rowDragend?: VxeListEvents.RowDragend<D>
 }
 
 export namespace VxeListEvents {
+  export type RowClick<D = any> = (params: VxeListDefines.RowClickEventParams<D>) => void
+  export type RowDblclick<D = any> = (params: VxeListDefines.RowDblclickEventParams<D>) => void
   export type Scroll = (params: VxeListDefines.ScrollEventParams) => void
+  export type RowDragstart<D = any> = (params: VxeListDefines.RowDragstartEventParams<D>) => void
+  export type RowDragover<D = any> = (params: VxeListDefines.RowDragoverEventParams<D>) => void
+  export type RowDragend<D = any> = (params: VxeListDefines.RowDragendEventParams<D>) => void
 }
 
 export namespace VxeListSlotTypes {
@@ -186,10 +513,23 @@ export namespace VxeListSlotTypes {
     $list: VxeListConstructor
     items: any[]
   }
+  export interface HeaderSlotParams extends DefaultSlotParams {}
+  export interface FooterSlotParams extends DefaultSlotParams {}
+
+  export interface ContentSlotParams<D = any> {
+    row: D
+  }
+  export interface DragSlotParams<D = any> {
+    row: D
+  }
 }
 
 export interface VxeListSlots {
   default?: (params: VxeListSlotTypes.DefaultSlotParams) => any
+  header?:(params: VxeListSlotTypes.HeaderSlotParams) => any
+  footer?:(params: VxeListSlotTypes.FooterSlotParams) => any
+  content?:(params: VxeListSlotTypes.ContentSlotParams) => any
+  tip?:(params: VxeListSlotTypes.DragSlotParams) => any
 }
 
 export const List: typeof VxeList

package/types/components/pulldown.d.ts

@@ -34,6 +34,7 @@ export namespace VxePulldownPropTypes {
     label?: string | number
     value?: string | number
     disabled?: string | number
+    [key: string]: any
   }
   export type Options = Option[]
   export type ClassName = string | ((params: { $pulldown: VxePulldownConstructor }) => string)

package/types/components/table-transfer.d.ts

@@ -0,0 +1,77 @@
+import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentEventParams, VxeComponentSizeType } from '@vxe-ui/core'
+
+/* eslint-disable @typescript-eslint/no-empty-interface,no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeTableTransfer: DefineVxeComponentApp<VxeTableTransferProps, VxeTableTransferEventProps, VxeTableTransferSlots, VxeTableTransferMethods>
+export type VxeTableTransferComponent = DefineVxeComponentOptions<VxeTableTransferProps>
+
+export type VxeTableTransferInstance = DefineVxeComponentInstance<{
+  reactData: TableTransferReactData
+  internalData: TableTransferInternalData
+}, VxeTableTransferProps, VxeTableTransferPrivateComputed, VxeTableTransferMethods>
+
+export type VxeTableTransferConstructor = VxeTableTransferInstance
+
+export interface TableTransferPrivateRef {
+}
+export interface VxeTableTransferPrivateRef extends TableTransferPrivateRef { }
+
+export namespace VxeTableTransferPropTypes {
+  export type Size = VxeComponentSizeType
+  export type ModelValue = any[]
+  export interface Option {
+    value?: string | number
+    label?: string | number
+    children?: Option[]
+
+    [key: string]: any
+  }
+  export type Options<D = Option> = D[]
+}
+
+export interface VxeTableTransferProps {
+  size?: VxeTableTransferPropTypes.Size
+  modelValue?: VxeTableTransferPropTypes.ModelValue
+  options?: VxeTableTransferPropTypes.Options
+}
+
+export interface TableTransferPrivateComputed {
+}
+export interface VxeTableTransferPrivateComputed extends TableTransferPrivateComputed { }
+
+export interface TableTransferReactData {
+}
+export interface TableTransferInternalData {
+}
+
+export interface TableTransferMethods {
+}
+export interface VxeTableTransferMethods extends TableTransferMethods { }
+
+export interface TableTransferPrivateMethods { }
+export interface VxeTableTransferPrivateMethods extends TableTransferPrivateMethods { }
+
+export type VxeTableTransferEmits = []
+
+export namespace VxeTableTransferDefines {
+  export interface TableTransferEventParams extends VxeComponentEventParams {
+    $tableTransfer: VxeTableTransferConstructor
+  }
+}
+
+export type VxeTableTransferEventProps = {}
+
+export interface VxeTableTransferListeners { }
+
+export namespace VxeTableTransferEvents { }
+
+export namespace VxeTableTransferSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeTableTransferSlots {
+  default?: (params: VxeTableTransferSlotTypes.DefaultSlotParams) => any
+}
+
+export const TableTransfer: typeof VxeTableTransfer
+export default VxeTableTransfer

package/types/components/table.d.ts

@@ -1791,6 +1791,10 @@ export namespace VxeTablePropTypes {
     zIndex?: number
     transfer?: boolean
     destroyOnClose?: boolean
+    /**
+     * 菜单宽度
+     */
+    width?: number | string
     /**
      * 该函数的返回值用来决定是否允许显示右键菜单（对于需要对菜单进行权限控制时可能会用到）
      */

package/types/components/transfer.d.ts

@@ -0,0 +1,77 @@
+import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentEventParams, VxeComponentSizeType } from '@vxe-ui/core'
+
+/* eslint-disable @typescript-eslint/no-empty-interface,no-use-before-define,@typescript-eslint/ban-types */
+
+export declare const VxeTransfer: DefineVxeComponentApp<VxeTransferProps, VxeTransferEventProps, VxeTransferSlots, VxeTransferMethods>
+export type VxeTransferComponent = DefineVxeComponentOptions<VxeTransferProps>
+
+export type VxeTransferInstance = DefineVxeComponentInstance<{
+  reactData: TransferReactData
+  internalData: TransferInternalData
+}, VxeTransferProps, VxeTransferPrivateComputed, VxeTransferMethods>
+
+export type VxeTransferConstructor = VxeTransferInstance
+
+export interface TransferPrivateRef {
+}
+export interface VxeTransferPrivateRef extends TransferPrivateRef { }
+
+export namespace VxeTransferPropTypes {
+  export type Size = VxeComponentSizeType
+  export type ModelValue = any[]
+  export interface Option {
+    value?: string | number
+    label?: string | number
+    children?: Option[]
+
+    [key: string]: any
+  }
+  export type Options<D = Option> = D[]
+}
+
+export interface VxeTransferProps {
+  size?: VxeTransferPropTypes.Size
+  modelValue?: VxeTransferPropTypes.ModelValue
+  options?: VxeTransferPropTypes.Options
+}
+
+export interface TransferPrivateComputed {
+}
+export interface VxeTransferPrivateComputed extends TransferPrivateComputed { }
+
+export interface TransferReactData {
+}
+export interface TransferInternalData {
+}
+
+export interface TransferMethods {
+}
+export interface VxeTransferMethods extends TransferMethods { }
+
+export interface TransferPrivateMethods { }
+export interface VxeTransferPrivateMethods extends TransferPrivateMethods { }
+
+export type VxeTransferEmits = []
+
+export namespace VxeTransferDefines {
+  export interface TransferEventParams extends VxeComponentEventParams {
+    $transfer: VxeTransferConstructor
+  }
+}
+
+export type VxeTransferEventProps = {}
+
+export interface VxeTransferListeners { }
+
+export namespace VxeTransferEvents { }
+
+export namespace VxeTransferSlotTypes {
+  export interface DefaultSlotParams {}
+}
+
+export interface VxeTransferSlots {
+  default?: (params: VxeTransferSlotTypes.DefaultSlotParams) => any
+}
+
+export const Transfer: typeof VxeTransfer
+export default VxeTransfer

package/types/components/tree-select.d.ts

@@ -104,7 +104,9 @@ export namespace VxeTreeSelectPropTypes {
   }
 
   export type ShowRadio = boolean
+  export interface RadioConfig<D = any> extends VxeTreePropTypes.RadioConfig<D> {}
   export type ShowCheckbox = boolean
+  export interface CheckboxConfig<D = any> extends VxeTreePropTypes.CheckboxConfig<D> {}
 
   export type Transfer = boolean
   export interface PopupConfig {
@@ -198,7 +200,9 @@ export interface VxeTreeSelectProps<D = any> {
   remote?: VxeTreeSelectPropTypes.Remote
   remoteConfig?: VxeTreeSelectPropTypes.RemoteConfig
   showRadio?: VxeTreeSelectPropTypes.ShowRadio
+  radioConfig?: VxeTreeSelectPropTypes.RadioConfig
   showCheckbox?: VxeTreeSelectPropTypes.ShowCheckbox
+  checkboxConfig?: VxeTreeSelectPropTypes.CheckboxConfig
   transfer?: VxeTreeSelectPropTypes.Transfer
   popupConfig?: VxeTreeSelectPropTypes.PopupConfig
   treeConfig?: VxeTreeSelectPropTypes.TreeConfig<D>

package/types/components/tree.d.ts

@@ -623,7 +623,7 @@ export interface TreePrivateMethods {
   /**
    * @private
    */
-  findNodeIndexOf(list: any[], row: any): number
+  findNodeIndexOf(list: any[], node: any): number
   /**
    * @private
    */