53 lines
3.0 KiB
Markdown
53 lines
3.0 KiB
Markdown
|
||
## API
|
||
|
||
````html
|
||
<a-cascader :options="options" @change="onChange" />
|
||
````
|
||
|
||
| Property | Description | Type | Default |
|
||
| -------- | ----------- | ---- | ------- |
|
||
| allowClear | whether allow clear | boolean | true |
|
||
| autoFocus | get focus when component mounted | boolean | false |
|
||
| changeOnSelect | change value on each selection if set to true, see above demo for details | boolean | false |
|
||
| defaultValue | initial selected value | string\[] | \[] |
|
||
| disabled | whether disabled select | boolean | false |
|
||
| displayRender | render function of displaying selected options, you can use slot="displayRender" and slot-scope="{labels, selectedOptions}" | `({labels, selectedOptions}) => vNode` | `labels => labels.join(' / ')` |
|
||
| expandTrigger | expand current item when click or hover, one of 'click' 'hover' | string | 'click' |
|
||
| fieldNames | custom field name for label and value and children | object | `{ label: 'label', value: 'value', children: 'children' }` |
|
||
| getPopupContainer | Parent Node which the selector should be rendered to. Default to `body`. When position issues happen, try to modify it into scrollable content and position it relative. | Function(triggerNode) | () => document.body |
|
||
| loadData | To load option lazily, and it cannot work with `showSearch` | `(selectedOptions) => void` | - |
|
||
| notFoundContent | Specify content to show when no result matches. | string | 'Not Found' |
|
||
| options | data options of cascade | object | - |
|
||
| placeholder | input placeholder | string | 'Please select' |
|
||
| popupClassName | additional className of popup overlay | string | - |
|
||
| popupStyle | additional style of popup overlay | object | {} |
|
||
| popupPlacement | use preset popup align config from builtinPlacements：`bottomLeft` `bottomRight` `topLeft` `topRight` | string | `bottomLeft` |
|
||
| popupVisible | set visible of cascader popup | boolean | - |
|
||
| showSearch | Whether show search input in single mode. | boolean\|object | false |
|
||
| size | input size, one of `large` `default` `small` | string | `default` |
|
||
| value(v-model) | selected value | string\[] | - |
|
||
|
||
Fields in `showSearch`:
|
||
|
||
| Property | Description | Type | Default |
|
||
| -------- | ----------- | ---- | ------- |
|
||
| filter | The function will receive two arguments, inputValue and option, if the function returns true, the option will be included in the filtered set; Otherwise, it will be excluded. | `function(inputValue, path): boolean` | |
|
||
| matchInputWidth | Whether the width of result list equals to input's | boolean | |
|
||
| render | Used to render filtered options, you can use slot="showSearchRender" and slot-scope="{inputValue, path}" | `function({inputValue, path}): vNode` | |
|
||
| sort | Used to sort filtered options. | `function(a, b, inputValue)` | |
|
||
|
||
### events
|
||
| Events Name | Description | Arguments |
|
||
| --- | --- | --- |
|
||
| change | callback when finishing cascader select | `(value, selectedOptions) => void` | - |
|
||
| popupVisibleChange | callback when popup shown or hidden | `(value) => void` | - |
|
||
|
||
## Methods
|
||
|
||
| Name | Description |
|
||
| ---- | ----------- |
|
||
| blur() | remove focus |
|
||
| focus() | get focus |
|
||
|