Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
3a9ba0dc
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看板
未验证
提交
3a9ba0dc
编写于
7月 03, 2023
作者:
O
openharmony_ci
提交者:
Gitee
7月 03, 2023
浏览文件
操作
浏览文件
下载
差异文件
!20374 TextInput TextArea Search RN需求新增文档
Merge pull request !20374 from 张潇/dev_703
上级
101462d4
4a5bccd7
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
34 addition
and
7 deletion
+34
-7
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
...tion-dev/reference/arkui-ts/ts-basic-components-search.md
+16
-7
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
...on-dev/reference/arkui-ts/ts-basic-components-textarea.md
+9
-0
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
...n-dev/reference/arkui-ts/ts-basic-components-textinput.md
+9
-0
未找到文件。
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
浏览文件 @
3a9ba0dc
...
...
@@ -40,6 +40,7 @@ Search(options?: { value?: string; placeholder?: ResourceStr; icon?: string; con
| fontColor
<sup>
10+
</sup>
|
[
ResourceColor
](
ts-types.md#resourcecolor
)
| 设置输入文本的字体颜色。 |
| caretStyle
<sup>
10+
</sup>
|
[
CaretStyle
](
#caretstyle10对象说明
)
| 设置光标样式。 |
| enableKeyboardOnFocus
<sup>
10+
</sup>
| boolean | Search获焦时,是否绑定输入法
<br/>
默认值:true。从API version 10开始,获焦默认绑定输入法。 |
| selectionMenuHidden
<sup>
10+
</sup>
| boolean | 设置长按输入框或者右键输入框时,是否弹出文本选择菜单。
<br
/>
默认值:false |
## IconOptions<sup>10+</sup>对象说明
| 参数名 | 参数类型 | 必填 | 参数描述 |
...
...
@@ -74,13 +75,15 @@ Search(options?: { value?: string; placeholder?: ResourceStr; icon?: string; con
除支持
[
通用事件
](
ts-universal-events-click.md
)
外,还支持以下事件:
| 名称 | 功能描述 |
| ---------------------------------------- | ---------------------------------------- |
| 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: 粘贴的文本内容。 |
| 名称 | 功能描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| 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: 粘贴的文本内容。 |
| onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)
<sup>
10+
</sup>
| 文本选择的位置发生变化时,触发该回调。
<br
/>
selectionStart:文本选择区域起始位置,文本框中文字的起始位置为0。
<br
/>
selectionEnd:文本选择区域结束位置。 |
| onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)
<sup>
10+
</sup>
| 文本内容滚动时,触发该回调。
<br
/>
totalOffsetX:文本在内容区的横坐标偏移。
<br
/>
totalOffsetY:文本在内容区的纵坐标偏移。 |
## SearchController
...
...
@@ -102,6 +105,12 @@ caretPosition(value: number): void
| ------ | -------- | ---- | ---------------------------------- |
| value | number | 是 | 从字符串开始到光标所在位置的长度。 |
### stopEditing<sup>10+</sup>
stopEditing(): void
退出编辑态。
## 示例
### 示例1
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
浏览文件 @
3a9ba0dc
...
...
@@ -41,6 +41,7 @@ TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Tex
| showCounter
<sup>
10+
</sup>
| boolean | 设置文本最大输入字符数后,是否显示字数。
<br/>
默认值:false |
| style
<sup>
10+
</sup>
|
[
TextContentStyle
](
ts-appendix-enums.md#textcontentstyle10
)
| 设置文本框多态样式。
<br/>
默认值:TextContentStyle.DEFAULT |
| enableKeyboardOnFocus
<sup>
10+
</sup>
| boolean | TextArea获焦时,是否绑定输入法
<br/>
默认值:true。从API version 10开始,获焦默认绑定输入法。 |
| selectionMenuHidden
<sup>
10+
</sup>
| boolean | 设置长按输入框或者右键输入框时,是否弹出文本选择菜单。
<br
/>
默认值:false |
> **说明:**
>
...
...
@@ -57,6 +58,8 @@ TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Tex
| onCopy
<sup>
8+
</sup>
(callback:(value:
string)
=
>
void) | 长按输入框内部区域弹出剪贴板后,点击剪切板复制按钮,触发该回调。
<br/>
- value:复制的文本内容。 |
| onCut
<sup>
8+
</sup>
(callback:(value:
string)
=
>
void) | 长按输入框内部区域弹出剪贴板后,点击剪切板剪切按钮,触发该回调。
<br/>
- value:剪切的文本内容。 |
| onPaste
<sup>
8+
</sup>
(callback:(value:
string)
=
>
void) | 长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮,触发该回调。
<br/>
- value:粘贴的文本内容。 |
| onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)
<sup>
10+
</sup>
| 文本选择的位置发生变化时,触发该回调。
<br
/>
selectionStart:文本选择区域起始位置,文本框中文字的起始位置为0。
<br
/>
selectionEnd:文本选择区域结束位置。 |
| onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)
<sup>
10+
</sup>
| 文本内容滚动时,触发该回调。
<br
/>
totalOffsetX:文本在内容区的横坐标偏移。
<br
/>
totalOffsetY:文本在内容区的纵坐标偏移。 |
## TextAreaController<sup>8+</sup>
...
...
@@ -93,6 +96,12 @@ setTextSelection(selectionStart: number, selectionEnd: number): void
| selectionStart | number | 是 | 文本选择区域起始位置,文本框中文字的起始位置为0。
<br/>
当selectionStart小于0时、按照0处理;当selectionStart大于文字最大长度时、按照文字最大长度处理。
<br/>
|
| selectionEnd | number | 是 | 文本选择区域结束位置。
<br/>
当selectionEnd小于0时、按照0处理;当selectionEnd大于文字最大长度时、按照文字最大长度处理。
<br/>
|
### stopEditing<sup>10+</sup>
stopEditing(): void
退出编辑态。
## 示例
```
ts
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
浏览文件 @
3a9ba0dc
...
...
@@ -50,6 +50,7 @@ TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Te
| showUnderline
<sup>
10+
</sup>
| boolean | 设置是否开启下划线。
<br/>
默认值:false |
| passwordIcon
<sup>
10+
</sup>
|
[
PasswordIcon
](
#passwordicon10对象说明
)
| 密码输入模式时,设置输入框末尾的图标。
<br/>
默认为系统提供的密码图标。 |
| enableKeyboardOnFocus
<sup>
10+
</sup>
| boolean | TextInput获焦时,是否绑定输入法
<br/>
默认值:true。从API version 10开始,获焦默认绑定输入法。 |
| selectionMenuHidden
<sup>
10+
</sup>
| boolean | 设置长按输入框或者右键输入框时,是否弹出文本选择菜单。
<br
/>
默认值:false |
> **说明:**
>
...
...
@@ -102,6 +103,8 @@ TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Te
| onCopy(callback:(value:
string)
=
>
void)
<sup>
8+
</sup>
| 长按输入框内部区域弹出剪贴板后,点击剪切板复制按钮,触发该回调。
<br/>
value:复制的文本内容。 |
| onCut(callback:(value:
string)
=
>
void)
<sup>
8+
</sup>
| 长按输入框内部区域弹出剪贴板后,点击剪切板剪切按钮,触发该回调。
<br/>
value:剪切的文本内容。 |
| onPaste(callback:(value:
string)
=
>
void)
<sup>
8+
</sup>
| 长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮,触发该回调。
<br/>
value:粘贴的文本内容。 |
| onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void)
<sup>
10+
</sup>
| 文本选择的位置发生变化时,触发该回调。
<br
/>
selectionStart:文本选择区域起始位置,文本框中文字的起始位置为0。
<br
/>
selectionEnd:文本选择区域结束位置。 |
| onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void)
<sup>
10+
</sup>
| 文本内容滚动时,触发该回调。
<br
/>
totalOffsetX:文本在内容区的横坐标偏移。
<br
/>
totalOffsetY:文本在内容区的纵坐标偏移。 |
## TextInputController<sup>8+</sup>
...
...
@@ -135,6 +138,12 @@ setTextSelection(selectionStart: number, selectionStart: number): void
| selectionStart | number | 是 | 文本选择区域起始位置,文本框中文字的起始位置为0。 |
| selectionEnd | number | 是 | 文本选择区域结束位置。 |
### stopEditing<sup>10+</sup>
stopEditing(): void
退出编辑态。
## 示例
```
ts
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录