vxe-pc-ui 3.8.13 → 3.8.15

package/types/components/gantt.d.ts

@@ -1,68 +1,244 @@
-import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentEventParams, ValueOf, VxeComponentSizeType } from '@vxe-ui/core'
+import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentEventParams, ValueOf } from '@vxe-ui/core'
+import { GridPrivateRef, VxeGridProps, VxeGridPropTypes, GridPrivateComputed, GridReactData, GridInternalData, GridMethods, GridPrivateMethods, VxeGridEmits, VxeGridSlots, VxeGridListeners, VxeGridEventProps, VxeGridMethods } from './grid'
+import { VxeTablePropTypes } from './table'
 
-/* eslint-disable @typescript-eslint/no-empty-interface,no-use-before-define,@typescript-eslint/ban-types */
+/* eslint-disable no-use-before-define,@typescript-eslint/ban-types,@typescript-eslint/no-unused-vars */
 
 export declare const VxeGantt: DefineVxeComponentApp<VxeGanttProps, VxeGanttEventProps, VxeGanttSlots, VxeGanttMethods>
 export type VxeGanttComponent = DefineVxeComponentOptions<VxeGanttProps>
 
-export type VxeGanttInstance = DefineVxeComponentInstance<{
-  reactData: GanttReactData
+export type VxeGanttInstance<D = any> = DefineVxeComponentInstance<{
+  reactData: GanttReactData<D>
   internalData: GanttInternalData
-}, VxeGanttProps, VxeGanttPrivateComputed, VxeGanttMethods>
+}, VxeGanttProps<D>, VxeGanttPrivateComputed<D>, VxeGanttMethods<D>>
 
-export type VxeGanttConstructor = VxeGanttInstance
+export type VxeGanttConstructor<D = any> = VxeGanttInstance<D>
 
-export interface GanttPrivateRef {
+export interface GanttPrivateRef<D = any> extends GridPrivateRef<D> {
 }
-export interface VxeGanttPrivateRef extends GanttPrivateRef { }
+export interface VxeGanttPrivateRef<D = any> extends GanttPrivateRef<D> { }
 
 export namespace VxeGanttPropTypes {
-  export type Size = VxeComponentSizeType
+  export type Size = VxeGridPropTypes.Size
+  export type Layouts = VxeGanttDefines.LayoutKey[] | VxeGanttDefines.LayoutKey[][]
+  export type Column<D = any> = VxeGridPropTypes.Column<D>
+  export type Columns<D = any> = Column<D>[]
+  export interface PagerConfig extends VxeGridPropTypes.PagerConfig {}
+  export interface ProxyConfig<D = any> extends VxeGridPropTypes.ProxyConfig<D> {}
+  export interface ToolbarConfig extends VxeGridPropTypes.ToolbarConfig {}
+  export interface FormConfig extends VxeGridPropTypes.FormConfig {}
+  export interface ZoomConfig extends VxeGridPropTypes.ZoomConfig {}
+
+  export interface TaskConfig {
+    /**
+     * 标题的字段名
+     */
+    titleField?: string
+    /**
+     * 开始日期的字段名
+     */
+    startField?: string
+    /**
+     * 结束日期的字段名
+     */
+    endField?: string
+    /**
+     * 进度的字段名
+     */
+    progressField?: string
+  }
+
+  export interface TaskViewConfig<D = any> {
+    /**
+     * 视图的渲染模式
+     */
+    mode?: 'day' | 'week' | 'month' | 'quarter' | 'year'
+    /**
+     * 表格样式
+     */
+    tableStyle?: {
+      width?: number | string
+      minWidth?: number | string
+      maxWidth?: number | string
+    }
+  }
+
+  export interface TaskSplitConfig {
+    /**
+     * 是否启用
+     */
+    enabled?: boolean
+    /**
+     * 是否允许拖拽调整视图宽度
+     */
+    resize?: boolean
+    /**
+     * 是否显示左侧表格的折叠按钮
+     */
+    showCollapseTableButton?: boolean
+    /**
+     * 是否显示右侧任务的折叠按钮
+     */
+    showCollapseTaskButton?: boolean
+  }
+
+  export interface TaskBarConfig<D = any> {
+    /**
+     * 是否显示进度条
+     */
+    showProgress?: boolean
+    /**
+     * 是否在任务条显示内容
+     */
+    showContent?: boolean
+    /**
+     * 自定义任务条内容方法
+     */
+    contentMethod?(params: {
+      title: string
+      progress?: string | number
+      row: D
+    }): string | number
+    /**
+     * 任务条样式
+     */
+    barStyle?: {
+      /**
+       * 圆角
+       */
+      round?: boolean | number
+      /**
+       * 任务条的背景颜色
+       */
+      bgColor?: string
+      /**
+       * 任务条的字体颜色
+       */
+      fontColor?: string
+      /**
+       * 已完成部分任务条的背景颜色
+       */
+      completedBgColor?: string
+    }
+  }
 }
 
-export type VxeGanttProps = {
-  size?: VxeGanttPropTypes.Size
+export interface VxeGanttProps<D = any> extends Omit<VxeGridProps<D>, 'layouts'> {
+  layouts?: VxeGanttPropTypes.Layouts
+  taskConfig?: VxeGanttPropTypes.TaskConfig
+  taskViewConfig?: VxeGanttPropTypes.TaskViewConfig
+  taskSplitConfig?: VxeGanttPropTypes.TaskSplitConfig
+  taskBarConfig?: VxeGanttPropTypes.TaskBarConfig
 }
 
-export interface GanttPrivateComputed {
+export interface GanttPrivateComputed<D = any> extends GridPrivateComputed<D> {
+  computeTaskOpts: VxeGanttPropTypes.TaskConfig
+  computeTaskViewOpts: VxeGanttPropTypes.TaskViewConfig
+  computeTaskBarOpts: VxeGanttPropTypes.TaskBarConfig
+  computeTaskSplitOpts: VxeGanttPropTypes.TaskSplitConfig
+  computeTitleField: string
+  computeStartField: string
+  computeEndField: string
+  computeProgressField: string
+  computeScrollbarOpts: VxeTablePropTypes.ScrollbarConfig
+  computeScrollbarXToTop: boolean
+  computeScrollbarYToLeft: boolean
 }
-export interface VxeGanttPrivateComputed extends GanttPrivateComputed { }
+export interface VxeGanttPrivateComputed<D = any> extends GanttPrivateComputed<D> { }
 
-export interface GanttReactData {
+export interface GanttReactData<D = any> extends GridReactData<D> {
+  showLeftView: boolean
+  showRightView: boolean
 }
 
-export interface GanttInternalData {
+export interface GanttInternalData extends GridInternalData {
+  resizeTableWidth: number
 }
 
-export interface GanttMethods {
+export interface GanttMethods<D = any> extends Omit<GridMethods<D>, 'dispatchEvent'> {
   dispatchEvent(type: ValueOf<VxeGanttEmits>, params: Record<string, any>, evnt: Event | null): void
+  /**
+   * 刷新任务视图
+   */
+  refreshTaskView(): Promise<any>
 }
-export interface VxeGanttMethods extends GanttMethods { }
+export interface VxeGanttMethods<D = any> extends GanttMethods<D>, Omit<VxeGridMethods<D>, 'dispatchEvent'> { }
 
-export interface GanttPrivateMethods { }
-export interface VxeGanttPrivateMethods extends GanttPrivateMethods { }
+export interface GanttPrivateMethods extends GridPrivateMethods {
+}
+export interface VxeGanttPrivateMethods extends GanttPrivateMethods {
+  handleTaskClickEvent(evnt: MouseEvent, params: {
+    row: any
+  }): void
+}
 
-export type VxeGanttEmits = []
+export type VxeGanttEmits = [
+  ...VxeGridEmits,
+
+  'task-cell-click',
+  'task-cell-dblclick',
+  'task-bar-click',
+  'task-bar-dblclick'
+]
 
 export namespace VxeGanttDefines {
-  export interface GanttEventParams extends VxeComponentEventParams {
-    $gantt: VxeGanttConstructor
+  export interface GanttEventParams<D = any> extends VxeComponentEventParams {
+    $gantt: VxeGanttConstructor<D>
+  }
+
+  export type LayoutKey = 'Form' | 'Toolbar' | 'Top' | 'Gantt' | 'Bottom' | 'Pager'
+
+  export interface GroupHeaderColumn<D = any> extends VxeGanttPropTypes.Column<D> {
+    children: VxeGanttPropTypes.Column<D>[]
+  }
+
+  export interface RowCacheItem<D = any> {
+    row: D
+    rowid: string
+    oLeftSize: number
+    oWidthSize: number
+  }
+
+  export interface TaskCellClickParams<D = any> {
+    row: D
   }
+  export interface TaskCellClickEventParams<D = any> extends TaskCellClickParams<D>, GanttEventParams {}
+  export interface TaskCellDblClickEventParams<D = any> extends TaskCellClickEventParams<D> {}
+  export interface TaskBarClickEventParams<D = any> extends TaskCellClickEventParams<D> {}
+  export interface TaskBarDblClickEventParams<D = any> extends TaskCellClickEventParams<D> {}
 }
 
-export type VxeGanttEventProps = {}
+export interface VxeGanttEventProps<D = any> extends VxeGridEventProps<D> {
+  onTaskCellClick?: VxeGanttEvents.TaskCellClick<D>
+  onTaskCellDblClick?: VxeGanttEvents.TaskCellDblClick<D>
+  onTaskBarClick?: VxeGanttEvents.TaskBarClick<D>
+  onTaskBarDblClick?: VxeGanttEvents.TaskBarDblClick<D>
+}
 
-export interface VxeGanttListeners { }
+export interface VxeGanttListeners<D = any> extends VxeGridListeners<D> {
+  taskCellClick?: VxeGanttEvents.TaskCellClick<D>
+  taskCellDblClick?: VxeGanttEvents.TaskCellDblClick<D>
+  taskBarClick?: VxeGanttEvents.TaskBarClick<D>
+  taskBarDblClick?: VxeGanttEvents.TaskBarDblClick<D>
+}
 
-export namespace VxeGanttEvents { }
+export namespace VxeGanttEvents {
+  export type TaskCellClick<D = any> = (params: VxeGanttDefines.TaskCellClickEventParams<D>) => void
+  export type TaskCellDblClick<D = any> = (params: VxeGanttDefines.TaskCellDblClickEventParams<D>) => void
+  export type TaskBarClick<D = any> = (params: VxeGanttDefines.TaskBarClickEventParams<D>) => void
+  export type TaskBarDblClick<D = any> = (params: VxeGanttDefines.TaskBarDblClickEventParams<D>) => void
+}
 
 export namespace VxeGanttSlotTypes {
-  export interface DefaultSlotParams {}
+  export interface DefaultSlotParams<D = any> {
+    $gantt: VxeGanttConstructor<D>
+  }
 }
 
-export interface VxeGanttSlots {
-  default?: (params: VxeGanttSlotTypes.DefaultSlotParams) => any
+export interface VxeGanttSlots<D = any> extends VxeGridSlots<D> {
 }
 
+export * from './gantt-module'
+
 export const Gantt: typeof VxeGantt
 export default VxeGantt

package/types/components/grid.d.ts

@@ -6,6 +6,7 @@ import { VxeColumnPropTypes } from './column'
 import { VxePagerProps, VxePagerDefines, VxePagerSlotTypes } from './pager'
 import { VxeFormProps, VxeFormDefines } from './form'
 import { VxeFormItemPropTypes, VxeFormItemProps } from './form-item'
+import { VxeGanttConstructor } from './gantt'
 
 /* eslint-disable no-use-before-define,@typescript-eslint/ban-types,@typescript-eslint/no-unused-vars */
 
@@ -26,8 +27,7 @@ export interface VxeGridPrivateRef<D = any> extends GridPrivateRef<D> { }
 export namespace VxeGridPropTypes {
   export type Size = VxeComponentSizeType
 
-  export type LayoutKey = 'Form' | 'Toolbar' | 'Top' | 'Table' | 'Bottom' | 'Pager'
-  export type Layouts = LayoutKey[] |LayoutKey[][]
+  export type Layouts = VxeGridDefines.LayoutKey[] | VxeGridDefines.LayoutKey[][]
 
   export type Column<D = any> = VxeTableDefines.ColumnOptions<D>
   export type Columns<D = any> = Column<D>[]
@@ -69,7 +69,9 @@ export namespace VxeGridPropTypes {
   }
 
   interface ProxyAjaxQueryParams<D = any> {
-    $grid: VxeGridConstructor<D>
+    $table: VxeTableConstructor<D>
+    $grid: VxeGridConstructor<D> | null | undefined
+    $gantt: VxeGanttConstructor<D> | null | undefined
     page: ProxyAjaxQueryPageParams
     sort: ProxyAjaxQuerySortCheckedParams<D>
     sorts: ProxyAjaxQuerySortCheckedParams<D>[]
@@ -81,7 +83,8 @@ export namespace VxeGridPropTypes {
 
   interface ProxyAjaxQueryAllParams<D = any> {
     $table: VxeTableConstructor<D>
-    $grid: VxeGridConstructor<D>
+    $grid: VxeGridConstructor<D> | null | undefined
+    $gantt: VxeGanttConstructor<D> | null | undefined
     sort: ProxyAjaxQuerySortCheckedParams<D>
     sorts: ProxyAjaxQuerySortCheckedParams<D>[]
     filters: VxeTableDefines.FilterCheckedParams[]
@@ -92,14 +95,18 @@ export namespace VxeGridPropTypes {
   }
 
   interface ProxyAjaxDeleteParams<D = any> {
-    $grid: VxeGridConstructor<D>
+    $table: VxeTableConstructor<D>
+    $grid: VxeGridConstructor<D> | null | undefined
+    $gantt: VxeGanttConstructor<D> | null | undefined
     body: {
       removeRecords: D[]
     }
   }
 
   interface ProxyAjaxSaveParams<D = any> {
-    $grid: VxeGridConstructor<D>
+    $table: VxeTableConstructor<D>
+    $grid: VxeGridConstructor<D> | null | undefined
+    $gantt: VxeGanttConstructor<D> | null | undefined
     body: {
       insertRecords: D[]
       updateRecords: D[]
@@ -135,19 +142,27 @@ export namespace VxeGridPropTypes {
     response?: {
       list?: string | null | ((params: {
         data: any
-        $grid: VxeGridConstructor<D>
+        $table: VxeTableConstructor<D>
+        $grid: VxeGridConstructor<D> | null | undefined
+        $gantt: VxeGanttConstructor<D> | null | undefined
       }) => any[])
       result?: string | ((params: {
         data: any
-        $grid: VxeGridConstructor<D>
+        $table: VxeTableConstructor<D>
+        $grid: VxeGridConstructor<D> | null | undefined
+        $gantt: VxeGanttConstructor<D> | null | undefined
       }) => any[])
       total?: string | ((params: {
         data: any
-        $grid: VxeGridConstructor<D>
+        $table: VxeTableConstructor<D>
+        $grid: VxeGridConstructor<D> | null | undefined
+        $gantt: VxeGanttConstructor<D> | null | undefined
       }) => number)
       message?: string | ((params: {
         data: any
-        $grid: VxeGridConstructor<D>
+        $table: VxeTableConstructor<D>
+        $grid: VxeGridConstructor<D> | null | undefined
+        $gantt: VxeGanttConstructor<D> | null | undefined
       }) => string)
     }
     ajax?: {
@@ -318,12 +333,12 @@ export interface GridMethods<D = any> {
   /**
    * 只对 form-config 有效，对表单进行校验，返回校验结果 promise
    */
-  validateForm(): Promise<VxeFormDefines.ValidateErrorMapParams>
+  validateForm(): Promise<VxeFormDefines.ValidateErrorMapParams | void>
   /**
    * 只对 form-config 有效，对表单指定项进行校验，返回校验结果 promise
    * @param field 字段名
    */
-  validateFormField(field: VxeFormItemPropTypes.Field | VxeFormItemPropTypes.Field[] | VxeFormDefines.ItemInfo | VxeFormDefines.ItemInfo[] | null): Promise<VxeFormDefines.ValidateErrorMapParams>
+  validateFormField(field: VxeFormItemPropTypes.Field | VxeFormItemPropTypes.Field[] | VxeFormDefines.ItemInfo | VxeFormDefines.ItemInfo[] | null): Promise<VxeFormDefines.ValidateErrorMapParams | void>
   /**
    * 只对 form-config 有效，手动清除表单校验状态，如果指定 field 则清除指定的项，否则清除整个表单
    * @param field 字段名
@@ -453,9 +468,13 @@ export type VxeGridEmits = [
 
 export namespace VxeGridDefines {
   export interface GridEventParams<D = any> extends VxeComponentEventParams {
-    $grid: VxeGridConstructor<D>
+    $table: VxeTableConstructor<D>
+    $grid: VxeGridConstructor<D> | null | undefined
+    $gantt: VxeGanttConstructor<D> | null | undefined
   }
 
+  export type LayoutKey = 'Form' | 'Toolbar' | 'Top' | 'Table' | 'Bottom' | 'Pager'
+
   export interface KeydownStartEventParams<D = any> extends GridEventParams<D>, VxeTableDefines.KeydownStartEventParams<D> { }
   export interface KeydownEventParams<D = any> extends GridEventParams<D>, VxeTableDefines.KeydownEventParams<D> { }
   export interface KeydownEndEventParams<D = any> extends GridEventParams<D>, VxeTableDefines.KeydownEndEventParams<D> { }
@@ -777,6 +796,7 @@ export namespace VxeGridSlotTypes {
   export interface DefaultSlotParams<D = any> {
     $table: VxeTableConstructor<D>
     $grid: VxeGridConstructor<D> | null | undefined
+    $gantt: VxeGanttConstructor<D> | null | undefined
     rowid: string
     /**
      * 当前行对象，支持数据双向绑定
@@ -842,6 +862,7 @@ export namespace VxeGridSlotTypes {
   export interface BaseSlotParams<D = any> {
     $table: VxeTableConstructor<D>
     $grid: VxeGridConstructor<D> | null | undefined
+    $gantt: VxeGanttConstructor<D> | null | undefined
   }
   export interface EmptySlotParams<D = any> extends BaseSlotParams<D> {}
   export interface LoadingSlotParams<D = any> extends BaseSlotParams<D> {}

package/types/components/table.d.ts

@@ -9,6 +9,8 @@ import { VxeModalPropTypes } from './modal'
 import { VxeDrawerPropTypes } from './drawer'
 import { VxeToolbarConstructor, VxeToolbarInstance } from './toolbar'
 import { VxeTabsConstructor, VxeTabsPrivateMethods } from './tabs'
+import { VxeGanttConstructor } from './gantt'
+import { VxeGanttViewConstructor, VxeGanttViewInstance, VxeGanttViewPrivateMethods } from './gantt-module/gantt-view'
 
 /* eslint-disable @typescript-eslint/no-empty-interface,no-use-before-define,@typescript-eslint/ban-types,@typescript-eslint/no-unused-vars */
 
@@ -19,6 +21,7 @@ export type VxeTableInstance<D = any> = DefineVxeComponentInstance<{
   reactData: TableReactData<D>
   internalData: TableInternalData<D>
   $xeGrid: VxeGridConstructor<D> | null | undefined
+  $xeGantt: VxeGanttConstructor<D> | null | undefined
   $xeTabs: (VxeTabsConstructor & VxeTabsPrivateMethods) | null
 
   /**
@@ -2518,6 +2521,10 @@ export namespace VxeTablePropTypes {
        * 滚动条显示位置
        */
       position?: 'top' | 'bottom' | ''
+      /**
+       * 是否显示
+       */
+      visible?: boolean
     }
     /**
      * 纵向滚动条
@@ -2527,6 +2534,10 @@ export namespace VxeTablePropTypes {
        * 滚动条显示位置
        */
       position?: 'left' | 'right' | ''
+      /**
+       * 是否显示
+       */
+      visible?: boolean
     }
   }
 
@@ -3478,7 +3489,6 @@ export interface TableReactData<D = any> {
   /**
    * 行高
    * @deprecated
-   * @property
    */
   rowHeight: number
   // 表格父容器的高度
@@ -3502,6 +3512,8 @@ export interface TableReactData<D = any> {
   rowGroupColumn: VxeTableDefines.ColumnInfo<D> | null | undefined
   // 展开列信息
   expandColumn: VxeTableDefines.ColumnInfo<D> | null | undefined
+  checkboxColumn: VxeTableDefines.ColumnInfo<D> | null | undefined
+  radioColumn: VxeTableDefines.ColumnInfo<D> | null | undefined
   hasFixedColumn: boolean
   // 树节点列信息
   treeNodeColumn: any
@@ -3740,10 +3752,6 @@ export interface TableInternalData<D = any> {
   tableWidth: number
   // 表格高度
   tableHeight: number
-  // 表头高度
-  headerHeight: number
-  // 表尾高度
-  footerHeight: number
   customHeight: number
   customMinHeight: number
   customMaxHeight: number
@@ -3873,7 +3881,18 @@ export interface TableInternalData<D = any> {
   // 展开手风琴
   treeEATime?: undefined | number
 
+  // 甘特图
+  xeGanttView?: VxeGanttViewConstructor & VxeGanttViewPrivateMethods
+
+  // 表头高度
+  tHeaderHeight: number
+  // 表体高度
+  tBodyHeight: number
+  // 表尾高度
+  tFooterHeight: number
+
   // 内部属性
+  _updateStyleFlag?: boolean
   _lastResizeTime?: any
   _keyCtx?: any
   _lastCallTime?: any
@@ -4745,10 +4764,14 @@ export interface TableMethods<DT = any> {
    */
   updateCellAreas(): Promise<void>
   /**
-   * 连接工具栏
-   * @param toolbar 工具栏组件实例
+   * 已废弃，请使用 connectToolbar
+   * @deprecated
    */
   connect(toolbar: VxeToolbarConstructor | VxeToolbarInstance): Promise<void>
+  /**
+   * 连接工具栏
+   */
+  connectToolbar(toolbar: VxeToolbarConstructor | VxeToolbarInstance): Promise<void>
   /**
    * 使表格获取焦点
    */
@@ -5083,9 +5106,13 @@ export interface TablePrivateMethods<D = any> {
    * 已废弃，被 getCellElement 替换
    * @deprecated
    */
-  getCell(row: any, column: VxeTableDefines.ColumnInfo<any>): HTMLTableDataCellElement | null
+  getCell(row: any, column: VxeTableDefines.ColumnInfo<any>): HTMLTableCellElement | null
   findRowIndexOf(list: any[], row: any): number
   eqRow(row1: any, row2: any): boolean
+  /**
+   * @private
+   */
+  handleConnectGanttView($ganttView: VxeGanttViewConstructor | VxeGanttViewInstance): Promise<void>
 }
 export interface VxeTablePrivateMethods<D = any> extends TablePrivateMethods<D> { }
 

package/types/ui/commands.d.ts

@@ -1,6 +1,7 @@
 import { VxeGridConstructor } from '../components/grid'
 import { VxeToolbarPropTypes } from '../components/toolbar'
 import { VxeTableConstructor } from '../components/table'
+import { VxeGanttConstructor } from '../components/gantt'
 import { VxeDatePickerConstructor, VxeDatePickerDefines } from '../components/date-picker'
 import { VxeDateRangePickerConstructor, VxeDateRangePickerDefines } from '../components/date-range-picker'
 
@@ -46,8 +47,9 @@ declare module '@vxe-ui/core' {
     }
 
     export interface TableCommandMethodParams {
-      $grid: VxeGridConstructor | null | undefined
       $table: VxeTableConstructor
+      $grid: VxeGridConstructor | null | undefined
+      $gantt: VxeGanttConstructor | null | undefined
       button: VxeToolbarPropTypes.ButtonConfig | null | undefined
       code: string | undefined
     }