From f099848461604239a25daab2895c7b7b736a60c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A8=80=E8=82=86?= <18x@loacg.com> Date: Mon, 17 Aug 2020 21:35:38 +0800 Subject: [PATCH] fix: update tree-select types (#2698) * fix: update tree-select typo * fix: tree-select prop typo --- types/tree-select.d.ts | 384 +++++++++++++++++++++++------------------ 1 file changed, 215 insertions(+), 169 deletions(-) diff --git a/types/tree-select.d.ts b/types/tree-select.d.ts index c538c776b..906969b77 100644 --- a/types/tree-select.d.ts +++ b/types/tree-select.d.ts @@ -4,6 +4,7 @@ import { AntdComponent } from './component'; import { TreeNode } from './tree-node'; +import { VNodeChild, CSSProperties } from 'vue'; export interface TreeData { key: string | number; @@ -15,214 +16,259 @@ export interface TreeData { selectable?: boolean; } +export interface ReplaceFields { + children: 'children'; + title: 'title'; + key: 'key'; + value: 'value'; +} + export type TreeNodeValue = string | number | string[] | number[]; export declare class TreeSelect extends AntdComponent { static TreeNode: typeof TreeNode; - treeIcon?: boolean; + $props: { + treeIcon?: boolean; - notFoundContent?: any; + notFoundContent?: VNodeChild | JSX.Element; - /** - * Whether allow clear - * @default false - * @type boolean - */ - allowClear: boolean; + /** + * Whether allow clear + * @default false + * @type boolean + */ + allowClear?: boolean; - defaultValue: TreeNodeValue; + defaultValue?: TreeNodeValue; - /** - * Disabled or not - * @default false - * @type boolean - */ - disabled: boolean; + /** + * Disabled or not + * @default false + * @type boolean + */ + disabled?: boolean; - /** - * className of dropdown menu - * @type string - */ - dropdownClassName: string; + /** + * className of dropdown menu + * @type string + */ + dropdownClassName?: string; - /** - * Determine whether the dropdown menu and the select input are the same width - * @default true - * @type boolean - */ - dropdownMatchSelectWidth: boolean; + /** + * Determine whether the dropdown menu and the select input are the same width + * @default true + * @type boolean + */ + dropdownMatchSelectWidth?: boolean; - /** - * To set the style of the dropdown menu - * @type object - */ - dropdownStyle: object; + /** + * To set the style of the dropdown menu + * @type object + */ + dropdownStyle?: CSSProperties; - /** - * Whether to filter treeNodes by input value. The value of treeNodeFilterProp is used for filtering by default. - * @default Function - * @type boolean | Function - */ - filterTreeNode: boolean | Function; + /** + * Whether to filter treeNodes by input value. The value of treeNodeFilterProp is used for filtering by default. + * @default Function + * @type boolean | Function + */ + filterTreeNode?: boolean | Function; - /** - * To set the container of the dropdown menu. - * The default is to create a div element in body, you can reset it to the scrolling area and make a relative reposition. - * @default () => document.body - * @type Function - */ - getPopupContainer: (triggerNode: any) => HTMLElement; + /** + * To set the container of the dropdown menu. + * The default is to create a div element in body, you can reset it to the scrolling area and make a relative reposition. + * @default () => document.body + * @type Function + */ + getPopupContainer?: (triggerNode: any) => HTMLElement; - /** - * whether to embed label in value, turn the format of value from string to {value: string, label: VNode, halfChecked: string[]} - * @default false - * @type boolean - */ - labelInValue: boolean; + /** + * whether to embed label in value, turn the format of value from string to {value: string, label: VNode, halfChecked: string[]} + * @default false + * @type boolean + */ + labelInValue?: boolean; - /** - * Load data asynchronously. - * @type - */ - loadData: (node: any) => void; + /** + * Load data asynchronously. + * @param node + */ + loadData?: (node: object) => Promise; - maxTagCount: number; + /** + * Max tag count to show + */ + maxTagCount?: number; - maxTagPlaceholder: any; + /** + * Placeholder for not showing tags + * @param omittedValues + */ + maxTagPlaceholder?: (omittedValues: any[]) => VNodeChild | JSX.Element; - /** - * Support multiple or not, will be true when enable treeCheckable. - * @default false - * @type boolean - */ - multiple: boolean; + /** + * Support multiple or not, will be true when enable treeCheckable. + * @default false + * @type boolean + */ + multiple?: boolean; - /** - * Placeholder of the select input - * @type any (string | slot) - */ - placeholder: any; + /** + * Placeholder of the select input + * @type any (string | slot) + */ + placeholder?: string | VNodeChild | JSX.Element; - /** - * Placeholder of the search input - * @type any (string | slot) - */ - searchPlaceholder: any; + /** + * Placeholder of the search input + * @type any (string | slot) + */ + searchPlaceholder?: string | VNodeChild | JSX.Element; - /** - * work with `search` event to make search value controlled. - * @type string - */ - searchValue: string; + /** + * work with `search` event to make search value controlled. + * @type string + */ + searchValue?: string; - /** - * Show Checked Strategy - * @description The way show selected item in box. Default: just show child nodes. - * TreeSelect.SHOW_ALL: show all checked treeNodes (include parent treeNode). - * TreeSelect.SHOW_PARENT: show checked treeNodes (just show parent treeNode). - * @default TreeSelect.SHOW_CHILD - * @type - */ - showCheckedStrategy: 'SHOW_ALL' | 'SHOW_PARENT' | 'SHOW_CHILD'; + /** + * Show Checked Strategy + * @description The way show selected item in box. Default: just show child nodes. + * TreeSelect.SHOW_ALL: show all checked treeNodes (include parent treeNode). + * TreeSelect.SHOW_PARENT: show checked treeNodes (just show parent treeNode). + * @default TreeSelect.SHOW_CHILD + * @type TreeSelect ENUMS + */ + showCheckedStrategy?: 'SHOW_ALL' | 'SHOW_PARENT' | 'SHOW_CHILD'; - /** - * Whether to display a search input in the dropdown menu(valid only in the single mode) - * @default false - * @type boolean - */ - showSearch: boolean; + /** + * Whether to display a search input in the dropdown menu(valid only in the single mode) + * @default false + * @type boolean + */ + showSearch?: boolean; - /** - * To set the size of the select input, options: large small - * @default 'default' - * @type string - */ - size: 'small' | 'large' | 'default'; + /** + * To set the size of the select input, options: large small + * @default 'default' + * @type string + */ + size?: 'small' | 'large' | 'default'; - /** - * Whether to show checkbox on the treeNodes - * @default false - * @type boolean - */ - treeCheckable: boolean; + /** + * Whether to show checkbox on the treeNodes + * @default false + * @type boolean + */ + treeCheckable?: boolean; - /** - * Whether to check nodes precisely (in the checkable mode), means parent and - * child nodes are not associated, and it will make labelInValue be true - * @default false - * @type boolean - */ - treeCheckStrictly: boolean; + /** + * Whether to check nodes precisely (in the checkable mode), means parent and + * child nodes are not associated, and it will make labelInValue be true + * @default false + * @type boolean + */ + treeCheckStrictly?: boolean; - /** - * Data of the treeNodes, manual construction work is no longer needed - * if this property has been set(ensure the Uniqueness of each value) - * @default [] - * @type object[] - */ - treeData: TreeData[]; + /** + * Data of the treeNodes, manual construction work is no longer needed + * if this property has been set(ensure the Uniqueness of each value) + * @default [] + * @type object[] + */ + treeData?: TreeData[]; - /** - * Enable simple mode of treeData. - * (treeData should like this: [{id:1, pId:0, value:'1', label:"test1",...},...], pId is parent node's id) - * @default false - * @type boolean | object[] - */ - treeDataSimpleMode: - | boolean - | Array<{ - id: string; - pId: string; - rootPId: any; - }>; + /** + * Enable simple mode of treeData. + * (treeData should like this: [{id:1, pId:0, value:'1', label:"test1",...},...], pId is parent node's id) + * @default false + * @type boolean | object[] + */ + treeDataSimpleMode?: + | boolean + | Array<{ + id: string; + pId: string; + rootPId: any; + }>; - /** - * Whether to expand all treeNodes by default - * @default false - * @type boolean - */ - treeDefaultExpandAll: boolean; + /** + * Whether to expand all treeNodes by default + * @default false + * @type boolean + */ + treeDefaultExpandAll?: boolean; - /** - * Default expanded treeNodes - * @type string[] | number[] - */ - treeDefaultExpandedKeys: string[] | number[]; + /** + * Default expanded treeNodes + * @type string[] | number[] + */ + treeDefaultExpandedKeys?: string[] | number[]; - /** - * Set expanded keys - * @type string[] | number[] - */ - treeExpandedKeys: string[] | number[]; + /** + * Set expanded keys + * @type string[] | number[] + */ + treeExpandedKeys?: string[] | number[]; - /** - * Will be used for filtering if filterTreeNode returns true - * @default 'value' - * @type string - */ - treeNodeFilterProp: string; + /** + * Will be used for filtering if filterTreeNode returns true + * @default 'value' + * @type string + */ + treeNodeFilterProp?: string; - /** - * Will render as content of select - * @default 'title' - * @type string - */ - treeNodeLabelProp: string; + /** + * Will render as content of select + * @default 'title' + * @type string + */ + treeNodeLabelProp?: string; - value: TreeNodeValue; + value?: TreeNodeValue; - /** - * The custom suffix icon - * @type any (VNode | slot) - */ - suffixIcon: any; + /** + * The custom suffix icon + * @type any (VNode | slot) + */ + suffixIcon?: VNodeChild | JSX.Element; - removeIcon?: any; + removeIcon?: VNodeChild | JSX.Element; - clearIcon?: any; + clearIcon?: VNodeChild | JSX.Element; - replaceFields: object; + replaceFields?: ReplaceFields | object; + + /** + * A callback function, can be executed when selected treeNodes or input value change + * + * @param value + * @param label + * @param extra + */ + onChange?: (value?: any, label?: any, extra?: any) => void; + + /** + * A callback function, can be executed when the search input changes. + * @param value + */ + onSearch?: (value?: string) => void; + + /** + * A callback function, can be executed when you select a treeNode. + * @param value + * @param label + * @param extra + */ + onSelect?: (value?: any, label?: any, extra?: any) => void; + + /** + * A callback function, can be executed when treeNode expanded + * @param expandedKeys + */ + onTreeExpand?: (expandedKeys?: any[]) => void; + }; /** * remove focus