Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Tonvia
Docs
提交
fcaf99dc
D
Docs
项目概览
Tonvia
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
0
Fork
0
代码
文件
提交
分支
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看板
体验新版 GitCode，发现更多精彩内容 >>
提交
fcaf99dc
编写于
9月 05, 2022
作者:
G
gmy
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
gmy
<
guanmingyue@h-partners.com
>
上级
e73dc8a0
变更
16
隐藏空白更改
内联
并排
Showing
16 changed file
with
343 addition
and
388 deletion
+343
-388
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md
...tion-dev/reference/arkui-ts/ts-basic-components-slider.md
+37
-39
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
...cation-dev/reference/arkui-ts/ts-basic-components-span.md
+15
-17
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
...cation-dev/reference/arkui-ts/ts-basic-components-text.md
+25
-26
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
...on-dev/reference/arkui-ts/ts-basic-components-textarea.md
+31
-33
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
...n-dev/reference/arkui-ts/ts-basic-components-textinput.md
+58
-56
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md
...-dev/reference/arkui-ts/ts-basic-components-textpicker.md
+14
-17
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md
...-dev/reference/arkui-ts/ts-basic-components-timepicker.md
+11
-14
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
.../reference/arkui-ts/ts-basic-gestures-longpressgesture.md
+12
-21
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
...on-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
+41
-43
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
...-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
+12
-22
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
...v/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
+17
-19
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
...-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
+22
-24
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
...on-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
+10
-13
zh-cn/application-dev/reference/arkui-ts/ts-container-ability-component.md
...-dev/reference/arkui-ts/ts-container-ability-component.md
+8
-9
zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
...n-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
+17
-16
zh-cn/application-dev/reference/arkui-ts/ts-container-column.md
...application-dev/reference/arkui-ts/ts-container-column.md
+13
-19
未找到文件。
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md
浏览文件 @
fcaf99dc
# Slider
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
滑动条组件，用来快速调节设置值，如音量、亮度等。
## 权限列表
无
> **说明：**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -19,38 +14,40 @@
## 接口
Slider(options
:
{value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis, reverse?: boolean})
Slider(options
?:
{value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis, reverse?: boolean})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 否 | 0 | 当前进度值。 |
| min | number | 否 | 0 | 设置最小值。 |
| max | number | 否 | 100 | 设置最大值。 |
| step | number | 否 | 1 | 设置Slider滑动跳动值，当设置相应的step时，Slider为间歇滑动。 |
| style | SliderStyle | 否 | SliderStyle.OutSet | 设置Slider的滑块样式。 |
| direction
<sup>
8+
</sup>
|
[
Axis
](
ts-appendix-enums.md#axis
)
| 否 | Axis.Horizontal | 设置滑动条滑动方向为水平或竖直方向。 |
| reverse
<sup>
8+
</sup>
| boolean | 否 | false | 设置滑动条取值范围是否反向。 |
**参数：**
-
SliderStyle枚举说明
| 名称 | 描述 |
| -------- | -------- |
| OutSet | 滑块在滑轨上。 |
| InSet | 滑块在滑轨内。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| value | number | 否 | 当前进度值。
<br/>
默认值：0 |
| min | number | 否 | 设置最小值。
<br/>
默认值：0 |
| max | number | 否 | 设置最大值。
<br/>
默认值：100 |
| step | number | 否 | 设置Slider滑动跳动值，当设置相应的step时，Slider为间歇滑动。
<br/>
默认值：1 |
| style | SliderStyle | 否 | 设置Slider的滑块样式。
<br/>
默认值：SliderStyle.OutSet |
| direction
<sup>
8+
</sup>
|
[
Axis
](
ts-appendix-enums.md#axis
)
| 否 | 设置滑动条滑动方向为水平或竖直方向。
<br/>
默认值：Axis.Horizontal |
| reverse
<sup>
8+
</sup>
| boolean | 否 | 设置滑动条取值范围是否反向。
<br/>
默认值：false |
## SliderStyle枚举说明
| 名称 | 描述 |
| -------- | -------- |
| OutSet | 滑块在滑轨上。 |
| InSet | 滑块在滑轨内。 |
## 属性
不支持触摸热区设置。
| 名称 | 参数类型 |
默认值 |
描述 |
| -------- | -------- | -------- |
-------- |
| blockColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
|
- |
设置滑块的颜色。 |
| trackColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
|
- |
设置滑轨的背景颜色。 |
| selectedColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
|
- |
设置滑轨的已滑动颜色。 |
| showSteps | boolean |
false | 设置当前是否显示步长刻度值。
|
| showTips | boolean |
false | 设置滑动时是否显示气泡提示百分比。
|
| trackThickness |
[
Length
](
../../ui/ts-types.md#length
)
|
- |
设置滑轨的粗细。 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| blockColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
| 设置滑块的颜色。 |
| trackColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
| 设置滑轨的背景颜色。 |
| selectedColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
| 设置滑轨的已滑动颜色。 |
| showSteps | boolean |
设置当前是否显示步长刻度值。
<br/>
默认值：false
|
| showTips | boolean |
设置滑动时是否显示气泡提示百分比。
<br/>
默认值：false
|
| trackThickness |
[
Length
](
../../ui/ts-types.md#length
)
| 设置滑轨的粗细。 |
## 事件
...
...
@@ -61,13 +58,14 @@ Slider(options:{value?: number, min?: number, max?: number, step?: number, style
| -------- | -------- |
| onChange(callback:
(value:
number,
mode:
SliderChangeMode)
=
>
void) | Slider滑动时触发事件回调。
<br/>
value：当前进度值。
<br/>
mode：拖动状态。 |
-
SliderChangeMode枚举说明
| 名称 | 值 | 描述 |
| -------- | -------- | -------- |
| Begin | 0 | 用户开始拖动滑块。 |
| Moving | 1 | 用户拖动滑块中。 |
| End | 2 | 用户结束拖动滑块。 |
| Click | 3 | 用户点击滑动条使滑块位置移动。 |
## SliderChangeMode枚举说明
| 名称 | 值 | 描述 |
| -------- | -------- | -------- |
| Begin | 0 | 用户开始拖动滑块。 |
| Moving | 1 | 用户拖动滑块中。 |
| End | 2 | 用户结束拖动滑块。 |
| Click | 3 | 用户点击滑动条使滑块位置移动。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
浏览文件 @
fcaf99dc
...
...
@@ -3,12 +3,8 @@
作为Text组件的子组件，用于显示行内文本的组件。
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -18,23 +14,24 @@
## 接口
Span(content:
ResourceStr
)
Span(content:
string | Resource
)
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| content |
[
ResourceStr
](
../../ui/ts-types.md#resourcestr8
)
| 是 | - | 文本内容。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| content | string
\|
[
Resource
](
../../ui/ts-types.md#resource
)
| 是 | 文本内容。 |
## 属性
通用属性方法仅支持通用文本样式，不支持触摸热区设置。
| 名称 | 参数类型 |
默认值 |
描述 |
| -------- | -------- | -------- |
-------- |
| decoration | {
<br/>
type:
[TextDecorationType](ts-appendix-enums.md#textdecorationtype),
<br/>
color?:
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
<br/>
} |
{
<br/>
type:
TextDecorationType.None
<br/>
color：Color.Black
<br/>
} | 设置文本装饰线样式及其颜色。
|
| letterSpacing |
[
Length
](
../../ui/ts-types.md#length
)
| -
| 设置文本字符间距。 |
| textCase |
[
TextCase
](
ts-appendix-enums.md#textcase
)
|
Normal | 设置文本大小写。
|
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| decoration | {
<br/>
type:
[TextDecorationType](ts-appendix-enums.md#textdecorationtype),
<br/>
color?:
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
<br/>
} |
设置文本装饰线样式及其颜色。
<br/>
默认值：{
<br/>
type:
TextDecorationType.None
<br/>
color：Color.Black
<br/>
}
|
| letterSpacing |
number
\|
string
| 设置文本字符间距。 |
| textCase |
[
TextCase
](
ts-appendix-enums.md#textcase
)
|
设置文本大小写。
<br/>
默认值：TextCase.Normal
|
## 事件
...
...
@@ -42,7 +39,8 @@ Span(content: ResourceStr)
通用事件仅支持点击事件。
> **说明：**
> 由于Span组件无尺寸信息，因此点击事件返回的ClickEvent对象的target属性无效。
>
> 由于Span组件无尺寸信息，因此点击事件返回的ClickEvent对象的target属性无效。
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
浏览文件 @
fcaf99dc
...
...
@@ -3,12 +3,8 @@
显示一段文本的组件。
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -18,32 +14,35 @@
## 接口
Text(content?:
ResourceStr
)
Text(content?:
string | Resource
)
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| content |
[
ResourceStr
](
../../ui/ts-types.md#resourcestr8
)
| 否 | '' | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| content | string
\|
[
Resource
](
../../ui/ts-types.md#resource
)
| 否 | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。
<br/>
默认值：' ' |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| TextAlign.Start | 设置多行文本的文本对齐方式。 |
| textOverflow | {overflow:
[
TextOverflow
](
ts-appendix-enums.md#textoverflow
)
} | {overflow:
TextOverflow.Clip} | 设置文本超长时的显示方式。
<br/>
**说明：**
<br/>
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：
\u
200B。
<br
/>
需配合
`maxLines`
使用，单独设置不生效。 |
| maxLines | number | Infinity | 设置文本的最大行数。
<br
/>
**说明：**
<br
/>
默认情况下，文本是自动折行的，如果指定此参数，则文本最多不会超过指定的行。如果有多余的文本，可以通过
`textOverflow`
来指定截断方式。 |
| lineHeight | string
\|
number
\|
[
Resource
](
../../ui/ts-types.md
)
| - | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 |
| decoration | {
<br/>
type:
TextDecorationType,
<br/>
color?:
[
ResourceColor
](
../../ui/ts-types.md
)
<br/>
} | {
<br/>
type:
TextDecorationType.None,
<br/>
color：Color.Black
<br/>
} | 设置文本装饰线样式及其颜色。 |
| baselineOffset |
[
Length
](
../../ui/ts-types.md
)
| - | 设置文本基线的偏移量。 |
| letterSpacing |
[
Length
](
../../ui/ts-types.md
)
| - | 设置文本字符间距。 |
| minFontSize | number
\|
string
\|
[
Resource
](
../../ui/ts-types.md
)
| - | 设置文本最小显示字号。 |
| maxFontSize | number
\|
string
\|
[
Resource
](
../../ui/ts-types.md
)
| - | 设置文本最大显示字号。 |
| textCase |
[
TextCase
](
ts-appendix-enums.md#textcase
)
| TextCase.Normal | 设置文本大小写。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| CopyOptions.None | 组件支持设置文本是否可复制粘贴。 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外，还支持以下属性：
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| 设置多行文本的文本对齐方式。
<br/>
默认值：TextAlign.Start |
| textOverflow | {overflow:
[
TextOverflow
](
ts-appendix-enums.md#textoverflow
)
} | 设置文本超长时的显示方式。
<br/>
默认值：{overflow:
TextOverflow.Clip}
<br/>
**说明：**
<br/>
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：
\u
200B。
<br
/>
需配合
`maxLines`
使用，单独设置不生效。 |
| maxLines | number | 设置文本的最大行数。
<br
/>
默认值：Infinity
<br/>
**说明：**
<br
/>
默认情况下，文本是自动折行的，如果指定此参数，则文本最多不会超过指定的行。如果有多余的文本，可以通过
`textOverflow`
来指定截断方式。 |
| lineHeight | string
\|
number
\|
[
Resource
](
../../ui/ts-types.md
)
| 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 |
| decoration | {
<br/>
type:
TextDecorationType,
<br/>
color?:
[
ResourceColor
](
../../ui/ts-types.md
)
<br/>
} | 设置文本装饰线样式及其颜色。
<br
/>
默认值：{
<br/>
type:
TextDecorationType.None,
<br/>
color：Color.Black
<br/>
} |
| baselineOffset | number
\|
string | 设置文本基线的偏移量。 |
| letterSpacing | number
\|
string | 设置文本字符间距。 |
| minFontSize | number
\|
string
\|
[
Resource
](
../../ui/ts-types.md
)
| 设置文本最小显示字号。 |
| maxFontSize | number
\|
string
\|
[
Resource
](
../../ui/ts-types.md
)
| 设置文本最大显示字号。 |
| textCase |
[
TextCase
](
ts-appendix-enums.md#textcase
)
| 设置文本大小写。
<br
/>
默认值：TextCase.Normal |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 组件支持设置文本是否可复制粘贴。
<br
/>
默认值：CopyOptions.None |
> **说明：**
> 不支持Text内同时存在文本内容和Span子组件。如果同时存在，只显示Span内的内容。
>
> 不支持Text内同时存在文本内容和Span子组件。如果同时存在，只显示Span内的内容。
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
浏览文件 @
fcaf99dc
...
...
@@ -3,12 +3,8 @@
可以输入多行文本并支持响应部分输入事件的组件。
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -20,36 +16,38 @@
TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextAreaController})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------------------- | ---------------------------------------- | ---- | ---- | -------------- |
| placeholder |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | - | 无输入时的提示文本。 |
| text |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | - | 设置输入框当前的文本内容。 |
| controller
<sup>
8+
</sup>
|
[
TextAreaController
](
#textareacontroller8
)
| 否 | - | 设置TextArea控制器。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----------------------- | ---------------------------------------- | ---- | -------------- |
| placeholder |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | 无输入时的提示文本。 |
| text |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | 设置输入框当前的文本内容。 |
| controller
<sup>
8+
</sup>
|
[
TextAreaController
](
#textareacontroller8
)
| 否 | 设置TextArea控制器。 |
## 属性
除支持通用属性外，还支持以下属性：
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| ------------------------ | ---------------------------------------- | ----- | ---------------------------------------- |
| placeholderColor | Color | - | 设置placeholder文本颜色。 |
| placeholderFont | {
<br/>
size?:
number,
<br/>
weight?:number
\|
[FontWeight](ts-universal-attributes-text-style.md)，
<br/>
family?:
string,
<br/>
style?:
[
FontStyle
](
ts-universal-attributes-text-style.md
)
<br/>
} | - | 设置placeholder文本样式：
<br/>
-
size:
设置文本尺寸，Length为number类型时，使用fp单位。
<br/>
-
weight:
设置文本的字体粗细，number类型取值[100,
900]，取值间隔为100，默认为400，取值越大，字体越粗。
<br/>
-
family:
设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效，例如：'Arial,
sans-serif'。
<br/>
-
style:
设置文本的字体样式。 |
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| Start | 设置文本水平对齐式。 |
| caretColor | Color | - | 设置输入框光标颜色。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](../../ui/ts-types.md)
<sup>
8+
</sup>
,
<br/>
error?:
(value:
string)
<br/>
} | - | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.
\*\d
)(?=.
\*
[a-z])(?=.
\*
[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
<br/>
-
value：设置正则表达式。
<br/>
-
error：正则匹配失败时，返回被忽略的内容。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-basic-components-text.md
)
| CopyOptions.CrossDevice | 设置文本是否可复制。 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外，还支持以下属性：
| 名称 | 参数类型 | 描述 |
| ------------------------ | ---------------------------------------- | ---------------------------------------- |
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
| 设置placeholder文本颜色。 |
| placeholderFont |
[
Font
](
../../ui/ts-types.md#font
)
| 设置placeholder文本样式。 |
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| 设置文本水平对齐式。
<br/>
默认值：TextAlign.Start |
| caretColor |
[
ResourceColor
](
../../ui/ts-types.md#resourcecolor8
)
| 设置输入框光标颜色。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](../../ui/ts-types.md)
<sup>
8+
</sup>
,
<br/>
error?:
(value:
string) => void
<br/>
} | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.
\*\d
)(?=.
\*
[a-z])(?=.
\*
[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
<br/>
-
value：设置正则表达式。
<br/>
-
error：正则匹配失败时，返回被忽略的内容。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 设置文本是否可复制。 |
## 事件
| 名称 | 功能描述 |
| ---------------------------------------- | ---------------------------------------- |
| onChange(callback:
(value:
string)
=
>
void) | 输入发生变化时，触发回调。 |
| 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：粘贴的文本内容。 |
除支持
[
通用事件
](
ts-universal-events-click.md
)
外，还支持以下事件：
| 名称 | 功能描述 |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| onChange(callback:
(value:
string)
=
>
void) | 输入发生变化时，触发回调。 |
| 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：粘贴的文本内容。 |
## TextAreaController<sup>8+</sup>
...
...
@@ -59,7 +57,6 @@ TextArea组件的控制器，通过它操作TextArea组件。
```
controller: TextAreaController = new TextAreaController()
```
### caretPosition<sup>8+</sup>
...
...
@@ -68,10 +65,11 @@ caretPosition(value: number): void
设置输入光标的位置。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ------------------- |
| value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------ | -------- | ---- | -------------------------------------- |
| value | number | 是 | 从字符串开始到光标所在位置的字符长度。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
浏览文件 @
fcaf99dc
...
...
@@ -3,12 +3,8 @@
可以输入单行文本并支持响应输入事件的组件。
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -20,53 +16,58 @@
TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----------------------- | ---------------------------------------- | ---- | ---- | --------------- |
| placeholder |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | - | 无输入时的提示文本。 |
| text |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | - | 设置输入框当前的文本内容。 |
| controller
<sup>
8+
</sup>
|
[
TextInputController
](
#textinputcontroller8
)
| 否 | - | 设置TextInput控制器。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----------------------- | ---------------------------------------- | ---- | --------------- |
| placeholder |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | 无输入时的提示文本。 |
| text |
[
ResourceStr
](
../../ui/ts-types.md
)
| 否 | 设置输入框当前的文本内容。 |
| controller
<sup>
8+
</sup>
|
[
TextInputController
](
#textinputcontroller8
)
| 否 | 设置TextInput控制器。 |
## 属性
除支持通用属性外，还支持以下属性：
| 名称 | 参数类型 | 默认值 | 描述 |
| ------------------------ | ---------------------------------------- | ----------------- | ---------------------------------------- |
| type | InputType | InputType.Normal | 设置输入框类型。 |
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置placeholder颜色。|
| placeholderFont | {
<br/>
size?:
Length,
<br/>
weight?:
number\|[FontWeight](ts-universal-attributes-text-style.md),
<br/>
family?:
string,
<br/>
style?:
[
FontStyle
](
ts-universal-attributes-text-style.md
)
<br/>
} | - | 设置placeholder文本样式：
<br/>
-
size:
设置文本尺寸，Length为number类型时，使用fp单位。
<br/>
-
weight:
设置文本的字体粗细，number类型取值[100,
900]，取值间隔为100，默认为400，取值越大，字体越粗。
<br/>
-
family:
设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial,
sans-serif'。
<br/>
-
style:
设置文本的字体样式。 |
| enterKeyType | EnterKeyType | EnterKeyType.Done | 设置输入法回车键类型。 |
| caretColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置输入框光标颜色。 |
| maxLength | number | - | 设置文本的最大输入字符数。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](../../ui/ts-types.md)
<sup>
8+
</sup>
,
<br/>
error?:
(value:
string)
=
>
void
<br/>
} | - | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.
\*\d
)(?=.
\*
[a-z])(?=.
\*
[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
<br/>
-
value：设置正则表达式。
<br/>
-
error：正则匹配失败时，返回被忽略的内容。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-basic-components-text.md
)
| CopyOptions.CrossDevice | 设置文本是否可复制。 |
| showPasswordIcon
<sup>
9+
</sup>
| boolean | true | 密码输入模式时，密码框末尾的图标是否显示。 |
| style
<sup>
9+
</sup>
| TextInputStyle | Default | TextInput风格。 |
-
EnterKeyType枚举说明
| 名称 | 描述 |
| ------------------- | --------- |
| Go | 显示Go文本。 |
| Search | 显示为搜索样式。 |
| Send | 显示为发送样式。 |
| Next | 显示为下一个样式。 |
| Done | 标准样式。 |
-
InputType枚举说明
| 名称 | 描述 |
| ------------------ | ------------- |
| Normal | 基本输入模式。 |
| Password | 密码输入模式。 |
| Email | e-mail地址输入模式。 |
| Number | 纯数字输入模式。 |
-
TextInputStyle枚举说明
| 名称 | 描述 |
| ------------------ | ------------- |
| Default | 默认风格，光标宽1.5vp，光标高度和字体大小高度相关，字体越大光标越高。 |
| Inline | 内联输入风格。文字选中时底板与输入框同高。 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外，还支持以下属性：
| 名称 | 参数类型 | 描述 |
| ------------------------ | ---------------------------------------- | ---------------------------------------- |
| type | InputType | 设置输入框类型。
<br/>
默认值：InputType.Normal |
| placeholderColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置placeholder颜色。|
| placeholderFont |
[
Font
](
../../ui/ts-types.md#font
)
| 设置placeholder文本样式。 |
| enterKeyType | EnterKeyType | 设置输入法回车键类型。
<br/>
默认值：EnterKeyType.Done |
| caretColor |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置输入框光标颜色。 |
| maxLength | number | 设置文本的最大输入字符数。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](../../ui/ts-types.md)
<sup>
8+
</sup>
,
<br/>
error?:
(value:
string)
=
>
void
<br/>
} | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.
\*\d
)(?=.
\*
[a-z])(?=.
\*
[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
<br/>
-
value：设置正则表达式。
<br/>
-
error：正则匹配失败时，返回被忽略的内容。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 设置文本是否可复制。 |
| showPasswordIcon
<sup>
9+
</sup>
| boolean | 密码输入模式时，密码框末尾的图标是否显示。
<br/>
默认值：true |
| style
<sup>
9+
</sup>
| TextInputStyle | TextInput风格。
<br/>
默认值：Default |
## EnterKeyType枚举说明
| 名称 | 描述 |
| ------------------- | --------- |
| Go | 显示Go文本。 |
| Search | 显示为搜索样式。 |
| Send | 显示为发送样式。 |
| Next | 显示为下一个样式。 |
| Done | 标准样式。 |
## InputType枚举说明
| 名称 | 描述 |
| ------------------ | ------------- |
| Normal | 基本输入模式。 |
| Password | 密码输入模式。 |
| Email | e-mail地址输入模式。 |
| Number | 纯数字输入模式。 |
| PhoneNumber
<sup>
9+
</sup>
| 电话号码输入模式。
<br/>
支持输入数字、+ 、-、
*
、#，长度不限。 |
## TextInputStyle枚举说明
| 名称 | 描述 |
| ------------------ | ------------- |
| Default | 默认风格，光标宽1.5vp，光标高度和字体大小高度相关，字体越大光标越高。 |
| Inline | 内联输入风格。文字选中时底板与输入框同高。 |
## 事件
...
...
@@ -80,24 +81,25 @@ TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Te
| onCut
<sup>
8+
</sup>
(callback:(value:
string)
=
>
void) | 长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发回调。
<br/>
value：剪切的文本内容。 |
| onPaste
<sup>
8+
</sup>
(callback:(value:
string)
=
>
void) | 长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发回调。
<br/>
value：粘贴的文本内容。 |
##
#
TextInputController<sup>8+</sup>
## TextInputController<sup>8+</sup>
TextInput组件的控制器。
###
#
导入对象
### 导入对象
```
controller: TextInputController = new TextInputController()
```
###
#
caretPosition
### caretPosition
caretPosition(value:
number): void
设置输入光标的位置。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ---------------------------------------- |
| value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------ | -------- | ---- | -------------------------------------- |
| value | number | 是 | 从字符串开始到光标所在位置的字符长度。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md
浏览文件 @
fcaf99dc
...
...
@@ -3,12 +3,8 @@
滚动选择文本的组件。
> **说明：**
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -18,27 +14,28 @@
## 接口
TextPicker(options: {range: string[]|Resource, selected?: number, value?: string})
TextPicker(options
?
: {range: string[]|Resource, selected?: number, value?: string})
根据range指定的选择范围创建文本选择器。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| range | string
[
] \| [Resource
](
../../ui/ts-types.md#resource类型
)
| 是 | - | 选择器的数据选择范围。 |
| selected | number | 否 | 0 | 选中项在数组中的index值。 |
| value | string | 否 | 第一个元素值 | 选中项的值，优先级低于selected。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| range | string
[
] \| [Resource
](
../../ui/ts-types.md#resource类型
)
| 是 | 选择器的数据选择范围。 |
| selected | number | 否 | 选中项在数组中的index值。
<br/>
默认值：0 |
| value | string | 否 | 选中项的值，优先级低于selected。
<br/>
默认值：第一个元素值 |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| defaultPickerItemHeight | number
\|
string | 默认Picker内容项元素高度。 |
## 事件
除支持
[
通用事件
](
ts-universal-events-click.md
)
外，还支持以下事件：
| 名称 | 描述 |
| -------- | -------- |
| onChange(callback:
(value:
string,
index:
number)
=
>
void) | 滑动选中TextPicker文本内容后，触发该回调。
<br/>
-
value:
当前选中项的文本。
<br/>
-
index:
当前选中项的下标。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md
浏览文件 @
fcaf99dc
...
...
@@ -3,12 +3,8 @@
滚动选择时间的组件。
> **说明：**
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -18,21 +14,22 @@
## 接口
TimePicker(options?:
TimePickerOptions
)
TimePicker(options?:
{selected?: Date}
)
默认以00：00至23：59的时间区间创建滑动选择器。
-
options参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| selected | Date | 否 | 当前系统时间 | 设置选中项的时间。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| selected | Date | 否 | 设置选中项的时间。
<br/>
默认值：当前系统时间 |
## 属性
| 名称 | 参数类型 |
默认值 |
描述 |
| -------- | -------- | -------- |
-------- |
| useMilitaryTime | boolean |
false | 展示时间是否为24小时制，不支持动态修改。
|
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| useMilitaryTime | boolean |
展示时间是否为24小时制，不支持动态修改。
<br/>
默认值：false
|
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md
浏览文件 @
fcaf99dc
...
...
@@ -3,40 +3,31 @@
用于触发长按手势事件，触发长按手势的最少手指数为1，最短时间为500毫秒。
> **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 接口
LongPressGesture(
options
?: { fingers?: number, repeat?: boolean, duration?: number })
LongPressGesture(
value
?: { fingers?: number, repeat?: boolean, duration?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 1 | 触发长按的最少手指数，最小为1指，
最大取值为10指。 |
| repeat | boolean | 否 | false | 是否连续触发事件回调。 |
| duration | number | 否 | 500 | 最小触发长按的时间，单位为毫秒（ms）。 |
**参数：**
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| fingers | number | 否 | 触发长按的最少手指数，最小为1指，
最大取值为10指。
<br/>
默认值：1 |
| repeat | boolean | 否 | 是否连续触发事件回调。
<br/>
默认值：false |
| duration | number | 否 | 触发长按的最短时间，单位为毫秒（ms）。
<br/>
默认值：500 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onAction(
(event?:
GestureEvent
)
=
>
void) | LongPress手势识别成功回调。 |
| onActionEnd(
(event?:
GestureEvent
)
=
>
void) | LongPress手势识别成功，手指抬起后触发回调。 |
| onAction(
event: (event?:
[
GestureEvent
](
ts-gesture-settings.md
)
)
=
>
void) | LongPress手势识别成功回调。 |
| onActionEnd(
event: (event?:
[
GestureEvent
](
ts-gesture-settings.md
)
)
=
>
void) | LongPress手势识别成功，手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与LongPress手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| repeat | boolean | 事件是否为重复触发事件。 |
## 示例
```
ts
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md
浏览文件 @
fcaf99dc
...
...
@@ -3,69 +3,67 @@
用于触发拖动手势事件，滑动的最小距离为5vp时拖动手势识别成功。
> **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 接口
PanGesture(value?: { fingers?: number; direction?: PanDirection; distance?: number } |
[
PanGestureOptions
](
#pangestureoptions
)
)
## 接口
**参数：**
PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: number } |
[
PanGestureOptions
](
#pangestureoptions
)
)
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| fingers | number | 否 | 触发拖动的最少手指数，最小为1指，
最大取值为10指。
<br/>
默认值：1 |
| direction | PanDirection | 否 | 触发拖动的手势方向，此枚举值支持逻辑与(
&
)和逻辑或（
\|
）运算。
<br/>
默认值：PanDirection.All |
| distance | number | 否 | 最小拖动识别距离，单位为vp。
<br/>
默认值：5.0
<br/>
**说明：**
<br/>
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。 |
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 1 | 触发滑动的最少手指数，最小为1指，
最大取值为10指。 |
| direction | PanDirection | 否 | All | 设置滑动方向，此枚举值支持逻辑与(
&
)和逻辑或（
\|
）运算。 |
| distance | number | 否 | 5.0 | 最小滑动识别距离，单位为vp。
<br/>
**说明：**
<br/>
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。 |
## PanDirection枚举说明
-
PanDirection枚举说明
| 名称 | 描述 |
| -------- | -------- |
| All | 所有方向可滑动。 |
| Horizontal | 水平方向可滑动。 |
| Vertical | 竖直方向可滑动。 |
| Left | 向左滑动。 |
| Right | 向右滑动。 |
| Up | 向上滑动。 |
| Down | 向下滑动。 |
| None | 任何方向都不可滑动。 |
| 名称 | 描述 |
| -------- | -------- |
| All | 所有方向。 |
| Horizontal | 水平方向。 |
| Vertical | 竖直方向。 |
| Left | 向左拖动。 |
| Right | 向右拖动。 |
| Up | 向上拖动。 |
| Down | 向下拖动。 |
| None | 任何方向都不可触发拖动手势事件。 |
##
#
PanGestureOptions
## PanGestureOptions
通过PanGestureOptions对象接口可以动态修改滑动手势识别器的属性，从而避免通过状态变量修改属性（状态变量修改会导致UI刷新）。
PanGestureOptions(
options?: { fingers?: number, direction?: PanDirection,
distance?: number })
PanGestureOptions(
value?: { fingers?: number; direction?: PanDirection;
distance?: number })
-
参数
同PanGesture参数说明。
**参数：**
-
接口
| 名称 | 功能描述 |
| -------- | -------- |
| setDirection(value:
PanDirection) | 设置direction属性。 |
| setDistance(value:
number) | 设置distance属性。 |
| setFingers(value:
number) | 设置fingers属性。 |
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| --------- | ------------ | ---- | ------------------------------------------------------------ |
| fingers | number | 否 | 触发滑动的最少手指数，最小为1指，
最大取值为10指。
<br/>
默认值：1 |
| direction | PanDirection | 否 | 设置滑动方向，此枚举值支持逻辑与(
&
)和逻辑或（
\|
）运算。
<br/>
默认值：All |
| distance | number | 否 | 最小滑动识别距离，单位为vp。
<br/>
默认值：5.0
<br/>
**说明：**
<br/>
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。 |
**接口**
| 名称 | 功能描述 |
| -------- | -------- |
| setDirection(value:
PanDirection) | 设置direction属性。 |
| setDistance(value:
number) | 设置distance属性。 |
| setFingers(value:
number) | 设置fingers属性。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势识别成功回调。 |
| onActionUpdate(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势移动过程中回调。 |
| onActionEnd(callback:
(event?:
GestureEvent)
=
>
void) | Pan手势识别成功，手指抬起后触发回调。 |
| onActionCancel(callback:
()
=
>
void) | Pan手势识别成功，接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与Pan手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| offsetX | number | 手势事件偏移量，单位为vp。 |
| offsetY | number | 手势事件偏移量，单位为vp。 |
| onActionStart(event: (event?: GestureEvent) => void) | Pan手势识别成功回调。 |
| onActionUpdate(event:
(event?:
GestureEvent)
=
>
void) | Pan手势移动过程中回调。 |
| onActionEnd(event:
(event?:
GestureEvent)
=
>
void) | Pan手势识别成功，手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | Pan手势识别成功，接收到触摸取消事件触发回调。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md
浏览文件 @
fcaf99dc
...
...
@@ -3,41 +3,31 @@
用于触发捏合手势，触发捏合手势的最少手指为2指，最大为5指，最小识别距离为3vp。
> **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 接口
PinchGesture(
options
?: { fingers?: number, distance?: number })
PinchGesture(
value
?: { fingers?: number, distance?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 2 | 触发捏合的最少手指数,
最小为2指，最大为5指。 |
| distance | number | 否 | 3.0 | 最小识别距离，单位为vp。 |
**参数：**
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| fingers | number | 否 | 触发捏合的最少手指数,
最小为2指，最大为5指。
<br/>
默认值：2 |
| distance | number | 否 | 最小识别距离，单位为vp。
<br/>
默认值：3.0 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart(
(event?:
GestureEvent
)
=
>
void) | Pinch手势识别成功回调。 |
| onActionUpdate(
(event?:
GestureEvent
)
=
>
void) | Pinch手势移动过程中回调。 |
| onActionEnd(
(event?:
GestureEvent
)
=
>
void) | Pinch手势识别成功，手指抬起后触发回调。 |
| onActionStart(
event: (event?:
[
GestureEvent
](
ts-gesture-settings.md
)
)
=
>
void) | Pinch手势识别成功回调。 |
| onActionUpdate(
event: (event?:
[
GestureEvent
](
ts-gesture-settings.md
)
)
=
>
void) | Pinch手势移动过程中回调。 |
| onActionEnd(
event: (event?:
[
GestureEvent
](
ts-gesture-settings.md
)
)
=
>
void) | Pinch手势识别成功，手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与Pinch手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| scale | number | 缩放比例，用于PinchGesture手势触发场景。 |
| pinchCenterX | number | 捏合手势中心点X轴坐标，单位为px。 |
| pinchCenterY | number | 捏合手势中心点Y轴坐标，单位为px。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md
浏览文件 @
fcaf99dc
...
...
@@ -3,38 +3,36 @@
用于触发旋转手势事件，触发旋转手势的最少手指为2指，最大为5指，最小改变度数为1度。
> **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 接口
RotationGesture(
options
?: { fingers?: number, angle?: number })
RotationGesture(
value
?: { fingers?: number, angle?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 2 | 触发旋转的最少手指数,
最小为2指，最大为5指。 |
| angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数，单位为度数。 |
**参数：**
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| fingers | number | 否 | 触发旋转的最少手指数,
最小为2指，最大为5指。
<br/>
默认值：2 |
| angle | number | 否 | 触发旋转手势的最小改变度数，单位为deg。
<br/>
默认值：1.0 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart(
(event?:
GestureEvent)
=
>
void) | Rotation手势识别成功回调。 |
| onActionUpdate(
(event?:
GestureEvent)
=
>
void) | Rotation手势移动过程中回调。 |
| onActionEnd(
(event?:
GestureEvent)
=
>
void) | Rotation手势识别成功，手指抬起后触发回调。 |
| onActionStart(
event: (event?: GestureEvent) =>
void) | Rotation手势识别成功回调。 |
| onActionUpdate(
event: (event?: GestureEvent) =>
void) | Rotation手势移动过程中回调。 |
| onActionEnd(
event: (event?: GestureEvent) =>
void) | Rotation手势识别成功，手指抬起后触发回调。 |
| onActionCancel(event:
()
=
>
void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 |
-
GestureEvent对象中与Rotation手势相关的属性
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| angle | number | 旋转角度。 |
**GestureEvent对象中与Rotation手势相关的属性**
| 属性名称 | 属性类型 | 描述 |
| -------- | -------- | -------- |
| angle | number | 旋转角度。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md
浏览文件 @
fcaf99dc
...
...
@@ -3,45 +3,43 @@
用于触发滑动事件，滑动最小速度为100vp/s时识别成功。
> **说明：**
> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 接口
SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: number })
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| fingers | number | 否 | 1 | 触发滑动的最少手指数，默认为1，最小为1指，最大为10指。 |
| direction | SwipeDirection | 否 | SwipeDirection.All | 滑动方向。 |
| speed | number | 否 | 100 | 识别滑动的最小速度（100VP/秒）。 |
**参数：**
-
SwipeDirection枚举说明
| 名称 | 描述 |
| -------- | -------- |
| All | 所有方向。 |
| Horizontal | 水平方向。 |
| Vertical | 竖直方向。 |
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| fingers | number | 否 | 触发滑动的最少手指数，默认为1，最小为1指，最大为10指。
<br/>
默认值：1 |
| direction | SwipeDirection | 否 | 触发滑动手势的滑动方向。
<br/>
默认值：SwipeDirection.All |
| speed | number | 否 | 识别滑动的最小速度（默认为100VP/秒）。
<br/>
默认值：100 |
## SwipeDirection枚举说明
| 名称 | 描述 |
| -------- | -------- |
| All | 所有方向。 |
| Horizontal | 水平方向。 |
| Vertical | 竖直方向。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onAction(
callback
:(event?:
GestureEvent)
=
>
void) | 滑动手势识别成功回调。 |
| onAction(
event
:(event?:
GestureEvent)
=
>
void) | 滑动手势识别成功回调。 |
**GestureEvent对象中与Swipe手势相关的属性**
-
GestureEvent对象中与Swipe手势相关的属性
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| angle | number | 滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。
<br/>
>
**说明：**
<br/>
>
角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。 |
| speed | number | 滑动手势的速度，是所有手指滑动的平均速度，单位为VP/秒。 |
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| angle | number | 滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。
<br/>
>
**说明：**
<br/>
>
角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。 |
| speed | number | 滑动手势的速度，是所有手指滑动的平均速度，单位为VP/秒。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md
浏览文件 @
fcaf99dc
...
...
@@ -3,30 +3,27 @@
支持单次点击、多次点击识别。
> **说明：**
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 接口
TapGesture(options?: { count?: number, fingers?: number })
TapGesture(value?: { count?: number, fingers?: number })
**参数：**
-
参数
| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
<br/>
>
**说明：**
<br/>
>
如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 |
| fingers | number | 否 | 1 | 触发点击的最少手指数，最小为1指，
最大为10指。
<br/>
>
**说明：**
<br/>
>
1.
当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
<br/>
>
2.
实际点击手指数超过配置值，手势识别失败。 |
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| count | number | 否 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
<br/>
默认值：1
<br/>
>
**说明：**
<br/>
>
如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 |
| fingers | number | 否 | 触发点击的最少手指数，最小为1指，
最大为10指。
<br/>
默认值：1
<br/>
>
**说明：**
<br/>
>
1.
当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
<br/>
>
2.
实际点击手指数超过配置值，手势识别失败。 |
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onAction(
(event?:
[GestureEvent](ts-gesture-settings.md))
=
>
void) | Tap手势识别成功回调。 |
| onAction(
event: (event?: GestureEvent) =>
void) | Tap手势识别成功回调。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-ability-component.md
浏览文件 @
fcaf99dc
# AbilityComponent
独立显示Ability的容器。
> **说明：**
>
> 该组件从API Version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
>
> 本组件均为系统接口，三方应用不支持调用。
独立显示Ability的容器。
## 使用约束
AbilityComponent为独立层次渲染，不能再之上叠加其他显示内容。
...
...
@@ -26,26 +25,26 @@ AbilityComponent需设置且只能设置width、height，且width、height不支
## 接口
AbilityComponent(value:
{want : Want}
)
AbilityComponent(value:
(want: Want)
)
**参数：**
| 参数名 | 参数类型 | 必填 |
默认值 |
参数描述 |
| -------- | -------- | -------- | -------- |
-------- |
| want |
[
Want
](
../../reference/apis/js-apis-application-Want.md
)
| 是 |
- |
默认加载的Ability描述。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
../../reference/apis/js-apis-application-Want.md
)
| 是 | 默认加载的Ability描述。 |
## 事件
### onConnect
onConnect(
)
=
>
void
onConnect(
callback: () => void)
AbilityComponent环境启动完成时的回调，之后可使用AbilityComponent的方法。
### onDisconnect
onDisconnect(
)
=
>
void
onDisconnect(
callback: () => void)
AbilityComponent环境销毁时的回调。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md
浏览文件 @
fcaf99dc
...
...
@@ -3,11 +3,8 @@
可以与容器组件联动用于按逻辑结构快速定位容器显示区域的组件。
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -19,15 +16,17 @@
AlphabetIndexer(value: {arrayValue: Array
<
string
>
, selected: number})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| arrayValue | Array
<
string
>
| 是 | - | 字母索引字符串数组。 |
| selected | number | 是 | - | 初始选中项索引值。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| arrayValue | Array
<
string
>
| 是 | 字母索引字符串数组。 |
| selected | number | 是 | 初始选中项索引值。 |
## 属性
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外，还支持以下属性：
| 名称 | 参数类型 | 描述 |
| ----------------------- | --------------- | ----------------------------------------------------------- |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置文字颜色。 |
...
...
@@ -39,18 +38,20 @@ AlphabetIndexer(value: {arrayValue: Array<string>, selected: number})
| selectedFont |
[
Font
](
../../ui/ts-types.md
)
| 设置选中项文字样式。 |
| popupFont |
[
Font
](
../../ui/ts-types.md
)
| 设置提示弹窗字体样式。 |
| font |
[
Font
](
../../ui/ts-types.md
)
| 设置字母索引条默认字体样式。 |
| itemSize |
Length
| 设置字母索引条字母区域大小，字母区域为正方形，即正方形边长。 |
| itemSize |
string
\|
number
| 设置字母索引条字母区域大小，字母区域为正方形，即正方形边长。 |
| alignStyle | IndexerAlign | 设置字母索引条弹框的对齐样式，支持弹窗显示在索引条右侧和左侧。
<br/>
默认值：IndexerAlign.Right |
-
IndexerAlign枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Left | 弹框显示在索引条右侧。 |
| Right | 弹框显示在索引条左侧。 |
## IndexerAlign枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Left | 弹框显示在索引条右侧。 |
| Right | 弹框显示在索引条左侧。 |
## 事件
仅支持以下事件：
| 名称 | 功能描述 |
| -------- | -------- |
| onSelected(callback:
(index:
number)
=
>
void)
<sup>
(deprecated)
</sup>
| 索引条选中回调,返回值为当前选中索引。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-column.md
浏览文件 @
fcaf99dc
# Column
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
沿垂直方向布局的容器。
## 权限列表
无
> **说明：**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -19,23 +14,22 @@
## 接口
Column(value?:{space?: Length})
Column(value?:{space?: string | number})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| space | Length | 否 | 0 | 纵向布局元素间距。 |
**参数：**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| space | string
\|
number | 否 | 纵向布局元素间距。
<br/>
默认值：0 |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| alignItems |
[
HorizontalAlign
](
ts-appendix-enums.md#horizontalalign
)
| HorizontalAlign.Center | 设置子组件在水平方向上的对齐格式。 |
| justifyContent
<sup>
8+
</sup>
|
[
FlexAlign
](
ts-container-flex.md
)
| FlexAlign.Start | 设置子组件在垂直方向上的对齐格式。 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外，还支持以下属性：
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| alignItems |
[
HorizontalAlign
](
ts-appendix-enums.md#horizontalalign
)
| 设置子组件在水平方向上的对齐格式。
<br/>
默认值：HorizontalAlign.Center |
| justifyContent
<sup>
8+
</sup>
|
[
FlexAlign
](
ts-container-flex.md
)
| 设置子组件在垂直方向上的对齐格式。
<br/>
默认值：FlexAlign.Start |
## 示例
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑！
取消
想要评论请
注册
或
登录
