@alicd/crui-input-field
v0.0.13
Published
输入框
Downloads
4
Readme
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 | 自定义class | String | - |
| 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事件对象 | Function | function() { } |
| disabled | 状态 设置文本域禁用状态 | Boolean | false |
| multiple | 是否为多行,不选则为单行 | Boolean | false |
| maxLength | 最大长度 | Number | null |
| hasLimitHint | 是否展现最大长度样式 | Boolean | false |
| cutString | 是否允许切割字符串 | Boolean | true |
| hasClear | 是否出现clear按钮 | Boolean | false |
| state | 状态(multiple模式不支持 loading/success 状态)可选值:'''error'(错误)'loading'(校验中)'success'(成功) | Enum | '' |
| htmlType | 原生type | String | 'text' |
| readOnly | 只读 | Boolean | false |
| trim | onChange返回会自动去除头尾空字符 | Boolean | false |
| addonBefore | 文本域前附加内容 | ReactNode | - |
| addonAfter | 文本域后附加内容 | ReactNode | - |
| placeholder | 输入提示 | String | - |
| onPressEnter | 按下回车的回调签名:Function() => void | Function | function() { } |
| onBlur | 失去焦点时候触发的回调签名:Function() => void | Function | function() { } |
| getValueLength | 自定义字符串计算长度方式签名:Function(value: String) => Number参数:value: {String} 数据返回值:{Number} 自定义长度 | Function | function() { } |
| rows | multiple多行文本框高度 (不要直接用height设置多行文本框的高度, ie9 10会有兼容性问题) | Number | 4 |
| textIndent | 文字缩进 | Number | - |
| prefix | 样式前缀 | String | 'next-' |
| className | 扩展class | String | - |
| style | 自定义内联样式 | Object | - |
| size | 单个FormItem的size自定义,优先级高于Form的size, 并且当组件与 FormItem 一起使用时,组件自身设置 size 属性无效。可选值:'', 'large', 'small', 'medium' | Enum | - |
| label | label 标签的文本 | ReactNode | - |
| labelCol | label 标签布局,通 <Col>
组件,设置 span offset 值,如 {span: 8, offset: 16},该项仅在垂直表单有效 | Object | - |
| help | 提示信息,如不设置,则会根据校验规则自动生成. 如果设置会受控(ps: 可以利用这点自定义错误位置,详细看demo自定义错误) | ReactNode | - |
| validateStatus | 校验状态,如不设置,则会根据校验规则自动生成可选值:'''success'(成功)'error'(失败)'loading'(校验中) | Enum | - |
| hasFeedback | 配合 validateStatus 属性使用,是否展示校验状态图标, 目前只有Input支持 | Boolean | false |
| wrapperCol | 需要为输入控件设置布局样式时,使用该属性,用法同 labelCol | Object | - |
| extra | 额外的提示信息,和 help 类似,当需要错误信息和提示文案同时出现时,可以使用这个。 位于错误信息后面 | ReactNode | - |
| inputStyle | 表单输入框自定义内联样式 | Object/String | null |
| showValidateType | 应用于Field 类元素后,指定其展示错误的方式,可选值有 help
、tooltip
两种| String | help
|
| name | walle 模式下才支持
可以配合表单Form 收集表单元素的数据,要求表单必须指定 field 属性 | String | '' |
| rules | walle 模式下才支持
配置表单规则,可以配置多个规则,可参考:async-validator,注意Form 表单必须配置field 属性才会生效 | Array | null |
| x-bind | walle 模式下才支持
双向绑定某一个变量 | state | null |