0.0.10 • Published 6 years ago
@alicd/crui-search-field v0.0.10
category: Components type: UI Views component: Form chinese: 搜索框 english: SearchField
source: next-search
搜索框， FormItem + Search【 @alicd/next 】 的功能融合，同时支持了 x-bind 双向绑定， rules 规则配置，name 表单 name 属性
API
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| prefix | 样式前缀 | String | 'next-' |
| className | 样式名称 | String | - |
| style | 自定义样式 | Object | - |
| size | 大小，可选 primary/secondary 可选择 medium/large; normal 可选择 small/medium | String | 'medium' |
| type | 类型可选值:'primary', 'secondary', 'normal' | Enum | 'primary' |
| value | 数值 | String/Number | - |
| defaultValue | 搜索框默认值 (不适用于Combox) | String | - |
| onChange | 输入关键字时的回掉签名:Function() => void | Function | function() { } |
| filter | 前置下拉框,default为默认选中项 [{text:'Products', value:'Products',default: true},{text:'Suppliers',valuse:'Suppliers'}] | Array | [] |
| searchIcon | 搜索按钮图标 | Boolean | - |
| searchText | 搜索按钮文案 | String | 'Search' |
| combox | 定制下拉框,适合业务特殊定制 | ReactNode | false |
| inputWidth | 搜索框宽度 | String/Number | 'auto' |
| showSearchBtn | 控制搜索按钮的展现 | Boolean | true |
| overlayVisible | 与combox配合使用,控制定制下拉框的展现 | Boolean | - |
| canCloseByOutSideClick | 与combox配合使用,控制是否可以通过点击文档其他区域收起下拉框 | Boolean | false |
| onRequestClose | 定制下拉框收起的时候出发的回调签名:Function() => void | Function | function() { } |
| dataSource | 下拉提示框:历史搜索/搜索建议 [{label:'',value:'',disabled:true}] | Array | [] |
| placeholder | 默认提示 | String | - |
| onInputFocus | input获取焦点的时候触发的回调签名:Function() => void | Function | function() { } |
| onInputBlur | input失去焦点的时候触发的回调签名:Function() => void | Function | function() { } |
| onSearch | 点击搜索按钮触发的回调签名:Function(object: Object) => void参数:object: {Object} {filter:'',key:''} | Function | function() { } |
| onFilterChange | Filter改变时的回掉（filterValue）签名:Function() => void | Function | function() { } |
| autoWidth | 搜索框100%自适应父容器 | Boolean | false |
| filterAutoWidth | filter的下拉菜单是否与选择器对齐 | Boolean | true |
| container | 指定渲染combox的容器 | ReactNode | - |
| 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 |
0.0.10
6 years ago