0.0.22 • Published 6 years ago

@alicd/crui-select-field v0.0.22

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

category: Components type: UI Views component: Form chinese: 下拉框 english: SelectField

source: next-select

从指定的值列表中选择性输入,如果你不期望用户输入的值生效而仅仅是选择,那么使用Select. 同时可以使用Select的showSearch属性进行过滤。

dataSource的使用

Select同时支持children和在props中传入dataSource作为数据源,如果同时设置,则以children为准.

注意: Select默认使用value作为渲染的菜单项的key值,所以value不能重复, 否则无法渲染下拉菜单

  • children的方式
<SelectField>
    <Select.Option value="option1">option1</Select.Option>
    <Select.Option value="option2">option2</Select.Option>
    <Select.Option disabled={true}>disabled</Select.Option>
</SelectField>
  • props的方式
var dataSource = [
    {label:'option1', value:'option1},
    {label:'option2', value:'option2'},
    {label:'disabled', disabled:true}
]
<SelectField dataSource={dataSource}/>

API

SelectField

参数说明类型默认值
prefix样式类名的品牌前缀String'next-'
className自定义类名String-
style自定义内联样式Object-
size选择器的尺寸可选值:'small', 'medium', 'large'Enum'medium'
shape选择器的形状可选值:'normal', 'arrow-only'Enum'normal'
value当前值String/Array/ReactNode/Object-
defaultValue初始默认值String/Array/ReactNode/Object-
onChangeSelect发生改变的时候触发的回调签名:Function(value: String, option: Object) => void参数:value: {String} 数据option: {Object} 选项Function() => {}
container弹层挂载容器节点String/Function-
placeholder没有值的时候的占位符String''
visible当前弹层是否显示Boolean-
defaultVisible弹层初始是否显示Boolean-
disabled是否禁用Booleanfalse
readOnly是否只读,只读模式下可以展开弹层但不能选择booleanfalse
dataSource传入的数据,可以动态渲染子项,详见dataSource的使用Array-
multiple是否是多选Booleanfalse
compact多选状态(multipletrue)时,以单行形式展示已选项,并显示已选项数目。用来避免空间较窄且已选项较多时出现的样式问题。booleanfalse
fillProps填充到选择框里面的值String'label'
showSearch是否显示顶部的搜索框Booleanfalse
filterBy在输入的时候过滤的函数,仅在filterLocal为true时候有效签名:Function(filterValue: String, option: Object) => Boolean参数:filterValue: {String} 筛选值option: {Object} 选项返回值:{Boolean} 是否保留当前选项Function-
filterLocal是否使用本地过滤,在数据源为远程的时候需要关闭此选项Booleantrue
hasArrow是否显示右侧的箭头Booleantrue
autoWidth下拉菜单是否与选择器对齐Booleantrue
onSearch在搜索框中输入触发的事件,仅在showSearch为true时候有效签名:Function(value: String) => void参数:value: {String} 搜索值Function() => {}
hasClear是否显示清空按钮,该按钮可以清空select的value, 该属性仅在单选模式下有效Booleanfalse
popupClassName弹出层的样式类String-
popupProps弹出层的属性Object-
onVisibleChange弹层显示或隐藏的时候触发的事件签名:Function(visible: Boolean) => void参数:visible: {Boolean} 弹层是否隐藏和显示Function() => {}
onOpen弹层显示时触发的事件签名:Function() => voidFunction() => {}
onClose弹层隐藏时触发的事件签名:Function() => voidFunction() => {}
locale自定义国际化文案对象属性:selectPlaceHolder: {String} 请选择的提示文案comboboxPlaceHolder: {String} 请输入的提示文案Object{ selectPlaceHolder: '请选择', comboboxPlaceHolder: '请输入' }
language自定义国际化语言可选值:'en-us', 'zh-cn', 'zh-tw'Enum-
hasSelectAll是否显示全选功能, 多选模式下才生效 @ali/walle-components@0.0.78+有该功能Booleanfalse
selectAllText全选的文案,多选模式下才生效 @ali/walle-components@0.0.78+有该功能String简体:全选、繁体:全選、英文:Select All
cancelSelectAllText取消全选的文案,多选模式下才生效 @ali/walle-components@0.0.78+有该功能String简体:取消全选、繁体:取消全選、英文:Cancel
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-
inputStyle表单输入框自定义内联样式Object/Stringnull
showValidateType应用于Field 类元素后,指定其展示错误的方式,可选值有 helptooltip 两种Stringhelp
namewalle 模式下才支持 可以配合表单Form 收集表单元素的数据,要求表单必须指定 field 属性String''
ruleswalle 模式下才支持 配置表单规则,可以配置多个规则,可参考:async-validator,注意Form 表单必须配置field 属性才会生效Arraynull
x-bindwalle 模式下才支持 双向绑定某一个变量statenull

Select.Option

参数说明类型默认值
value选项值any-
disabled是否禁用Boolean-
children列表项显示的值,通过子标签的方式设置any-