github
/
ant-design-vue
mirror of https://github.com/vueComponent/ant-design-vue
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix: update tree-select types (#2698)

Browse Source 
* fix: update tree-select typo

* fix: tree-select prop typo
pull/2692/head^2
言肆 4 years ago committed by GitHub
parent fd1554eacc
commit f099848461
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 249 additions and 203 deletions
Show Stats Download Patch File Download Diff File

452
types/tree-select.d.ts vendored
Unescape View File

@ -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;
notFoundContent?: any;
/**
* Whether allow clear
* @default false
* @type boolean
*/
allowClear: boolean;
defaultValue: TreeNodeValue;
/**
* Disabled or not
* @default false
* @type boolean
*/
disabled: boolean;
/**
* 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;
/**
* To set the style of the dropdown menu
* @type object
*/
dropdownStyle: object;
/**
* 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;
/**
* 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;
maxTagCount: number;
maxTagPlaceholder: any;
/**
* 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 search input
* @type any (string | slot)
*/
searchPlaceholder: any;
/**
* 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';
/**
* 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';
/**
* 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;
/**
* 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;
}>;
/**
* Whether to expand all treeNodes by default
* @default false
* @type boolean
*/
treeDefaultExpandAll: boolean;
/**
* Default expanded treeNodes
* @type string[] | number[]
*/
treeDefaultExpandedKeys: 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 render as content of select
* @default 'title'
* @type string
*/
treeNodeLabelProp: string;
value: TreeNodeValue;
/**
* The custom suffix icon
* @type any (VNode | slot)
*/
suffixIcon: any;
removeIcon?: any;
clearIcon?: any;
replaceFields: object;
$props: {
treeIcon?: boolean;
notFoundContent?: VNodeChild | JSX.Element;
/**
* Whether allow clear
* @default false
* @type boolean
*/
allowClear?: boolean;
defaultValue?: TreeNodeValue;
/**
* Disabled or not
* @default false
* @type boolean
*/
disabled?: boolean;
/**
* 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;
/**
* 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;
/**
* 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;
/**
* Load data asynchronously.
* @param node
*/
loadData?: (node: object) => Promise<void>;
/**
* Max tag count to show
*/
maxTagCount?: number;
/**
* 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;
/**
* Placeholder of the select input
* @type any (string | slot)
*/
placeholder?: string | VNodeChild | JSX.Element;
/**
* 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;
/**
* 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;
/**
* 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 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[];
/**
* 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;
/**
* Default expanded treeNodes
* @type string[] | number[]
*/
treeDefaultExpandedKeys?: 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 render as content of select
* @default 'title'
* @type string
*/
treeNodeLabelProp?: string;
value?: TreeNodeValue;
/**
* The custom suffix icon
* @type any (VNode | slot)
*/
suffixIcon?: VNodeChild | JSX.Element;
removeIcon?: VNodeChild | JSX.Element;
clearIcon?: VNodeChild | JSX.Element;
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

Write Preview
Loading…
Cancel
Save