ant-design/components/cascader/index.md

39 lines
1.4 KiB
Markdown
Raw Normal View History

2015-12-29 11:46:13 +08:00
# Cascader
- category: Components
- chinese: 级联选择
- type: 表单
---
级联选择框。
2015-12-29 18:24:21 +08:00
2015-12-29 11:46:13 +08:00
## 何时使用
2015-12-29 18:24:21 +08:00
- 需要从一组相关联的数据集合进行选择,例如省市区,公司层级,事物分类等。
- 从一个较大的数据集合中进行选择时,用多级分类进行分隔,方便选择。
- 比起 Select 组件,可以在同一个浮层中完成选择,有较好的体验。
2015-12-29 11:46:13 +08:00
## API
2015-12-29 18:24:21 +08:00
```html
<Cascader options={options} onChange={onChange} />
```
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|--------|
| options | 可选项数据源 | object | - |
| defaultValue | 默认的选中项 | array |[] |
| value | 指定选中项 | array | - |
| onChange | 选择完成后的回调 | `function(value, selectedOptions)` | - |
| displayRender | 选择后展示的渲染函数 | `function(label)`` | `function(label) { return label.join(' / ') }` |
| style | 自定义样式 | string | - |
| className | 自定义类名 | string | - |
2015-12-29 18:24:21 +08:00
| popupClassName | 自定义浮层类名 | string | - |
2016-02-19 11:31:45 +08:00
| popupPlacement | 浮层预设位置:`bottomLeft` `bottomRight` `topLeft` `topRight` | string | `bottomLeft` |
2015-12-29 18:27:46 +08:00
| placeholder | 输入框占位文本 | string | '请选择' |
2015-12-29 18:31:48 +08:00
| size | 输入框大小,可选 `large` `default` `small` | string | `default` |
2016-01-05 11:31:22 +08:00
| disabled | 禁用 | boolean | false |
| allowClear | 是否支持清除 | boolean | true |