mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-03 00:09:39 +08:00
76 lines
3.8 KiB
Markdown
76 lines
3.8 KiB
Markdown
---
|
||
category: Components
|
||
type: Data Entry
|
||
title: Cascader
|
||
---
|
||
|
||
Cascade selection box.
|
||
|
||
## When To Use
|
||
|
||
- When you need to select from a set of associated data set. Such as province/city/district, company level, things classification.
|
||
- When selecting from a large data set, with multi-stage classification separated for easy selection.
|
||
- Chooses cascade items in one float layer for better user experience.
|
||
|
||
## API
|
||
|
||
```jsx
|
||
<Cascader options={options} onChange={onChange} />
|
||
```
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| allowClear | whether allow clear | boolean | true | |
|
||
| autoFocus | get focus when component mounted | boolean | false | |
|
||
| bordered | whether has border style | boolean | true | |
|
||
| changeOnSelect | change value on each selection if set to true, see above demo for details | boolean | false | |
|
||
| className | additional css class | string | - | |
|
||
| defaultValue | initial selected value | string\[] \| number\[] | \[] | |
|
||
| disabled | whether disabled select | boolean | false | |
|
||
| displayRender | render function of displaying selected options | `(label, selectedOptions) => ReactNode` | `label => label.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.[example](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | 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 | [Option](#Option)[] | - | |
|
||
| placeholder | input placeholder | string | 'Please select' | |
|
||
| popupClassName | additional className of popup overlay | string | - | |
|
||
| 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 | `large` \| `middle` \| `small` | | |
|
||
| style | additional style | CSSProperties | - | |
|
||
| suffixIcon | The custom suffix icon | ReactNode | - | |
|
||
| value | selected value | string\[] \| number\[] | - | |
|
||
| onChange | callback when finishing cascader select | `(value, selectedOptions) => void` | - | |
|
||
| onPopupVisibleChange | callback when popup shown or hidden | `(value) => void` | - | |
|
||
|
||
Fields in `showSearch`:
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| 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` | | |
|
||
| limit | Set the count of filtered items | number \| false | 50 | |
|
||
| matchInputWidth | Whether the width of result list equals to input's | boolean | | |
|
||
| render | Used to render filtered options. | `function(inputValue, path): ReactNode` | | |
|
||
| sort | Used to sort filtered options. | `function(a, b, inputValue)` | | |
|
||
|
||
### Option
|
||
|
||
```typescript
|
||
interface Option {
|
||
value: string | number;
|
||
label?: React.ReactNode;
|
||
disabled?: boolean;
|
||
children?: Option[];
|
||
}
|
||
```
|
||
|
||
## Methods
|
||
|
||
| Name | Description | Version |
|
||
| ------- | ------------ | ------- |
|
||
| blur() | remove focus | |
|
||
| focus() | get focus | |
|