You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.5 KiB
2.5 KiB
:: BASE_DOC ::
API
Picker Props
name | type | default | description | required |
---|---|---|---|---|
auto-close | Boolean | true | - | N |
cancel-btn | String / Boolean / Object | true | Typescript:boolean | string | ButtonProps |
N |
columns | Array / Function | [] | required。Typescript:Array<PickerColumn> | ((item: Array<PickerValue>) => Array<PickerColumn>) type PickerColumn = PickerColumnItem[] interface PickerColumnItem { label: string,value: string} 。see more ts definition |
Y |
confirm-btn | String / Boolean / Object | true | Typescript:boolean | string | ButtonProps ,Button API Documents。see more ts definition |
N |
footer | Slot | - | - | N |
header | Boolean / Slot | true | - | N |
render-label | String / Function | - | Typescript:(item: PickerColumnItem) => string |
N |
title | String | '' | - | N |
value | Array | - | Typescript:Array<PickerValue> type PickerValue = string | number 。see more ts definition |
N |
default-value | Array | undefined | uncontrolled property。Typescript:Array<PickerValue> type PickerValue = string | number 。see more ts definition |
N |
visible | Boolean | false | - | N |
Picker Events
name | params | description |
---|---|---|
cancel | - | - |
change | (value: Array<PickerValue>, label: string, columns: Array<{ column: number; index: number }> ) |
- |
close | (trigger: TriggerSource) |
1.0.1 。see more ts definition。type TriggerSource = 'overlay' | 'cancel-btn' | 'confrim-btn' |
confirm | (value: Array<PickerValue>, label: string, columns: Array<{ column: number; index: number }> ) |
- |
pick | (value: Array<PickerValue>, label: string, column: number, index: number) |
- |
PickerItem Props
name | type | default | description | required |
---|---|---|---|---|
format | Function | - | Typescript:(option: PickerItemOption) => string |
N |
options | Array | [] | Typescript:PickerItemOption[] interface PickerItemOption { label: string; value: string | number } 。see more ts definition |
N |