vxe-pc-ui 4.14.39 → 4.15.0

package/types/components/cascader.d.ts

@@ -1,6 +1,5 @@
 import { RenderFunction, SetupContext, Ref } from 'vue'
 import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, VxeComponentSizeType, ValueOf } from '@vxe-ui/core'
-import { VxeTreeProps, VxeTreePropTypes } from './tree'
 
 /* eslint-disable no-use-before-define,@typescript-eslint/ban-types */
 
@@ -27,26 +26,51 @@ export namespace VxeCascaderPropTypes {
   export type Size = VxeComponentSizeType
   export type ModelValue = any
   export type Clearable = boolean
-  export type ZIndex = number
   export type Placeholder = string
   export type Readonly = boolean
   export type Loading = boolean
   export type Disabled = boolean
-  export type AutoClose = boolean
+  export type CheckedClosable = boolean
+  export type ClearClosable = boolean
+  export type ShowCloseButton = boolean
   export type ShowTotalButton = boolean
   export type ShowCheckedButton = boolean
   export type ShowClearButton = boolean
   export type ClassName = string | ((params: { $cascader: VxeCascaderConstructor }) => string)
-  /**
-   * 已废弃，请使用 VxeCascaderPropTypes.PopupConfig
-   * @deprecated
-   */
-  export type PopupClassName = string | ((params: { $cascader: VxeCascaderConstructor }) => string)
   export type Multiple = boolean
   export type PrefixIcon = string
-  export type Placement = 'top' | 'bottom'
   export type Filterable = boolean
-  export type FilterConfig = VxeTreePropTypes.FilterConfig
+  /**
+   * 根据指定值来筛选数据
+   */
+  type FilterValue = string | number | null | undefined
+  export interface FilterConfig<D = any> {
+    /**
+     * 过滤之前的方法
+     */
+    beforeFilterMethod?(params: {
+      $cascader: VxeCascaderConstructor
+      filterValue: FilterValue
+    }): void
+    /**
+     * 自定义过滤数据方法
+     */
+    filterMethod?:(params: {
+      $cascader: VxeCascaderConstructor
+      node: D
+      filterValue: FilterValue
+    }) => boolean
+    /**
+     * 过滤之后的方法
+     */
+    afterFilterMethod?(params: {
+      $cascader: VxeCascaderConstructor
+      filterValue: FilterValue
+    }): void
+  }
+  export type ShowFullLabel = boolean
+  export type Separator = string
+
   export interface Option {
     value?: string | number
     label?: string | number
@@ -54,30 +78,44 @@ export namespace VxeCascaderPropTypes {
 
     [key: string]: any
   }
-  export type Transform = boolean
   export type LazyOptions<D = Option> = D[]
   export type Options<D = Option> = D[]
   export interface OptionProps {
     value?: string
     label?: string
     disabled?: string
-    children?: string
-
-    /**
-     * @deprecated
-     */
-    hasChild?: string
-    /**
-     * @deprecated
-     */
-    parent?: string
   }
   export type Remote = boolean
-  /**
-   * 已废弃，被 remote-config.queryMethod 替换
-   * @deprecated
-   */
-  export type RemoteMethod = (params: { searchValue: string }) => Promise<void> | void
+  export interface RadioConfig<D = any> {
+    strict?: boolean
+    visibleMode?: 'all' | 'first' | 'last' | '' | null
+    visibleMethod?: (params: {
+      $cascader: VxeCascaderConstructor
+      node: D
+    }) => boolean
+    checkMode?: 'all' | 'first' | 'last' | '' | null
+    checkMethod?: (params: {
+      $cascader: VxeCascaderConstructor
+      node: D
+    }) => boolean
+    showIcon?: boolean
+    trigger?: '' | 'default' | 'node'
+  }
+  export interface CheckboxConfig<D = any> {
+    checkStrictly?: boolean
+    visibleMode?: 'all' | 'first' | 'last' | '' | null
+    visibleMethod?: (params: {
+      $cascader: VxeCascaderConstructor
+      node: D
+    }) => boolean
+    checkMode?: 'all' | 'first' | 'last' | '' | null
+    checkMethod?: (params: {
+      $cascader: VxeCascaderConstructor
+      node: D
+    }) => boolean
+    showIcon?: boolean
+    trigger?: '' | 'default' | 'node'
+  }
   export interface RemoteConfig {
     /**
      * 是否启用
@@ -97,7 +135,6 @@ export namespace VxeCascaderPropTypes {
     }): Promise<void> | void
   }
 
-  export type Transfer = boolean
   export interface PopupConfig {
     /**
      * 设置弹出面板方向
@@ -107,54 +144,70 @@ export namespace VxeCascaderPropTypes {
      * 默认弹出面板方向
      */
     defaultPlacement?: 'top' | 'bottom' | '' | null
-    width?: number | string
+    transfer?: boolean
     height?: number | string
-    itemWidth?: number | string
-    itemHeight?: number | string
+    nodeWidth?: number | string
+    nodeHeight?: number | string
     className?: string | ((params: { $cascader: VxeCascaderConstructor }) => string)
+    zIndex?: number
+  }
+  export interface TreeConfig<D = any> {
+    transform?: boolean
+    lazy?: boolean
+    parentField?: string
+    keyField?: string
+    childrenField?: string
+    hasChildField?: string
+    mapChildrenField?: string
+    rootParentValue?: string | number | null
+    rootValues?: (string | number)[]
+    trigger?: '' | 'default' | 'node' | 'icon'
+    showIcon?: boolean
+    iconOpen?: string
+    iconClose?: string
+    iconLoaded?: string
+    toggleMethod?(params: {
+      $cascader: VxeCascaderConstructor
+      expanded: boolean
+      node: D
+    }): boolean
+    loadMethod?(params: {
+      $cascader: VxeCascaderConstructor
+      node: D
+    }): Promise<any[]>
   }
-  export type TreeConfig<D = any> = Omit<VxeTreeProps<D>, 'data' | 'size'>
 }
 
 export interface VxeCascaderProps<D = any> {
   size?: VxeCascaderPropTypes.Size
   modelValue?: VxeCascaderPropTypes.ModelValue
   clearable?: VxeCascaderPropTypes.Clearable
-  zIndex?: VxeCascaderPropTypes.ZIndex
   placeholder?: VxeCascaderPropTypes.Placeholder
   readonly?: VxeCascaderPropTypes.Readonly
   loading?: VxeCascaderPropTypes.Loading
   disabled?: VxeCascaderPropTypes.Disabled
-  autoClose?: VxeCascaderPropTypes.AutoClose
+  checkedClosable?: VxeCascaderPropTypes.CheckedClosable
+  clearClosable?: VxeCascaderPropTypes.ClearClosable
+  showCloseButton?: VxeCascaderPropTypes.ShowCloseButton
   showTotalButton?: VxeCascaderPropTypes.ShowTotalButton
   showCheckedButton?: VxeCascaderPropTypes.ShowCheckedButton
   showClearButton?: VxeCascaderPropTypes.ShowClearButton
   className?: VxeCascaderPropTypes.ClassName
   multiple?: VxeCascaderPropTypes.Multiple
   prefixIcon?: VxeCascaderPropTypes.PrefixIcon
-  placement?: VxeCascaderPropTypes.Placement
   filterable?: VxeCascaderPropTypes.Filterable
   filterConfig?: VxeCascaderPropTypes.FilterConfig
-  transform?: VxeCascaderPropTypes.Transform
+  showFullLabel?: VxeCascaderPropTypes.ShowFullLabel
+  separator?: VxeCascaderPropTypes.Separator
   lazyOptions?: VxeCascaderPropTypes.LazyOptions<D>
   options?: VxeCascaderPropTypes.Options<D>
   optionProps?: VxeCascaderPropTypes.OptionProps
   remote?: VxeCascaderPropTypes.Remote
+  radioConfig?: VxeCascaderPropTypes.RadioConfig
+  checkboxConfig?: VxeCascaderPropTypes.CheckboxConfig
   remoteConfig?: VxeCascaderPropTypes.RemoteConfig
-  transfer?: VxeCascaderPropTypes.Transfer
   popupConfig?: VxeCascaderPropTypes.PopupConfig
   treeConfig?: VxeCascaderPropTypes.TreeConfig<D>
-
-  /**
-   * 已废弃，被 remote-config.queryMethod 替换
-   * @deprecated
-   */
-  remoteMethod?: VxeCascaderPropTypes.RemoteMethod
-  /**
-   * 已废弃，请使用 popup-config.className
-   * @deprecated
-   */
-  popupClassName?: VxeCascaderPropTypes.PopupClassName
 }
 
 export interface CascaderPrivateComputed {
@@ -165,6 +218,9 @@ export interface CascaderReactData {
   initialized: boolean
   searchValue: string
   searchLoading: boolean
+  currentCunkList: any[][]
+  currentItems: string[]
+  currentNode: any
   panelIndex: number
   panelStyle: any
   panelPlacement: any
@@ -172,18 +228,27 @@ export interface CascaderReactData {
   visiblePanel: boolean
   isAniVisible: boolean
   isActivated: boolean
+  selectRadioKey: any
+  treeList: any[]
+  updateExpandedFlag: number
+  updateCheckboxFlag: number
+  fullOptFlag: number
+  lazyOptFlag: number
 }
 
 export interface CascaderInternalData {
   hpTimeout?: undefined | number
-  fullOptionList: any[]
-  fullNodeMaps: Record<string, {
-    item: any
-    index: number
-    items: any[]
-    parent: any
-    nodes: any[]
-  }>
+  afterTreeList: any[]
+  treeFullData: any[]
+  afterVisibleList: any[]
+  nodeMaps: Record<string, VxeCascaderDefines.NodeCacheItem>
+  fullNodeMaps: Record<string, VxeCascaderDefines.NodeCacheItem>
+  lazyNodeMaps: Record<string, VxeCascaderDefines.NodeCacheItem>
+  lastFilterValue?: string
+  indeterminateRowMaps: Record<string, any>
+  selectCheckboxMaps: Record<string, any>
+  treeExpandedMaps: Record<string, boolean>
+  treeExpandLazyLoadedMaps: Record<string, boolean>
 }
 
 export interface CascaderMethods {
@@ -191,7 +256,16 @@ export interface CascaderMethods {
 }
 export interface VxeCascaderMethods extends CascaderMethods { }
 
-export interface CascaderPrivateMethods { }
+export interface CascaderPrivateMethods {
+  /**
+   * @private
+   */
+  loadChildrenNode(node: any, childRecords: any[]): Promise<any>
+  /**
+   * @private
+   */
+  isCheckedByCheckboxNodeId(nodeKey: string | number | null): boolean
+}
 export interface VxeCascaderPrivateMethods extends CascaderPrivateMethods { }
 
 export type VxeCascaderEmits = [
@@ -202,10 +276,32 @@ export type VxeCascaderEmits = [
   'blur',
   'focus',
   'click',
-  'node-click'
+  'node-click',
+  'node-expand',
+  'current-change',
+  'radio-change',
+  'checkbox-change',
+  'load-success',
+  'load-error',
+  'visible-change'
 ]
 
 export namespace VxeCascaderDefines {
+  export interface NodeCacheItem {
+    item: any
+    index: number
+    $index: number
+    _index: number
+    items: any[]
+    nodes: any[]
+    parent: any
+    level: number
+    treeIndex: number
+    lineCount: number
+    treeLoaded: boolean
+    fullLabel: string
+  }
+
   export interface CascaderEventParams extends VxeComponentEventParams {
     $cascader: VxeCascaderConstructor
   }
@@ -222,6 +318,10 @@ export namespace VxeCascaderDefines {
   export interface FocusEventParams extends CascaderEventParams { }
   export interface BlurEventParams extends CascaderEventParams { }
   export interface ClickEventParams extends CascaderEventParams { }
+
+  export interface VisibleChangeEventParams extends CascaderEventParams {
+    visible: boolean
+  }
 }
 
 export interface VxeCascaderEventProps<D = any> {
@@ -231,6 +331,7 @@ export interface VxeCascaderEventProps<D = any> {
   onFocus?: VxeCascaderEvents.Focus
   onBlur?: VxeCascaderEvents.Blur
   onClick?: VxeCascaderEvents.Click
+  onVisibleChange?: VxeCascaderEvents.VisibleChange
 }
 
 export interface VxeCascaderListeners<D = any> {
@@ -240,6 +341,7 @@ export interface VxeCascaderListeners<D = any> {
   focus?: VxeCascaderEvents.Focus
   blur?: VxeCascaderEvents.Blur
   click?: VxeCascaderEvents.Click
+  visibleChange?: VxeCascaderEvents.VisibleChange
 }
 
 export namespace VxeCascaderEvents {
@@ -249,14 +351,22 @@ export namespace VxeCascaderEvents {
   export type Focus = (params: VxeCascaderDefines.FocusEventParams) => void
   export type Blur = (params: VxeCascaderDefines.BlurEventParams) => void
   export type Click = (params: VxeCascaderDefines.ClickEventParams) => void
+  export type VisibleChange = (params: VxeCascaderDefines.VisibleChangeEventParams) => void
 }
 
 export namespace VxeCascaderSlotTypes {
   export interface DefaultSlotParams {}
+  export interface PrefixSlotParams {}
+  export interface HeaderSlotParams {}
+  export interface FooterSlotParams {}
 }
 
 export interface VxeCascaderSlots {
   default?: (params: VxeCascaderSlotTypes.DefaultSlotParams) => any
+
+  prefix?: (params: VxeCascaderSlotTypes.PrefixSlotParams) => any
+  header?: (params: VxeCascaderSlotTypes.HeaderSlotParams) => any
+  footer?: (params: VxeCascaderSlotTypes.FooterSlotParams) => any
 }
 
 export const Cascader: typeof VxeCascader

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

@@ -288,5 +288,10 @@ declare module '@vxe-ui/core' {
     // context-menu
     CONTEXT_MENU_OPTION_LOADING?: string
     CONTEXT_MENU_CHILDREN?: string
+
+     // cascader
+    CASCADER_NODE_OPEN?: string
+    CASCADER_NODE_CLOSE?: string
+    CASCADER_NODE_LOADED?: string
   }
 }