1.3.0 • Published 5 months ago
@illa-design/select v1.3.0
Select
The Select component allows users pick a value from predefined options.
Installation
yarn add @illa-design/select
Import component
import { Select } from "@illa-design/select"
API
Select Basic Properties
Props | Desc | Type | Default |
---|---|---|---|
defaultValue | The defalut value | string | string[] | number | number[] | LabelValue | LabelValue[] | - |
value | The value | string | string[] | number | number[] | LabelValue | LabelValue[] | - |
mode | Mutiple choices mode and tags mode | "multiple" | "tags" | - |
notFoundContent | When there is no content | ReactNode | - |
getPopupContainer | The container of the popup | (node: HTMLElement) => Element | "circle" |
placeholder | The placeholder of the select | string | - |
showSearch | If true, show search button | boolean | {retainInputValue?: boolean; retainInputValueWhileSelect?: boolean } | - |
size | Size of the select | "small" | "medium" | "large" | "medium" |
disabled | If true, the select is disabled | boolean | - |
error | If true, the select is invalid | boolean | - |
loading | If true, the select is loading | boolean | - |
allowClear | If true, show the clear button | boolean | - |
maxTagCount | The max tag count of the select when on tags mode | number | - |
arrowIcon | The arrow icon element to use in the select | ReactNode | null | - |
removeIcon | The remove icon element to use in the select | ReactNode | null | - |
Select Events
Props | Desc | Type | Default |
---|---|---|---|
onClick | Callback when on click | (e) => void | - |
onFocus | Callback when on focus | (e) => void | - |
onBlur | Callback when on blur | (e) => void | - |
onChange | Callback when the value change | (value, option: OptionInfo | OptionInfo[]) => void | - |
onDeselect | Callback when deselect | (value: string | number | LabeledValue, option:OptionInfo) => void | - |
onClear | Callback when clear | (visible: boolean) => void | - |
onSearch | Callback when search | (value: string, reason: InputValueChangeReason) => void | - |
onPopupScroll | Callback when scroll the popup | (elem) => void | - |
onVisibleChange | Callback when is not visible | (visible: boolean) => void | - |
Select-option Basic Properties
Props | Desc | Type | Default |
---|---|---|---|
disabled | If true, the option is disabled | boolean | false |
title | The title of the option | string | - |
value | The value of the option | string | number | - |
Examples
Basic Usage
<Select value={"A"}>
<Option>A</Option>
<Option>B</Option>
<Option>C</Option>
</Select>
Set the error status
<Select value={1} options={[1, 2, 3]} error />
Set the size
<Select value={1} options={[1, 2, 3]} size="large"
Set the multiple-choice mode
<Select value={[1, 2]} options={[1, 2, 3]} mode="multiple" labelInValue />
Set the max tag count
<Select value={[1, 2]} options={[1, 2, 3]} maxTagCount={1} mode="tags" />
1.2.0
5 months ago
1.3.0
5 months ago
1.0.29
10 months ago
1.0.28
10 months ago
1.0.27
11 months ago
1.0.31
9 months ago
1.0.30
10 months ago
1.1.0
8 months ago
1.0.22
1 year ago
1.0.21
1 year ago
1.0.26
12 months ago
1.0.25
12 months ago
1.0.24
1 year ago
1.0.23
1 year ago
1.0.19
1 year ago
1.0.18
1 year ago
1.0.17
1 year ago
1.0.20
1 year ago
1.0.16
1 year ago
1.0.15
1 year ago
1.0.14
1 year ago
1.0.9
1 year ago
1.0.8
1 year ago
1.0.7
1 year ago
1.0.6
2 years ago
1.0.11
1 year ago
1.0.10
1 year ago
1.0.13
1 year ago
1.0.12
1 year ago
1.0.5
2 years ago
1.0.4
2 years ago
1.0.3
2 years ago
1.0.2
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago
0.0.10
2 years ago
0.0.11
2 years ago
0.0.12
2 years ago
0.0.13
2 years ago
0.0.14
2 years ago
0.0.15
2 years ago
0.0.9
2 years ago
0.0.16
2 years ago
0.0.17
2 years ago
0.0.8
2 years ago
0.0.5
2 years ago
0.0.4
2 years ago
0.0.7
2 years ago
0.0.6
2 years ago
0.0.3
2 years ago
0.0.2
2 years ago
0.0.1
2 years ago