• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# search
2
3>  **说明:**
4>  从API version 4开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
5
6提供搜索框组件,用于提供用户搜索内容的输入区域。
7
8
9## 子组件
10
11不支持。
12
13
14## 属性
15
16除支持[通用属性](../arkui-js/js-components-common-attributes.md)外,还支持如下属性:
17
18| 名称                        | 类型                      | 默认值  | 必填   | 描述                                |
19| ------------------------- | ----------------------- | ---- | ---- | --------------------------------- |
20| icon                      | string                  | -    | 否    | 搜索图标,默认使用系统搜索图标,图标格式为svg,jpg和png。 |
21| hint                      | string                  | -    | 否    | 搜索提示文字。                           |
22| value                     | string                  | -    | 否    | 搜索框搜索文本值。                         |
23| searchbutton<sup>5+</sup> | string                  | -    | 否    | 搜索框末尾搜索按钮文本值。                     |
24| menuoptions<sup>5+</sup>  | Array&lt;MenuOption&gt; | -    | 否    | 设置文本选择弹框点击更多按钮之后显示的菜单项。           |
25
26**表1** MenuOption<sup>5+</sup>
27
28| 名称      | 类型     | 描述          |
29| ------- | ------ | ----------- |
30| icon    | string | 菜单选项中的图标路径。 |
31| content | string | 菜单选项中的文本内容。 |
32
33
34## 样式
35
36除支持[通用样式](../arkui-js/js-components-common-styles.md)外,还支持如下样式:
37
38| 名称                       | 类型                         | 默认值             | 必填   | 描述                                       |
39| ------------------------ | -------------------------- | --------------- | ---- | ---------------------------------------- |
40| color                    | &lt;color&gt;              | \#e6000000      | 否    | 搜索框的文本颜色。                                |
41| font-size                | &lt;length&gt;             | 16px            | 否    | 搜索框的文本尺寸。                                |
42| allow-scale              | boolean                    | true            | 否    | 搜索框的文本尺寸是否跟随系统设置字体缩放尺寸进行放大缩小。<br/>如果在config描述文件中针对ability配置了fontSize的config-changes标签,则应用不会重启而直接生效。 |
43| placeholder-color        | &lt;color&gt;              | \#99000000<br/> | 否    | 搜索框的提示文本颜色。                              |
44| font-weight              | number&nbsp;\|&nbsp;string | normal          | 否    | 搜索框的字体粗细,见text组件[font-weight](../arkui-js/js-components-basic-text.md#样式)的样式属性。 |
45| font-family              | string                     | sans-serif      | 否    | 搜索框的字体列表,用逗号分隔,每个字体用字体名或者字体族名设置。列表中第一个系统中存在的或者通过[自定义字体](../arkui-js/js-components-common-customizing-font.md)指定的字体,会被选中作为文本的字体。 |
46| caret-color<sup>6+</sup> | &lt;color&gt;              | -               | 否    | 设置输入光标的颜色。                               |
47
48
49## 事件
50
51除支持[通用事件](../arkui-js/js-components-common-events.md)外,还支持如下事件:
52
53| 名称                        | 参数                                       | 描述                                       |
54| ------------------------- | ---------------------------------------- | ---------------------------------------- |
55| change                    | {&nbsp;text:newText&nbsp;}               | 输入内容发生变化时触发。<br/>改变value属性值不会触发该回调。      |
56| submit                    | {&nbsp;text:submitText&nbsp;}            | 点击搜索图标、搜索按钮<sup>5+</sup>或者按下软键盘搜索按钮时触发。  |
57| translate<sup>5+</sup>    | {&nbsp;value:&nbsp;selectedText&nbsp;}   | 设置此事件后,进行文本选择操作后文本选择弹窗会出现翻译按钮,点击翻译按钮之后,触发该回调,返回选中的文本内容。 |
58| share<sup>5+</sup>        | {&nbsp;value:&nbsp;selectedText&nbsp;}   | 设置此事件后,进行文本选择操作后文本选择弹窗会出现分享按钮,点击分享按钮之后,触发该回调,返回选中的文本内容。 |
59| search<sup>5+</sup>       | {&nbsp;value:&nbsp;selectedText&nbsp;}   | 设置此事件后,进行文本选择操作后文本选择弹窗会出现搜索按钮,点击搜索按钮之后,触发该回调,返回选中的文本内容。 |
60| optionselect<sup>5+</sup> | {&nbsp;index:optionIndex,&nbsp;value:&nbsp;selectedText&nbsp;} | 文本选择弹窗中设置menuoptions属性后,用户在文本选择操作后,点击菜单项后触发该回调,返回点击的菜单项序号和选中的文本内容。 |
61
62
63## 方法
64
65支持[通用方法](../arkui-js/js-components-common-methods.md)。
66
67
68## 示例
69
70```html
71<!-- xxx.hml -->
72<div class="container">
73  <search hint="请输入搜索内容" searchbutton="搜索" @search="search">
74  </search>
75</div>
76```
77
78```css
79/* xxx.css */
80.container {
81  display: flex;
82  justify-content: center;
83  align-items: center;
84}
85```
86
87![zh-cn_image_0000001153427082](figures/zh-cn_image_0000001153427082.png)
88