UNPKG

zent

Version:

一套前端设计语言和基于React的实现

58 lines (50 loc) • 8.84 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
--- title: Select path: component/select group: Data Entry --- ## Select You can select single or multiple values on the panel and finally enter the corresponding values. ### API | Props | Description | Type | Default | Required | | ---------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | --------------------------- | -------- | | options | Option data | array | `[]` | yes | | value | Selected value, when tags type, can be passed into the array | any | `null` | no | | size | size type | `xs` `s` `m` `l` `xl` | s | 否 | | disabled | Disable switch | bool | `false` | no | | placeholder | The default prompt text | string | `'please choose'` | no | | notFoundContent | Empty list prompt text | string | `'No matches found'` | no | | onChange | Select changed callback | function | `noop` | no | | filter | Filter conditions, set to open the filter function | function | `false` | no | | highlight | Highlight filterd options | function | `noop` | no | | className | Optional, custom trigger additional classname | string | `''` | no | | width | input-box's width | `string` \| `number` | `''` | no | | popupWidth | pupup's width | `string` \| `number` | Same as trigger width | no | | multiple | Support multiple selected options | bool | `false` | no | | collapsable | Support collapsed tags in multiple mode | bool | | `false` | no | | hideCollapsePop | Hide tags content pop in collapsed mode | bool | | `false` | no | | collapseAt | Dispaly tags count in collapsed mode | number | `1` | no | | clearable | Is the select value clearable | bool | `true` | no | | loading | Is the select in a state of loading | bool | `false` | no | | creatable | Allow options to be created | bool | `false` | no | | onCreate | Select create callback | `(keyword) => Promise<void>` | | no | | isValidNewOption | Determines whether the "+Click add" option should be displayed based on the current input value | `(keyword, options) => boolean` | | no | | keyword | Search's keyword | string | `''` | no | | onKeywordChange | Keyword changed callback | `(keyword: string, meta: ISelectKeywordChangeMeta) => void` | `noop` | no | | isEqual | Compare two option is equal | `(a: Item, b: Item) => boolean` | `(a, b) => a.key === b.key` | no | | inline | Is inline display | bool | `false` | no | | open | Whether the menu is open | bool | `false` | no | | onOpenChange | Menu visible changed callback | function | `noop` | no | | renderValue | Render option value | `option => ReactNode` | | no | | renderOptionList | Render menu list | `(options, renderOption) => ReactNode` | | no | | renderOptionContent | Render menu item content | `option => ReactNode` | | no | | renderTagList | Only available in `multiple` mode; render selected option list | `(props: ISelectTagListProps) => ReactNode` | | No | | disableSearch | Disable search | boolean | `false` | no | | renderCollapsedContent | Render Pop content of collapsed tags in multiple and collapsed mode | `(collapsedValue: Item[]) => ReactNode` | | no | ### `Select.reviveValue` `reviveValue` can only be used in controlled mode. It can simplify initializing value from remote server. It's a function with 3 different types of parameters: - Function：`(item: ISelectItem) => ISelectItem | null` return non `null` value to replace current value - Object：`{ key: K; [k: string]: unknown; }` replace current value with the first matching option in options array using plain object equality test - String/Number：Shorthand of `{ key: K }`