0.0.13 • Published 6 years ago

@alicd/crui-input-field v0.0.13

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

category: Components type: UI Views component: Form chinese: 输入框 english: InputField

source: next-input

输入框, FormItem + Input【 @alicd/next 】 的功能融合,同时支持了 x-bind 双向绑定, rules 规则配置,配置表单 name 属性

API

参数说明类型默认值
prefix样式前缀String'next-'
className自定义classString-
style自定义内联样式Object-
size尺寸可选值:'small'(小)'medium'(中)'large'(大)Enum'medium'
value当前值String/Number-
defaultValue初始化值String/Number-
onChange发生改变的时候触发的回调签名:Function(value: String, e: Event) => void参数:value: {String} 数据e: {Event} DOM事件对象Functionfunction() { }
disabled状态 设置文本域禁用状态Booleanfalse
multiple是否为多行,不选则为单行Booleanfalse
maxLength最大长度Numbernull
hasLimitHint是否展现最大长度样式Booleanfalse
cutString是否允许切割字符串Booleantrue
hasClear是否出现clear按钮Booleanfalse
state状态(multiple模式不支持 loading/success 状态)可选值:'''error'(错误)'loading'(校验中)'success'(成功)Enum''
htmlType原生typeString'text'
readOnly只读Booleanfalse
trimonChange返回会自动去除头尾空字符Booleanfalse
addonBefore文本域前附加内容ReactNode-
addonAfter文本域后附加内容ReactNode-
placeholder输入提示String-
onPressEnter按下回车的回调签名:Function() => voidFunctionfunction() { }
onBlur失去焦点时候触发的回调签名:Function() => voidFunctionfunction() { }
getValueLength自定义字符串计算长度方式签名:Function(value: String) => Number参数:value: {String} 数据返回值:{Number} 自定义长度Functionfunction() { }
rowsmultiple多行文本框高度 (不要直接用height设置多行文本框的高度, ie9 10会有兼容性问题)Number4
textIndent文字缩进Number-
prefix样式前缀String'next-'
className扩展classString-
style自定义内联样式Object-
size单个FormItem的size自定义,优先级高于Form的size, 并且当组件与 FormItem 一起使用时,组件自身设置 size 属性无效。可选值:'', 'large', 'small', 'medium'Enum-
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