0.0.17 • Published 6 years ago

@alicd/crui-cascader-select-field v0.0.17

Weekly downloads
-
License
ISC
Repository
-
Last release
6 years ago

category: Components type: UI Views component: Form chinese: 级联选择框 english: CascaderSelectField

source: next-cascader-select

级联选择框,next-cascader-select + FormItem 的功能整和,同时支持了 x-bind 双向绑定, rules 规则配置,配置表单 name 属性

API

参数说明类型默认值
prefix样式类名的品牌前缀String'next-'
className自定义类名String-
style自定义内联样式Object-
size选择框大小可选值:'small', 'medium', 'large'Enum'medium'
shape选择框形状可选值:'normal', 'arrow-only'Enum'normal'
value(受控)当前值String/Array<String>-
defaultValue(非受控)默认值String/Array<String>null
onChange选中值改变时触发的回调函数签名:Function(value: String/Array, data: Object/Array, extra: Object) => void参数:value: {String/Array} 选中的值,单选时返回单个值,多选时返回数组data: {Object/Array} 选中的数据,包括 value 和 label,单选时返回单个值,多选时返回数组,父子节点选中关联时,同时选中,只返回父节点extra: {Object} 额外参数extra.selectedPath: {Array} 单选时选中的数据的路径extra.checked: {Boolean} 多选时当前的操作是选中还是取消选中extra.currentData: {Object} 多选时当前操作的数据extra.checkedData: {Array} 多选时所有被选中的数据extra.indeterminateData: {Array} 多选时半选的数据Function-
placeholder选择框占位符String-
disabled是否禁用Booleanfalse
hasArrow是否显示右侧的箭头Booleantrue
hasClear是否显示清空按钮,该按钮可以清空当前选中的值,该属性仅在单选模式下有效Booleanfalse
dataSource数据源,结构可参考下方说明Array<Object>[]
defaultVisible初始下拉框是否显示Booleanfalse
initValue默认值anynull
defaultExpandedValue默认展开值,如果不设置,组件内部会根据 defaultValue/value 进行自动设置Array<String>-
expandTrigger展开触发的方式可选值:'click', 'hover'Enum'click'
multiple是否多选Booleanfalse
changeOnSelect是否选中即发生改变, 该属性仅在单选模式下有效Booleanfalse
canOnlyCheckLeaf是否只能勾选叶子项的checkbox,该属性仅在多选模式下有效Booleanfalse
checkStrictly父子节点是否选中不关联Booleanfalse
labelWidth文字区域宽度,当文字超过宽度时,结尾会以省略号显示,默认值为文字实际宽度String/Number-
showItemCount每一列展示的个数String/Number6
displayRender选择框单选时展示结果的函数签名:Function(label: Array) => ReactNode参数:label: {Array} 选中路径的文本数组返回值:{ReactNode} 渲染在选择框中的内容Functionlabel => label.join(' / ')
popupClassName下拉框样式自定义类名String-
container下拉框挂载的容器节点String/Function-
loadData异步加载数据函数签名:Function(data: Object) => void参数:data: {Object} 当前点击异步加载的数据Function-
labellabel 标签的文本ReactNode-
labelCollabel 标签布局,通 <Col> 组件,设置 span offset 值,如 {span: 8, offset: 16},该项仅在垂直表单有效Object-
help提示信息,如不设置,则会根据校验规则自动生成. 如果设置会受控(ps: 可以利用这点自定义错误位置,详细看demo自定义错误)ReactNode-
validateStatus校验状态,如不设置,则会根据校验规则自动生成可选值:'''success'(成功)'error'(失败)'loading'(校验中)Enum-
hasFeedback配合 validateStatus 属性使用,是否展示校验状态图标, 目前只有Input支持Booleanfalse
wrapperCol需要为输入控件设置布局样式时,使用该属性,用法同 labelColObject-
extra额外的提示信息,和 help 类似,当需要错误信息和提示文案同时出现时,可以使用这个。 位于错误信息后面ReactNode-
showValidateType应用于Field 类元素后,指定其展示错误的方式,可选值有 helptooltip 两种Stringhelp
namewalle 模式下才支持 可以配合表单Form 收集表单元素的数据,要求表单必须指定 field 属性String''
ruleswalle 模式下才支持 配置表单规则,可以配置多个规则,可参考:async-validator,注意Form 表单必须配置field 属性才会生效Arraynull
x-bindwalle 模式下才支持 双向绑定某一个变量statenull