0.2.0 • Published 3 years ago

rc-category-cascader v0.2.0

Weekly downloads
28
License
-
Repository
-
Last release
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点选每级菜单选项时,值都会发生变化booleanfalse
loadData单击任何选项时的回调,用于加载更多选项(主要用于动态加载)(selectedOptions:[])=>void-
popupVisible浮层可见性booleanfalse
onPopupVisibleChange显示/隐藏浮层时的回调(visible:boolean)=>void-
transitionName像“slide-up”这样的过渡类名,定义浮层弹出效果string-
prefixCls浮层类名前缀stringrc-category-cascader
popupClassName自定义浮层类名string-
popupPlacement浮层预设位置:bottomRight topRight bottomLeft topLeftstringbottomLeft
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禁用booleanfalse
builtinPlacements自定义浮层位置{},详见自定义浮层位置demoBUILT_IN_PLACEMENTS
onStepsClick点击步骤时触发的回调(step:{ name: string, index: number }) => void-

option

参数说明类型默认值
noChoice是否提供暂不选择选项。该选项为true时,暂不选择选项文本为“No Choice”;若为字符串(如:“暂不选择”),则相应文本为“暂不选择”boolean/stringfalse
loading数据源加载状态(一般和loadData结合使用)booleanfalse
groupBy分组规则(groupList: []) => { group: string / number, data: [] }[]-
data数据源{}:dataOption,...,详见dataOption-

dataOption

参数说明类型默认值
value键值string/number-
label显示的选项文字string-
disabled禁用boolean-
isLeaf是否叶子结点boolean-
children子节点{}:option-