vxe-pc-ui 3.2.9 → 3.2.11

package/types/components/table.d.ts

@@ -304,6 +304,9 @@ export namespace VxeTablePropTypes {
      * 当鼠标点击行时，是否要高亮当前行
      */
     isCurrent?: boolean
+    /**
+     * 是否允许高亮当前行的方法，该方法的返回值用来决定这一行是否可以高亮当前行
+     */
     currentMethod?(params: {
       row: D
     }): boolean
@@ -319,9 +322,27 @@ export namespace VxeTablePropTypes {
      * 只对 show-overflow 有效，每一行的高度
      */
     height?: number
+    /**
+     * 是否启用行拖拽排序
+     */
+    drag?: boolean
+    /**
+     * 拖拽开始时是否允许行拖拽调整顺序的方法，该方法的返回值用来决定是否允许被拖拽
+     */
+    dragStartMethod?(params: VxeTableDefines.RowDragstartEventParams<D>): boolean
+    /**
+     * 拖拽结束时是否允许行拖拽调整顺序的方法，该方法的返回值用来决定是否允许被拖拽调整顺序
+     */
+    dragEndMethod?(params: Omit<VxeTableDefines.RowDragendEventParams<D>, '_index'>): Promise<boolean> | boolean
   }
   export interface RowOpts<D = any> extends RowConfig<D> { }
 
+  /**
+   * 当前行配置项
+   */
+  export interface CurrentConfig<D = any>{
+  }
+
   /**
    * 单元格配置项
    */
@@ -332,6 +353,13 @@ export namespace VxeTablePropTypes {
     verticalAlign?: '' | 'top' | 'center'
   }
 
+  /**
+   * 可拖拽配置项
+   */
+  export interface DragConfig<D = any>{
+    showIcon?: boolean
+  }
+
   /**
    * 自定义列配置项
    */
@@ -1918,6 +1946,14 @@ export interface VxeTableProps<D = any> {
    * 单元格配置信息
    */
   cellConfig?: VxeTablePropTypes.CellConfig<D>
+  /**
+   * 当前行配置项
+   */
+  currentConfig?: VxeTablePropTypes.CurrentConfig<D>
+  /**
+   * 当前行配置项
+   */
+  dragConfig?: VxeTablePropTypes.DragConfig<D>
   /**
    * 个性化信息配置项
    */
@@ -2106,6 +2142,7 @@ export interface TablePrivateComputed<D = any> {
   computeColumnOpts: VxeTablePropTypes.ColumnOpts
   computeCellOpts: VxeTablePropTypes.CellConfig
   computeRowOpts: VxeTablePropTypes.RowOpts
+  computeDragOpts: VxeTablePropTypes.DragConfig
   computeResizeOpts: VxeTablePropTypes.ResizeOpts
   computeResizableOpts: VxeTablePropTypes.ResizableOpts<D>
   computeSeqOpts: VxeTablePropTypes.SeqOpts<D>
@@ -2406,6 +2443,11 @@ export interface TableReactData<D = any> {
     isFooter: boolean
   },
   scrollVMLoading: boolean
+
+  isDragRowMove: boolean
+  dragRow: any
+  dragTipText: string
+
   _isResize: boolean
   _isLoading: boolean
 }
@@ -2483,6 +2525,9 @@ export interface TableInternalData<D = any> {
   columnStatusMaps: Record<string, boolean>
   // 行选取状态
   rowStatusMaps: Record<string, boolean>
+  // 上一个拖动的行
+  prevDragRow: any
+  prevDragPos?: 'top' | 'bottom' | ''
 
   // 特殊标识
   inited: boolean
@@ -3228,6 +3273,11 @@ export interface TablePrivateMethods<D = any> {
   triggerRowExpandEvent(evnt: Event, params: VxeTableDefines.CellRenderBodyParams<any>): void
   triggerTreeExpandEvent(evnt: Event, params: VxeTableDefines.CellRenderBodyParams<any>): void
   triggerSortEvent(evnt: Event, column: VxeTableDefines.ColumnInfo<any>, order: VxeTablePropTypes.SortOrder): void
+  handleRowDragDragstartEvent (evnt: DragEvent): void
+  handleRowDragDragendEvent(evnt: DragEvent): void
+  handleRowDragDragoverEvent(evnt: DragEvent,): void
+  handleCellDragMousedownEvent (evnt: MouseEvent): void
+  handleCellDragMouseupEvent (evnt: MouseEvent): void
   handleScrollEvent(evnt: Event, isRollY: boolean, isRollX: boolean, params: {
     type: string
     fixed: VxeColumnPropTypes.Fixed
@@ -3240,8 +3290,8 @@ export interface TablePrivateMethods<D = any> {
   updateScrollYStatus(fullData?: any[]): boolean
   updateScrollXSpace(): void
   updateScrollYSpace(): void
-  updateScrollXData(): void
-  updateScrollYData(): void
+  updateScrollXData(): Promise<any>
+  updateScrollYData(): Promise<any>
   checkScrolling(): void
   updateZindex(): void
   handleCheckedCheckboxRow(rows: any, value: boolean, isForce?: boolean): Promise<any>
@@ -3299,6 +3349,9 @@ export type VxeTableEmits = [
   'toggle-tree-expand',
   'menu-click',
   'edit-closed',
+  'row-dragstart',
+  'row-dragover',
+  'row-dragend',
 
   'edit-actived', // 已废弃
 
@@ -3415,6 +3468,7 @@ export namespace VxeTableDefines {
     filterMethod: VxeColumnPropTypes.FilterMethod<D>
     filterRender: VxeColumnPropTypes.FilterRender
     treeNode: VxeColumnPropTypes.TreeNode
+    dragSort: VxeColumnPropTypes.DragSort
     visible: VxeColumnPropTypes.Visible
     exportMethod: VxeColumnPropTypes.ExportMethod<D>
     footerExportMethod: VxeColumnPropTypes.FooterExportMethod
@@ -3907,6 +3961,26 @@ export namespace VxeTableDefines {
   }
   export interface CustomEventParams<D = any> extends TableEventParams<D>, CustomParams { }
 
+  export interface RowDragstartEventParams<D = any> {
+    row: D
+    column: VxeTableDefines.ColumnInfo<D>
+  }
+
+  export interface RowDragoverEventParams<D = any> {
+    oldRow: D
+    targetRow: D
+    dragPos: 'top' | 'bottom'
+  }
+
+  export interface RowDragendEventParams<D = any> {
+    newRow: D
+    oldRow: D
+    _index: {
+      newIndex: number
+      oldIndex: number
+    }
+  }
+
   export interface VxeTableCustomStoreObj {
     btnEl: HTMLDivElement | null
     isAll: boolean
@@ -3941,18 +4015,20 @@ export namespace VxeTableDefines {
     datas: any[]
     columns: VxeTableDefines.ColumnInfo[]
     colgroups: VxeTableDefines.ColumnInfo[][]
+
+    [key: string]: any
   }
 
   export interface ImportSlotParams {
     $table: VxeTableConstructor
-    $grid: VxeGridConstructor | bull | undefined
+    $grid: VxeGridConstructor | null | undefined
     options: VxeTablePropTypes.ImportConfig
     params: Record<string, any>
   }
 
   export interface ExtortSlotParams {
     $table: VxeTableConstructor
-    $grid: VxeGridConstructor | bull | undefined
+    $grid: VxeGridConstructor | null | undefined
     options: VxeTablePropTypes.ExportConfig
     columns: VxeTableDefines.ColumnInfo[]
     params: Record<string, any>
@@ -3960,12 +4036,16 @@ export namespace VxeTableDefines {
 
   export interface PrintSlotParams {
     $table: VxeTableConstructor
-    $grid: VxeGridConstructor | bull | undefined
+    $grid: VxeGridConstructor | null | undefined
     options: VxeTablePropTypes.PrintConfig
     columns: VxeTableDefines.ColumnInfo[]
     params: Record<string, any>
   }
 
+  export interface MenuSlotParams {
+
+  }
+
   export interface ValidatorRule<D = any> {
     /**
      * 是否必填
@@ -4062,6 +4142,9 @@ export namespace VxeTableDefines {
     disabled?: boolean
     children?: MenuChildOption[]
     params?: any
+    slots?: {
+      content?: string | ((params: VxeTableDefines.MenuSlotParams) => VxeComponentSlotType | VxeComponentSlotType[])
+    }
     [key: string]: any
   }
   export interface MenuChildOption {
@@ -4091,6 +4174,9 @@ export namespace VxeTableDefines {
     visible?: boolean
     disabled?: boolean
     params?: any
+    slots?: {
+      content?: string | ((params: VxeTableDefines.MenuSlotParams) => VxeComponentSlotType | VxeComponentSlotType[])
+    }
     [key: string]: any
   }
 
@@ -4145,6 +4231,9 @@ export interface VxeTableEventProps<D = any> {
   onValidError?: VxeTableEvents.ValidError<D>
   onScroll?: VxeTableEvents.Scroll<D>
   onCustom?: VxeTableEvents.Custom<D>
+  onRowDragstart?: VxeTableEvents.RowDragstart<D>
+  onRowDragover?: VxeTableEvents.RowDragover<D>
+  onRowDragend?: VxeTableEvents.RowDragend<D>
 
   /**
    * 已废弃，请使用 onEditActivated
@@ -4210,6 +4299,9 @@ export interface VxeTableListeners<D = any> {
    * 如果与工具栏关联，在自定义列按钮被手动点击后会触发该事件
    */
   custom?: VxeTableEvents.Custom<D>
+  rowDragstart?: VxeTableEvents.RowDragstart<D>
+  rowDragover?: VxeTableEvents.RowDragover<D>
+  rowDragend?: VxeTableEvents.RowDragend<D>
 
   /**
    * 已废弃，请使用 editActivated
@@ -4258,6 +4350,9 @@ export namespace VxeTableEvents {
   export type ValidError<D = VxeTablePropTypes.Row> = (params: VxeTableDefines.ValidErrorEventParams<D>) => void
   export type Scroll<D = VxeTablePropTypes.Row> = (params: VxeTableDefines.ScrollEventParams<D>) => void
   export type Custom<D = VxeTablePropTypes.Row> = (params: VxeTableDefines.CustomEventParams<D>) => void
+  export type RowDragstart<D = VxeTablePropTypes.Row> = (params: VxeTableDefines.RowDragstartEventParams<D>) => void
+  export type RowDragover<D = VxeTablePropTypes.Row> = (params: VxeTableDefines.RowDragoverEventParams<D>) => void
+  export type RowDragend<D = VxeTablePropTypes.Row> = (params: VxeTableDefines.RowDragendEventParams<D>) => void
 
   /**
    * 已废弃，请使用 EditActivated