ant-design/components/cascader/index.zh-CN.md
偏右 882cec62d6
docs: 🌈 Add Components overview page (#24491)
* docs: Add components overview page

* fix detail

* remove ContributorsList form overview page

* fix components url

* improve code style

* remove extra file

* fix detail

* fix lint

* fix lint

* docs: Finish components overview page

* fix lint

* docs: Update cover

* fix lint

* update cover

* update menu

* improve overview page

* refactor code

* fix order

* update title

* add components count

* fix overview page ssr bug

* move less file

* update title margin

Co-authored-by: arvinxx <arvinx@foxmail.com>
2020-05-31 11:48:34 +08:00

3.8 KiB
Raw Blame History

category type title subtitle cover
Components 数据录入 Cascader 级联选择 https://gw.alipayobjects.com/zos/antfincdn/cOHaAyTQ3u/Cascader.svg

级联选择框。

何时使用

  • 需要从一组相关联的数据集合进行选择,例如省市区,公司层级,事物分类等。
  • 从一个较大的数据集合中进行选择时,用多级分类进行分隔,方便选择。
  • 比起 Select 组件,可以在同一个浮层中完成选择,有较好的体验。

API

<Cascader options={options} onChange={onChange} />
参数 说明 类型 默认值 版本
allowClear 是否支持清除 boolean true
autoFocus 自动获取焦点 boolean false
bordered 是否有边框 boolean true
changeOnSelect 当此项为 true 时,点选每级菜单选项值都会发生变化,具体见上面的演示 boolean false
className 自定义类名 string -
defaultValue 默认的选中项 string[] | number[] []
disabled 禁用 boolean false
displayRender 选择后展示的渲染函数 (label, selectedOptions) => ReactNode label => label.join(' / ')
expandTrigger 次级菜单的展开方式,可选 'click' 和 'hover' string 'click'
fieldNames 自定义 options 中 label name children 的字段 object { label: 'label', value: 'value', children: 'children' }
getPopupContainer 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例 Function(triggerNode) () => document.body
loadData 用于动态加载选项,无法与 showSearch 一起使用 (selectedOptions) => void -
notFoundContent 当下拉列表为空时显示的内容 string 'Not Found'
options 可选项数据源 Option[] -
placeholder 输入框占位文本 string '请选择'
popupClassName 自定义浮层类名 string -
popupPlacement 浮层预设位置:bottomLeft bottomRight topLeft topRight Enum bottomLeft
popupVisible 控制浮层显隐 boolean -
showSearch 在选择框中显示搜索框 boolean false
size 输入框大小 large | middle | small
style 自定义样式 CSSProperties -
suffixIcon 自定义的选择框后缀图标 ReactNode -
value 指定选中项 string[] | number[] -
onChange 选择完成后的回调 (value, selectedOptions) => void -
onPopupVisibleChange 显示/隐藏浮层的回调 (value) => void -

showSearch 为对象时,其中的字段:

参数 说明 类型 默认值 版本
filter 接收 inputValue path 两个参数,当 path 符合筛选条件时,应返回 true反之则返回 false。 function(inputValue, path): boolean
limit 搜索结果展示数量 number | false 50
matchInputWidth 搜索结果列表是否与输入框同宽 boolean
render 用于渲染 filter 后的选项 function(inputValue, path): ReactNode
sort 用于排序 filter 后的选项 function(a, b, inputValue)

Option

interface Option {
  value: string | number;
  label?: React.ReactNode;
  disabled?: boolean;
  children?: Option[];
}

方法

名称 描述 版本
blur() 移除焦点
focus() 获取焦点

注意,如果需要获得中国省市区数据,可以参考 china-division