鸿蒙（HarmonyOS）项目方舟框架（ArkUI）之Search组件
一、操作环境
操作系统: Windows 10 专业版、IDE:DevEco Studio 3.1、SDK:HarmonyOS 3.1+
二、Search组件
鸿蒙（HarmonyOS）搜索框组件，适用于浏览器的搜索内容输入框等应用场景。
子组件
无子组件。
接口
Search(options?: { value?: string, placeholder?: string, icon?: string, controller?: SearchController })
参数
参数名 |
参数类型 |
必填 |
参数描述 |
value |
string |
否 |
设置当前显示的搜索文本内容。 |
placeholder |
string |
否 |
设置无输入时的提示文本。 |
icon |
string |
否 |
设置搜索图标路径，默认使用系统搜索图标。 说明： icon的数据源，支持本地图片和网络图片。 - 支持的图片格式包括png、jpg、bmp、svg、gif和pixelmap。 - 支持Base64字符串。格式data:image/[png|jpeg|bmp|webp];base64,[base64 data], 其中[base64 data]为Base64字符串数据。 |
controller |
SearchController |
否 |
设置Search组件控制器。 |
属性
除支持通用属性外，还支持以下属性：
名称 |
参数类型 |
描述 |
searchButton |
string |
搜索框末尾搜索按钮文本内容，默认无搜索按钮。 |
placeholderColor |
设置placeholder文本颜色。 |
|
placeholderFont |
设置搜索框内输入文本样式，包括字体大小，字体粗细，字体族，字体风格。目前仅支持默认字体族。 |
|
textFont |
设置搜索框内输入文本样式，包括字体大小，字体粗细，字体族，字体风格。目前仅支持默认字体族。 |
|
textAlign |
设置文本在搜索框中的对齐方式。 默认值：TextAlign.Start |
|
copyOption9+ |
设置输入的文本是否可复制。 |
事件
除支持通用事件外，还支持以下事件：
名称 |
功能描述 |
onSubmit(callback: (value: string) => void) |
点击搜索图标、搜索按钮或者按下软键盘搜索按钮时触发该回调。 -value: 当前搜索框中输入的文本内容。 |
onChange(callback: (value: string) => void) |
输入内容发生变化时，触发该回调。 -value: 当前搜索框中输入的文本内容。 |
onCopy(callback: (value: string) => void) |
长按搜索框弹出剪切板之后，点击剪切板的复制按钮触发该回调。 -value: 复制的文本内容。 |
onCut(callback: (value: string) => void) |
长按搜索框弹出剪切板之后，点击剪切板的剪切按钮触发该回调。 -value: 剪切的文本内容。 |
onPaste(callback: (value: string) => void) |
长按搜索框弹出剪切板之后，点击剪切板的粘贴按钮触发该回调。 -value: 粘贴的文本内容。 |
SearchController
Search组件的控制器，目前通过它可控制Search组件的光标位置。
导入对象
controller: SearchController = new SearchController()
caretPosition
caretPosition(value: number): void
设置输入光标的位置。
参数
参数名 |
参数类型 |
必填 |
参数描述 |
value |
number |
是 |
从字符串开始到光标所在位置的长度。 |
示例
代码
// xxx.ets @Entry @Component struct SearchExample { @State changeValue: string = '' @State submitValue: string = '' controller: SearchController = new SearchController() build() { Column() { Text('onSubmit:' + this.submitValue).fontSize(18).margin(15) Text('onChange:' + this.changeValue).fontSize(18).margin(15) Search({ value: this.changeValue, placeholder: 'Type to search...', controller: this.controller }) .searchButton('SEARCH') .width(400) .height(40) .backgroundColor('#F5F5F5') .placeholderColor(Color.Grey) .placeholderFont({ size: 14, weight: 400 }) .textFont({ size: 14, weight: 400 }) .onSubmit((value: string) => { this.submitValue = value }) .onChange((value: string) => { this.changeValue = value }) .margin(20) Button('Set caretPosition 1') .onClick(() => { // 设置光标位置到输入的第一个字符后 this.controller.caretPosition(1) }) }.width('100%') } }
你有时间常去我家看看我在这里谢谢你啦...
我家地址:亚丁号
最后送大家一首诗:
山高路远坑深,
大军纵横驰奔,
谁敢横刀立马？
惟有点赞加关注大军。
