@hi-ui/cascader 4.0.0-alpha.6 → 4.0.0-beta.0

package/lib/types/Cascader.d.ts

@@ -1,33 +1,20 @@
 import React from 'react';
-import type { HiBaseHTMLProps } from '@hi-ui/core';
-import { PopperProps } from '@hi-ui/popper';
-import { CascaderItem, ExpandTrigger, FlattedCascaderItem, CascaderItemEventData } from './types';
+import type { HiBaseHTMLProps, HiBaseAppearanceEnum } from '@hi-ui/core';
+import { UseCascaderProps } from './use-cascader';
+import type { PopperOverlayProps } from '@hi-ui/popper';
+import { ExpandTrigger, FlattedCascaderItem, CascaderItemEventData } from './types';
+import { PickerProps } from '@hi-ui/picker';
 /**
  * TODO: What is Cascader
  * Trigger + MenuList + Search
  */
 export declare const Cascader: React.ForwardRefExoticComponent<CascaderProps & React.RefAttributes<HTMLDivElement | null>>;
-export interface CascaderProps extends Omit<HiBaseHTMLProps<'div'>, 'onChange' | 'onSelect'> {
+export interface CascaderProps extends Omit<PickerProps, 'data' | 'onChange' | 'trigger'>, UseCascaderProps {
     /**
-     * 设置选择项数据源
-     */
-    data: CascaderItem[];
-    /**
-     * 设置当前选中值
-     */
-    value?: React.ReactText;
-    /**
-     * 设置当前选中值默认值
+     * 将 check 子项拍平展示。暂不对外暴露
+     * @private
      */
-    defaultValue?: React.ReactText;
-    /**
-     * 选中值改变时的回调
-     */
-    onChange?: (value: React.ReactText, targetOption?: CascaderItemEventData, optionPaths?: FlattedCascaderItem[]) => void;
-    /**
-     * 选中选项时触发，仅供内部使用
-     */
-    onSelect?: (value: React.ReactText, targetOption: CascaderItemEventData, optionPaths: FlattedCascaderItem[]) => void;
+    type?: 'flatted' | 'tree';
     /**
      * 次级菜单的展开方式
      */
@@ -40,34 +27,18 @@ export interface CascaderProps extends Omit<HiBaseHTMLProps<'div'>, 'onChange' |
      * 是否可清空
      */
     clearable?: boolean;
-    /**
-     * 是否禁止使用
-     */
-    disabled?: boolean;
     /**
      * 设置选项为空时展示的内容
      */
     emptyContent?: React.ReactNode;
-    /**
-     * 是否启用选择即改变功能
-     */
-    changeOnSelect?: boolean;
     /**
      * 自定义渲染节点的 title 内容
      */
-    titleRender?: (item: CascaderItemEventData, flatted: boolean) => React.ReactNode;
+    render?: (item: CascaderItemEventData, keyword?: string) => React.ReactNode;
     /**
      * 自定义选择后触发器所展示的内容，只在 title 为字符串时有效
      */
-    displayRender?: (checkedOption: FlattedCascaderItem, checkedOptions: FlattedCascaderItem[]) => React.ReactNode;
-    /**
-     * 将选项拍平展示，不支持 `onLoadChildren` 异步加载交互
-     */
-    flatted?: boolean;
-    /**
-     * 开启全量搜索，默认只对开启 checkable 的选项进行搜索，不向上查找路径
-     */
-    upMatch?: boolean;
+    displayRender?: (checkedOption: CascaderItemEventData, checkedOptionPaths: CascaderItemEventData[]) => React.ReactNode;
     /**
      * 触发器输入框占位符
      */
@@ -77,16 +48,19 @@ export interface CascaderProps extends Omit<HiBaseHTMLProps<'div'>, 'onChange' |
      */
     searchPlaceholder?: string;
     /**
-     * 异步请求更新数据
+     * 自定义搜索过滤器，仅在 searchable 为 true 时有效
+     * 第一个参数为输入的关键字，
+     * 第二个为数据项，返回值为 true 时将出现在结果项
      */
-    onLoadChildren?: (item: CascaderItemEventData) => Promise<CascaderItem[] | void> | void;
+    filterOption?: (keyword: string, item: CascaderItemEventData) => boolean;
     /**
      * 自定义控制 popper 行为
      */
-    popper?: PopperProps;
-}
-export declare const CascaderSearch: React.ForwardRefExoticComponent<Pick<CascaderSearchProps, string | number> & React.RefAttributes<HTMLInputElement | null>>;
-export interface CascaderSearchProps extends HiBaseHTMLProps {
+    overlay?: PopperOverlayProps;
+    /**
+     * 设置展现形式
+     */
+    appearance?: HiBaseAppearanceEnum;
 }
 export declare const CascaderMenuList: React.ForwardRefExoticComponent<Pick<CascaderMenuListProps, string | number> & React.RefAttributes<HTMLDivElement | null>>;
 export interface CascaderMenuListProps extends HiBaseHTMLProps {