0.2.0 • Published 3 years ago
rc-category-cascader
概述
基于rc-cascader抽象出的通用级联选择器
安装
npm i rc-category-cascader --save
指令
API
参数 | 说明 | 类型 | 默认值 |
---|
options | 可选项数据源 | {},详见option | - |
steps | 步骤数据源 | {name:string/number},...,name:步骤显示文字 | - |
value | 指定选中项 | [] | - |
defaultValue | 默认值 | [] | - |
onChange | 完成选择后的回调 | (value:[], selectedOptions:[])=>void | - |
changeOnSelect | 点选每级菜单选项时,值都会发生变化 | boolean | false |
loadData | 单击任何选项时的回调,用于加载更多选项(主要用于动态加载) | (selectedOptions:[])=>void | - |
popupVisible | 浮层可见性 | boolean | false |
onPopupVisibleChange | 显示/隐藏浮层时的回调 | (visible:boolean)=>void | - |
transitionName | 像“slide-up”这样的过渡类名,定义浮层弹出效果 | string | - |
prefixCls | 浮层类名前缀 | string | rc-category-cascader |
popupClassName | 自定义浮层类名 | string | - |
popupPlacement | 浮层预设位置:bottomRight topRight bottomLeft topLeft | string | bottomLeft |
dropdownRender | 浮层渲染函数 | (menu: React.ReactElement) => React.ReactElement | - |
fieldNames | 自定义options中label、name、children的字段 | { label:string, value:string/number, children:string } | { label: 'label', value: 'value', children: 'children' } |
stepsIcon | 自定义步骤图标 | ReactNode | > |
loadingIcon | 自定义加载时图标 | ReactNode | 'loading...' |
disabled | 禁用 | boolean | false |
builtinPlacements | 自定义浮层位置 | {},详见自定义浮层位置 demo | BUILT_IN_PLACEMENTS |
onStepsClick | 点击步骤时触发的回调 | (step:{ name: string, index: number }) => void | - |
option
参数 | 说明 | 类型 | 默认值 |
---|
noChoice | 是否提供暂不选择选项。该选项为true时,暂不选择选项文本为“No Choice”;若为字符串(如:“暂不选择”),则相应文本为“暂不选择” | boolean/string | false |
loading | 数据源加载状态(一般和loadData结合使用) | boolean | false |
groupBy | 分组规则 | (groupList: []) => { group: string / number, data: [] }[] | - |
data | 数据源 | {}:dataOption,...,详见dataOption | - |
dataOption
参数 | 说明 | 类型 | 默认值 |
---|
value | 键值 | string/number | - |
label | 显示的选项文字 | string | - |
disabled | 禁用 | boolean | - |
isLeaf | 是否叶子结点 | boolean | - |
children | 子节点 | {}:option | - |