搜索

介绍

用于用户输入搜索关键字和搜索确认的组件。

API

Props

Props 属性

参数	说明	类型	默认值
默认状态	组件的状态, "默认"|"禁用"|"隐藏"|"只读"	string	'default'
默认值	组件的默认值类型，"自定义"|"公式编辑"	string	'custom'
编辑默认值	组件的默认值配置，支持绑定变量	string	-
占位提示	配置组件占位符的文案	string	-
最大字符数	配置组件控制最多可输入的字符数	number	-
是否启用清除	是否开启清除功能	boolean	true
清除图标	清除按钮处显示的图标名	boolean	true
是否在获得焦点时才显示清除图标	显示清除图标一个必要条件是输入框中有值，此处为配置显示清除图标的另一个必要条件是否生效	boolean	false
是否在搜索框右侧显示取消按钮	控制是否显示输入框右侧的取消按钮	boolean	false
取消按钮文字	取消按钮中文字“取消”还可以改为其他文案	string	-
是否将输入内容标红	控制输入框中输入内容变为红色，支持变量绑定	boolean	false
底部错误提示文案	配置输入框底部的错误提示文案，为空时不显示错误提示	string	-
输入框内容对齐方式	输入框内容的对齐方式。"居左"|"居中"|"居右"	string	"left"
输入框左侧图标	输入框左侧图标名	string	-
输入框右侧图标	输入框右侧侧图标名	string	-

Props 样式

参数	说明	类型	默认值
自定义样式	整体自定义样式	string	-
搜索框形状	设置搜索框边角形状	string	"方角"
搜索框外部背景色	搜索框外部背景色	string	-

Props 高级

参数	说明	类型	默认值
唯一标识	组件的唯一标识	string	-
输入内容格式化	以函数方式控制输入内容格式化的逻辑	(ctx, params) => string	params（即输入内容）
格式化触发时机	内容格式化触发的时机。"内容变化"|"失去焦点"	string	"内容变化"
循环	循环渲染设置	-	-

Events

事件名	说明	回调参数
onSearch	确定搜索时触发	ctx, params: { value:string }, loopDataList: LoopData[]
onChange	输入框内容变化时触发	ctx, params: { value:string }, loopDataList: LoopData[]
onFocus	获得焦点时触发	ctx, params: FocusEvent, loopDataList: LoopData[]
onBlur	失去焦点时触发	ctx, params: FocusEvent, loopDataList: LoopData[]
onClickInput	点击输入区域时触发	ctx, params: PointerEvent, loopDataList: LoopData[]
onClickLeftIcon	点击左侧图标时触发	ctx, params: PointerEvent, loopDataList: LoopData[]
onClickRightIcon	点击右侧图标时触发	ctx, params: PointerEvent, loopDataList: LoopData[]
onClear	点击清除按钮时触发	ctx, params: PointerEvent, loopDataList: LoopData[]
onCancel	点击取消按钮时触发	ctx, params: PointerEvent, loopDataList: LoopData[]

Methods

方法名	描述	参数	返回值
focus	获取焦点	-	-

Type

LoopData

参数名	描述	类型
indexName	索引变量名	string
paramName	迭代变量名	string
row	当前迭代数据元素	any
rowIndex	当前迭代数据索引	any
ref	完整循环数组数据	ComputedRefImpl<Array>