vxe-pc-ui 4.15.13 → 4.15.14

package/types/all.d.ts

@@ -115,60 +115,217 @@ import VxeGantt from './components/gantt'
 export function install (app: App, options?: VxeGlobalConfig): void
 
 interface AllComponents {
+  /**
+   * Alert 警告提示
+   */
   VxeAlert: typeof VxeAlert
+  /**
+   * Anchor 锚点
+   */
   VxeAnchor: typeof VxeAnchor
+  /**
+   * AnchorLink 锚点 - 链接
+   */
   VxeAnchorLink: typeof VxeAnchorLink
+  /**
+   * Avatar 头像
+   */
   VxeAvatar: typeof VxeAvatar
+  /**
+   * Backtop 回到顶部
+   */
   VxeBacktop: typeof VxeBacktop
+  /**
+   * Badge 微标
+   */
   VxeBadge: typeof VxeBadge
+  /**
+   * Breadcrumb 面包屑
+   */
   VxeBreadcrumb: typeof VxeBreadcrumb
+  /**
+   * BreadcrumbItem 面包屑 - 项
+   */
   VxeBreadcrumbItem: typeof VxeBreadcrumbItem
+  /**
+   * Button 按钮
+   */
   VxeButton: typeof VxeButton
+  /**
+   * Button 按钮组
+   */
   VxeButtonGroup: typeof VxeButtonGroup
+  /**
+   * Calendar 日历
+   */
   VxeCalendar: typeof VxeCalendar
+  /**
+   * Card 卡片
+   */
   VxeCard: typeof VxeCard
+  /**
+   * Carousel 轮播图
+   */
   VxeCarousel: typeof VxeCarousel
+  /**
+   * Carousel 轮播图 - 项
+   */
   VxeCarouselItem: typeof VxeCarouselItem
+  /**
+   * Cascader 级联选择
+   */
   VxeCascader: typeof VxeCascader
+  /**
+   * Checkbox 复选框
+   */
   VxeCheckbox: typeof VxeCheckbox
+  /**
+   * CheckboxButton 复选框按钮
+   */
   VxeCheckboxButton: typeof VxeCheckboxButton
+  /**
+   * CheckboxGroup 复选框组
+   */
   VxeCheckboxGroup: typeof VxeCheckboxGroup
+  /**
+   * Col 列
+   */
   VxeCol: typeof VxeCol
+  /**
+   * Collapse 折叠面板
+   */
   VxeCollapse: typeof VxeCollapse
+  /**
+   * CollapsePane 折叠面板 - 面板
+   */
   VxeCollapsePane: typeof VxeCollapsePane
+  /**
+   * ColorPicker 颜色选择
+   */
   VxeColorPicker: typeof VxeColorPicker
+  /**
+   * ContextMenu 右键菜单
+   */
   VxeContextMenu: typeof VxeContextMenu
+  /**
+   * Countdown 倒计时
+   */
   VxeCountdown: typeof VxeCountdown
+  /**
+   * DatePanel 日期面板
+   */
   VxeDatePanel: typeof VxeDatePanel
+  /**
+   * DatePicker 日期选择
+   */
   VxeDatePicker: typeof VxeDatePicker
+  /**
+   * DateRangePicker 日期范围选择
+   */
   VxeDateRangePicker: typeof VxeDateRangePicker
+  /**
+   * Drawer 抽屉
+   */
   VxeDrawer: typeof VxeDrawer
+  /**
+   * Empty 空状态
+   */
   VxeEmpty: typeof VxeEmpty
+  /**
+   * Form 表单
+   */
   VxeForm: typeof VxeForm
+  /**
+   * 已废弃，请使用 FormGroup
+   * @deprecated
+   */
   VxeFormGather: typeof VxeFormGather
+  /**
+   * FormGroup 表单 - 组
+   */
   VxeFormGroup: typeof VxeFormGroup
+  /**
+   * FormGroup 表单 - 项
+   */
   VxeFormItem: typeof VxeFormItem
+  /**
+   * Icon 图标
+   */
   VxeIcon: typeof VxeIcon
+  /**
+   * IconPicker 图标选择
+   */
   VxeIconPicker: typeof VxeIconPicker
+  /**
+   * Image 图片
+   */
   VxeImage: typeof VxeImage
+  /**
+   * ImageGroup 图片组
+   */
   VxeImageGroup: typeof VxeImageGroup
+  /**
+   * ImagePreview 图片预览
+   */
   VxeImagePreview: typeof VxeImagePreview
+  /**
+   * Input 单行输入框
+   */
   VxeInput: typeof VxeInput
+  /**
+   * LayoutAside 页面布局 - 侧边栏
+   */
   VxeLayoutAside: typeof VxeLayoutAside
+  /**
+   * LayoutBody 页面布局 - 主体
+   */
   VxeLayoutBody: typeof VxeLayoutBody
+  /**
+   * LayoutContainer 页面布局 - 容器
+   */
   VxeLayoutContainer: typeof VxeLayoutContainer
+  /**
+   * LayoutFooter 页面布局 - 底部
+   */
   VxeLayoutFooter: typeof VxeLayoutFooter
+  /**
+   * LayoutHeader 页面布局 - 头部
+   */
   VxeLayoutHeader: typeof VxeLayoutHeader
+  /**
+   * Link 链接
+   */
   VxeLink: typeof VxeLink
+  /**
+   * List 列表
+   */
   VxeList: typeof VxeList
+  /**
+   * Loading 加载中
+   */
   VxeLoading: typeof VxeLoading
   VxeMention: typeof VxeMention
+  /**
+   * Menu 菜单
+   */
   VxeMenu: typeof VxeMenu
+  /**
+   * Modal 弹窗
+   */
   VxeModal: typeof VxeModal
+  /**
+   * NoticeBar 通知栏
+   */
   VxeNoticeBar: typeof VxeNoticeBar
+  /**
+   * NumberInput 数值输入
+   */
   VxeNumberInput: typeof VxeNumberInput
   VxeOptgroup: typeof VxeOptgroup
   VxeOption: typeof VxeOption
+  /**
+   * Pager 分页
+   */
   VxePager: typeof VxePager
   VxePasswordInput: typeof VxePasswordInput
   VxePrintPageBreak: typeof VxePrintPageBreak
@@ -202,28 +359,76 @@ interface AllComponents {
   VxeTip: typeof VxeTip
   VxeTooltip: typeof VxeTooltip
   VxeTour: typeof VxeTour
+  /**
+   * Tree 树
+   */
   VxeTree: typeof VxeTree
+  /**
+   * TreeSelect 下拉树选择
+   */
   VxeTreeSelect: typeof VxeTreeSelect
   VxeTransfer: typeof VxeTransfer
+  /**
+   * Upload 上传
+   */
   VxeUpload: typeof VxeUpload
+  /**
+   * Watermark 水印
+   */
   VxeWatermark: typeof VxeWatermark
 
   // Vxe Table
+  /**
+   * Column 基础表格 - 列
+   */
   VxeColumn: typeof VxeColumn
+  /**
+   * Colgroup 基础表格 - 分组列
+   */
   VxeColgroup: typeof VxeColgroup
+  /**
+   * Table 基础表格
+   */
   VxeTable: typeof VxeTable
+  /**
+   * Grid 高级表格
+   */
   VxeGrid: typeof VxeGrid
+  /**
+   * Toolbar 基础表格 - 工具栏
+   */
   VxeToolbar: typeof VxeToolbar
 
   // Vxe Design
+  /**
+   * FlowDesign 流程设计器
+   */
   VxeFlowDesign: typeof VxeFlowDesign
+  /**
+   * FlowView 流程设计器 - 视图
+   */
   VxeFlowView: typeof VxeFlowView
+  /**
+   * FormDesign 表单设计器
+   */
   VxeFormDesign: typeof VxeFormDesign
+  /**
+   * FormView 表单设计器 - 视图
+   */
   VxeFormView: typeof VxeFormView
+  /**
+   * ListDesign 列表设计器
+   */
   VxeListDesign: typeof VxeListDesign
+  /**
+   * ListView 列表设计器 - 视图
+   */
   VxeListView: typeof VxeListView
 
   // VxeGantt
+  /**
+   * Gantt 甘特图
+   */
   VxeGantt: typeof VxeGantt
 }
 

package/types/components/checkbox-group.d.ts

@@ -1,5 +1,5 @@
 import { RenderFunction, SetupContext, Ref, ComputedRef } from 'vue'
-import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'
+import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf, VxeComponentStatusType } from '@vxe-ui/core'
 import { VxeCheckboxPropTypes } from './checkbox'
 
 /* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
@@ -37,6 +37,7 @@ export namespace VxeCheckboxGroupPropTypes {
     label?: string
     disabled?: string
   }
+  export type Status = VxeComponentStatusType
   export type Max = string | number
   export type Disabled = boolean
   export type Readonly = boolean
@@ -57,6 +58,7 @@ export type VxeCheckboxGroupProps = {
    */
   modelValue?: VxeCheckboxGroupPropTypes.ModelValue
   max?: VxeCheckboxGroupPropTypes.Max
+  status?: VxeCheckboxGroupPropTypes.Status
   /**
    * 是否禁用
    */

package/types/components/checkbox.d.ts

@@ -24,7 +24,7 @@ export interface VxeCheckboxPrivateRef extends CheckboxPrivateRef { }
 
 export namespace VxeCheckboxPropTypes {
   export type Size = VxeComponentSizeType
-  export type ModelValue = string | number | boolean
+  export type ModelValue = string | number | boolean | null
   export type Label = string | number
   export type Indeterminate = boolean
   export type Title = string | number

package/types/components/icon-picker.d.ts

@@ -34,13 +34,23 @@ export namespace VxeIconPickerPropTypes {
   export type PopupClassName = string | ((params: {$iconPicker: VxeIconPickerConstructor }) => string)
   export type Readonly = boolean
   export type Disabled = boolean
-  export type Icons = string[] | {
+  export type Option = {
     title?: string | number
     icon: string
     iconRender?: VxeIconPickerDefines.OptionIconRender
-  }[]
+  }
+  export type Icons = string[] | Option[]
   export type Clearable = boolean
   export type ShowIconTitle = boolean
+  export type Filterable = boolean
+  export interface FilterConfig {
+    filterMethod?:(params: {
+      $iconPicker: VxeIconPickerConstructor
+      option: VxeIconPickerDefines.IconItemObj
+      searchValue: string
+      value: ModelValue | undefined
+    }) => boolean
+  }
   export type Placement = 'top' | 'bottom' | '' | null
   export interface PopupConfig {
     /**
@@ -56,8 +66,16 @@ export namespace VxeIconPickerPropTypes {
      */
     trigger?: 'default' | 'icon' | 'manual' | '' | null
     transfer?: boolean
+    /**
+     * 分块显示多少个图标
+     */
+    chunkSize?: number
+    /**
+     * 图标展示方式，支持分块和列表
+     */
     width?: number | string
     height?: number | string
+    maxHeight?: number | string
     zIndex?: number | string
     className?: string | ((params: { $iconPicker: VxeIconPickerConstructor }) => string)
   }
@@ -82,6 +100,8 @@ export type VxeIconPickerProps = {
   icons?: VxeIconPickerPropTypes.Icons
   clearable?: VxeIconPickerPropTypes.Clearable
   showIconTitle?: VxeIconPickerPropTypes.ShowIconTitle
+  filterable?: VxeIconPickerPropTypes.Filterable
+  filterConfig?: VxeIconPickerPropTypes.FilterConfig
   placement?: VxeIconPickerPropTypes.Placement
   popupConfig?: VxeIconPickerPropTypes.PopupConfig
   transfer?: VxeIconPickerPropTypes.Transfer
@@ -100,10 +120,13 @@ export interface IconPickerReactData {
   visiblePanel: boolean
   isAniVisible: boolean
   isActivated: boolean
+  searchValue: string
+  iconGroups: VxeIconPickerDefines.IconItemObj[][]
 }
 
 export interface IconPickerInternalData {
   hpTimeout?: undefined | number
+  fullList: VxeIconPickerDefines.IconItemObj[]
 }
 
 export interface IconPickerMethods {
@@ -166,8 +189,8 @@ export namespace VxeIconPickerDefines {
   }
 
   export interface IconItemObj {
-    title?: string
-    icon?: string
+    title: string
+    icon: string
     iconRender?: OptionIconRender
   }
 }

package/types/components/list.d.ts

@@ -397,11 +397,11 @@ export interface ListMethods<D = any> {
    */
   clearRadioRow(): Promise<void>
   /**
-   * 只对 show-checkbox 有效，设置单选框已选的行
+   * 只对 show-checkbox 有效，设置复选框选中的行
    */
   setCheckboxRow(rows: D | D[], checked: boolean): Promise<void>
   /**
-   * 只对 show-checkbox 有效，根据主键设置单选
+   * 只对 show-checkbox 有效，根据主键设置复选框
    */
   setCheckboxRowByKey(rowKeys: string | number | null | undefined | (string | number | null | undefined)[], checked: boolean): Promise<void>
   /**

package/types/components/radio-group.d.ts

@@ -1,5 +1,5 @@
 import { RenderFunction, SetupContext, Ref, ComputedRef } from 'vue'
-import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'
+import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf, VxeComponentStatusType } from '@vxe-ui/core'
 import { VxeRadioPropTypes } from './radio'
 
 /* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
@@ -39,6 +39,7 @@ export namespace VxeRadioGroupPropTypes {
     disabled?: string
   }
   export type ModelValue = any
+  export type Status = VxeComponentStatusType
   export type Strict = boolean
   export type Disabled = boolean
   export type Readonly = boolean
@@ -55,6 +56,7 @@ export interface VxeRadioGroupProps {
   type?: VxeRadioGroupPropTypes.Type
   options?: VxeRadioGroupPropTypes.Options
   optionProps?: VxeRadioGroupPropTypes.OptionProps
+  status?: VxeRadioGroupPropTypes.Status
   /**
    * 严格模式，不允许取消
    */

package/types/components/tree.d.ts

@@ -377,6 +377,9 @@ export interface TreeReactData {
   updateExpandedFlag: number
   updateCheckboxFlag: number
 
+  insertRowFlag: number
+  removeRowFlag: number
+
   dragNode: any
   dragTipText: string
 }
@@ -405,6 +408,9 @@ export interface TreeInternalData {
   lastScrollTime: number
   hpTimeout?: undefined | number
 
+  insertRowMaps: Record<string, any>
+  removeRowMaps: Record<string, any>
+
   prevDragNode?: any
   prevDragToChild?: boolean
   prevDragPos?: 'top' | 'bottom' | ''
@@ -603,6 +609,34 @@ export interface TreeMethods<D = any> {
    * 手动清除滚动相关信息，还原到初始状态
    */
   clearScroll(): Promise<void>
+
+  /**
+   * 往表格插入临时数据，从第一个节点新增一个节点或多个节点新数据
+   */
+  insert(records: any): Promise<{ node: D, nodes: D[] }>
+  /**
+   * 用于 transform 模式，往表格指定节点中插入临时数据
+   * 如果 node 为空则从插入到顶部，如果为树结构，则插入到目标节点顶部
+   * 如果 node 为 -1 则从插入到底部，如果为树结构，则插入到目标节点底部
+   * 如果 node 为有效节点则插入到该节点的位置，如果为树结构，则有插入到效的目标节点该节点的位置
+   */
+  insertAt(records: any, targetNodeOrNodeid?: any | -1 | null): Promise<{ node: D, nodes: D[] }>
+  /**
+   * 用于 transform 模式，与 insertAt 节点为一致，区别就是会插入指定目标的到下一节点
+   */
+  insertNextAt(records: any, targetNodeOrNodeid?: any | -1 | null): Promise<{ node: D, nodes: D[] }>
+  /**
+   * 用于 transform 模式，删除指定节点数据，指定 node 或 [node, ...] 删除多条数据，如果为空则删除所有数据
+   */
+  remove(nodes?: any | any[]): Promise<{ node: D, nodes: D[] }>
+  /**
+   * 用于 transform 模式，获取新增的临时数据
+   */
+  getInsertRecords(): D[]
+  /**
+   * 用于 transform 模式，获取已删除的数据
+   */
+  getRemoveRecords(): D[]
 }
 export interface VxeTreeMethods<D = any> extends TreeMethods<D> { }
 
@@ -673,6 +707,8 @@ export type VxeTreeEmits = [
   'node-dragstart',
   'node-dragover',
   'node-dragend',
+  'node-remove-dragend',
+  'node-insert-dragend',
   'node-expand',
   'node-menu',
   'menu-click'