Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5af70cef
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
5af70cef
编写于
3月 21, 2022
作者:
Y
yaoyuchi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add search docs
Signed-off-by:
N
yaoyuchi
<
yaoyuchi@huawei.com
>
上级
b8924e5c
变更
2
显示空白变更内容
内联
并排
Showing
2 changed file
with
102 addition
and
0 deletion
+102
-0
zh-cn/application-dev/reference/arkui-ts/Readme-CN.md
zh-cn/application-dev/reference/arkui-ts/Readme-CN.md
+1
-0
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
...tion-dev/reference/arkui-ts/ts-basic-components-search.md
+101
-0
未找到文件。
zh-cn/application-dev/reference/arkui-ts/Readme-CN.md
浏览文件 @
5af70cef
...
...
@@ -62,6 +62,7 @@
-
[
QRCode
](
ts-basic-components-qrcode.md
)
-
[
Radio
](
ts-basic-components-radio.md
)
-
[
Rating
](
ts-basic-components-rating.md
)
-
[
Search
](
ts-basic-components-search.md
)
-
[
Select
](
ts-basic-components-select.md
)
-
[
Slider
](
ts-basic-components-slider.md
)
-
[
Span
](
ts-basic-components-span.md
)
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
0 → 100644
浏览文件 @
5af70cef
# Search
> ![](public_sys-resources/icon-note.gif) **说明:** 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供搜索框组件,用于提供用户搜索内容的输入区域。
## 权限列表
无
## 子组件
无
## 接口
Search(options?: { value?: string; placeholder?: string; icon?: string; controller?: SearchController })
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | string | 否 | - | 搜索文本值。 |
| placeholder | string | 否 | - | 无输入时的提示文本。|
| icon | string | 否 | - | 搜索图标路径,默认使用系统搜索图标,支持的图标格式: svg, jpg和png。 |
| controller | SearchController | 否 | - | 控制器。|
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| searchButton | string | 无 | 搜索框末尾搜索按钮文本值,默认无搜索按钮。|
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md#ResourceColor
)
| - | 设置placeholder颜色。|
| placeholderFont |
[
Font
](
../../ui/ts-types.md#Font
)
| - | 设置placeholder文本样式。|
| textFont |
[
Font
](
../../ui/ts-types.md#Font
)
| - | 设置搜索框内文本样式。|
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onSubmit(callback: (value: string) => void) | 点击搜索图标、搜索按钮或者按下软键盘搜索按钮时触发。
<br>
-value: 当前输入文本框的内容。|
| onChange(callback: (value: string) => void) | 输入内容发生变化时,触发回调。
<br>
-value: 当前输入文本框的内容。|
| onCopy(callback: (value: string) => void) | 组件触发系统剪切板复制操作。
<br>
-value: 复制的文本内容。|
| onCut(callback: (value: string) => void) | 组件触发系统剪切板剪切操作。
<br>
-value: 剪切的文本内容。|
| onPaste(callback: (value: string) => void) | 组件触发系统剪切板粘贴操作。
<br>
-value: 粘贴的文本内容。|
## SearchController
Search组件的控制器,通过它操作Search组件。
#### 导入对象
```
controller: SearchController = new SearchController()
```
#### caretPosition
creatPosition(value: number): viod
设置输入光标的位置。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------ | ---- | ---- | --------------------- |
| value | number | 是 | - | 从字符串开始到光标所在位置的长度。 |
## 示例
```
@Entry
@Component
struct SearchExample {
@State changevalue: string = ''
@State submitvalue: string = ''
controller: SearchController = new SearchController()
build() {
Flex({ direction: FlexDirection.Row, justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) {
Text(this.submitvalue)
Text(this.changevalue)
Search({value: '', placeholder: 'Type to search', controller: this.controller})
.searchButton('Search')
.width(400)
.height(35)
.backgroundColor(Color.White)
.placeholderColor(Color.Grey)
.placeholderFont({ size: 50, weight: 10, family: 'serif', style: FontStyle.Normal })
.onSubmit((value: string) => {
this.submitvalue = value
})
.onChange((value: string) => {
this.changevalue = value
})
.margin({ top: 30 })
}
}
}
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录