Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Tonvia
Docs
提交
280a29da
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，发现更多精彩内容 >>
提交
280a29da
编写于
9月 23, 2022
作者:
H
hebingxue
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
pattern fix
Signed-off-by:
N
hebingxue
<
1014948665@qq.com
>
上级
8a4fec1c
变更
44
隐藏空白更改
内联
并排
Showing
44 changed file
with
375 addition
and
437 deletion
+375
-437
zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md
...application-dev/reference/arkui-ts/ts-animatorproperty.md
+10
-9
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md
...ation-dev/reference/arkui-ts/ts-basic-components-blank.md
+1
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md
...tion-dev/reference/arkui-ts/ts-basic-components-button.md
+24
-28
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md
...on-dev/reference/arkui-ts/ts-basic-components-checkbox.md
+1
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md
...v/reference/arkui-ts/ts-basic-components-checkboxgroup.md
+1
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md
...n-dev/reference/arkui-ts/ts-basic-components-datapanel.md
+12
-14
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md
...-dev/reference/arkui-ts/ts-basic-components-datepicker.md
+18
-18
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md
...ion-dev/reference/arkui-ts/ts-basic-components-divider.md
+5
-5
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md
...v/reference/arkui-ts/ts-basic-components-imageanimator.md
+22
-24
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
...reference/arkui-ts/ts-basic-components-loadingprogress.md
+1
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md
...ion-dev/reference/arkui-ts/ts-basic-components-marquee.md
+1
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md
...-dev/reference/arkui-ts/ts-basic-components-navigation.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md
...dev/reference/arkui-ts/ts-basic-components-patternlock.md
+6
-6
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md
...on-dev/reference/arkui-ts/ts-basic-components-progress.md
+1
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
...tion-dev/reference/arkui-ts/ts-basic-components-qrcode.md
+2
-2
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-remotewindow.md
...ev/reference/arkui-ts/ts-basic-components-remotewindow.md
+4
-4
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md
...on-dev/reference/arkui-ts/ts-basic-components-richtext.md
+9
-8
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
...tion-dev/reference/arkui-ts/ts-basic-components-search.md
+6
-6
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md
...tion-dev/reference/arkui-ts/ts-basic-components-select.md
+9
-9
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
...cation-dev/reference/arkui-ts/ts-basic-components-span.md
+1
-2
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md
...ion-dev/reference/arkui-ts/ts-basic-components-stepper.md
+6
-7
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
...cation-dev/reference/arkui-ts/ts-basic-components-text.md
+12
-12
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
...on-dev/reference/arkui-ts/ts-basic-components-textarea.md
+2
-1
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md
...n-dev/reference/arkui-ts/ts-basic-components-textclock.md
+8
-11
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
...n-dev/reference/arkui-ts/ts-basic-components-textinput.md
+5
-4
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md
...n-dev/reference/arkui-ts/ts-basic-components-texttimer.md
+11
-11
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
...tion-dev/reference/arkui-ts/ts-basic-components-toggle.md
+17
-17
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md
...-dev/reference/arkui-ts/ts-basic-components-xcomponent.md
+5
-6
zh-cn/application-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md
...ion-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md
+26
-25
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-backgroundBlurStyle.md
...e/arkui-ts/ts-universal-attributes-backgroundBlurStyle.md
+8
-14
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md
...n-dev/reference/arkui-ts/ts-universal-attributes-click.md
+3
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md
...eference/arkui-ts/ts-universal-attributes-component-id.md
+54
-54
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md
...erence/arkui-ts/ts-universal-attributes-gradient-color.md
+5
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-grid.md
...on-dev/reference/arkui-ts/ts-universal-attributes-grid.md
+5
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hit-test-behavior.md
...nce/arkui-ts/ts-universal-attributes-hit-test-behavior.md
+10
-15
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md
...eference/arkui-ts/ts-universal-attributes-hover-effect.md
+4
-8
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
...on-dev/reference/arkui-ts/ts-universal-attributes-menu.md
+3
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
...dev/reference/arkui-ts/ts-universal-attributes-overlay.md
+4
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
...n-dev/reference/arkui-ts/ts-universal-attributes-popup.md
+21
-21
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
...erence/arkui-ts/ts-universal-attributes-sharp-clipping.md
+4
-9
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md
.../reference/arkui-ts/ts-universal-attributes-text-style.md
+7
-13
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md
...eference/arkui-ts/ts-universal-attributes-touch-target.md
+8
-8
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
...erence/arkui-ts/ts-universal-attributes-transformation.md
+7
-12
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
.../reference/arkui-ts/ts-universal-attributes-visibility.md
+4
-10
未找到文件。
zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md
浏览文件 @
280a29da
...
...
@@ -3,6 +3,7 @@
组件的某些通用属性变化时，可以通过属性动画实现渐变效果，提升用户体验。支持的属性包括width、height、backgroundColor、opacity、scale、rotate、translate等。
> **说明：**
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
animation(value: {duration?: number, tempo?: number, curve?: string | Curve | ICurve, delay?:number, iterations: number, playMode?: PlayMode, onFinish?: () => void})
...
...
@@ -12,15 +13,15 @@ animation(value: {duration?: number, tempo?: number, curve?: string | Curve | IC
**参数：**
| 名称
| 参数类型 | 必填
| 描述 |
| ---------- | ------------------------------------------
------------------
| ---- | ------------------------------------------------------------ |
| duration | number
| 否
| 设置动画时长。单位为毫秒，默认动画时长为1000毫秒。
<br/>
默认值：1000 |
| tempo | number
| 否
| 动画播放速度。数值越大，动画播放速度越快，数值越小，播放速度越慢
<br/>
值为0时，表示不存在动画。
<br/>
默认值：1 |
| curve | string
\|
[Curve](ts-appendix-enums.md#curve)
\|
ICurve
<sup>
9+
</sup>
| 否 | 设置动画曲线。默认曲线为线性。
<br/>
默认值：Curve.Linear
|
| delay | number
| 否 | 设置动画延迟执行的时长。单位为毫秒，默认不延时播放。
<br/>
默认值：0
|
| iterations | number
| 否
| 设置播放次数。默认播放一次，设置为-1时表示无限次播放。
<br/>
默认值：1 |
| playMode |
[
PlayMode
](
ts-appendix-enums.md#playmode
)
| 否
| 设置动画播放模式，默认播放完成后重头开始播放。
<br/>
默认值：PlayMode.Normal |
| onFinish | () => void
| 否 | 状态回调，动画播放完成时触发。
|
| 名称
| 参数类型 | 必填
| 描述 |
| ---------- | ------------------------------------------| ---- | ------------------------------------------------------------ |
| duration | number
| 否
| 设置动画时长。单位为毫秒，默认动画时长为1000毫秒。
<br/>
默认值：1000 |
| tempo | number
| 否
| 动画播放速度。数值越大，动画播放速度越快，数值越小，播放速度越慢
<br/>
值为0时，表示不存在动画。
<br/>
默认值：1 |
| curve | string
\|
[Curve](ts-appendix-enums.md#curve)
\|
ICurve
<sup>
9+
</sup>
| 否 | 设置动画曲线。默认曲线为线性。
<br/>
默认值：Curve.Linear |
| delay | number
| 否 | 设置动画延迟执行的时长。单位为毫秒，默认不延时播放。
<br/>
默认值：0
|
| iterations | number
| 否
| 设置播放次数。默认播放一次，设置为-1时表示无限次播放。
<br/>
默认值：1 |
| playMode |
[
PlayMode
](
ts-appendix-enums.md#playmode
)
| 否
| 设置动画播放模式，默认播放完成后重头开始播放。
<br/>
默认值：PlayMode.Normal |
| onFinish | () => void
| 否 | 状态回调，动画播放完成时触发。
|
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md
浏览文件 @
280a29da
...
...
@@ -28,7 +28,7 @@ Blank(min?: number | string)
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| color |
[
ResourceColor
](
ts-types.md
)
| 设置空白填充的填充颜色。 |
| color |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置空白填充的填充颜色。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md
浏览文件 @
280a29da
...
...
@@ -3,14 +3,10 @@
按钮组件，可快速创建不同样式的按钮。
> **说明：**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
可以包含单个子组件。
...
...
@@ -18,41 +14,41 @@
## 接口
-
Button(options?: {type?: ButtonType, stateEffect?: boolean})
**方法1：**
Button(options?: {type?: ButtonType, stateEffect?: boolean})
**表1**
options参数说明
**参数：**
| 参数名 | 参数类型 | 必填 | 默认值
| 参数描述 |
| ----------- | ---------- | ---- | -------
| --------------------------------- |
| type | ButtonType | 否 | ButtonType.Capsule | 描述按钮风格。
|
| stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。
|
| 参数名 | 参数类型 | 必填
| 参数描述 |
| ----------- | ---------- | ------
| --------------------------------- |
| type | ButtonType | 否 | 描述按钮风格。
<br/>
默认值：ButtonType.Capsule
|
| stateEffect | boolean | 否 | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。
<br/>
默认值：true
|
-
Button(label?: ResourceStr, options?: { type?: ButtonType, stateEffect?: boolean })
**方法2：**
Button(label?: ResourceStr, options?: { type?: ButtonType, stateEffect?: boolean })
使用文本内容创建相应的按钮组件，此时Button无法包含子组件。
**表2**
value参数说明
**参数：**
| 参数名 | 参数类型 | 必填 |
默认值 |
参数描述 |
| ------- | ----------------------------------- | ---- | ----
| ----
--------- |
| label |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否 |
- |
按钮文本内容。 |
| options | Object | 否 |
- |
见options参数说明。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------- | ----------------------------------- | ---- | ------------- |
| label |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否 | 按钮文本内容。 |
| options | Object | 否 | 见options参数说明。 |
## 属性
| 名称 | 参数类型
| 默认值
| 描述 |
| ----------- | ----------
| ------
- | --------------------------------- |
| type | ButtonType
| ButtonType.Capsule | 设置Button样式。
|
| stateEffect | boolean
| true | 状态切换时是否开启切换效果，当状态置为false时，点击效果关闭。
|
-
ButtonType枚举说明
| 名称 | 描述 |
| ------- | ------------------ |
| Capsule | 胶囊型按钮（圆角默认为高度的一半）。 |
| Circle | 圆形按钮。 |
| Normal | 普通按钮（默认不带圆角）。 |
| 名称 | 参数类型 | 描述 |
| ----------- | ----------- | --------------------------------- |
| type | ButtonType
| 设置Button样式。
<br/>
默认值：ButtonType.Capsule
|
| stateEffect | boolean
| 状态切换时是否开启切换效果，当状态置为false时，点击效果关闭。
<br/>
默认值：true
|
##
ButtonType枚举说明
| 名称 | 描述 |
| ------- | ------------------ |
| Capsule | 胶囊型按钮（圆角默认为高度的一半）。 |
| Circle | 圆形按钮。 |
| Normal | 普通按钮（默认不带圆角）。 |
> **说明：**
> - 按钮圆角通过[通用属性borderRadius设置](ts-universal-attributes-border.md)（不支持通过border接口设置圆角）。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md
浏览文件 @
280a29da
...
...
@@ -29,7 +29,7 @@ Checkbox(options?: {name?: string, group?: string })
| 名称 | 参数类型 | 描述 |
| ------------- | ------- | -------- |
| select | boolean | 设置多选框是否选中。
<br/>
默认值：false |
| selectedColor |
[
ResourceColor
](
ts-types.md
)
| 设置多选框选中状态颜色。 |
| selectedColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置多选框选中状态颜色。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md
浏览文件 @
280a29da
...
...
@@ -31,7 +31,7 @@ CheckboxGroup(options?: { group?: string })
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| selectAll | boolean | 设置是否全选。
<br/>
默认值：false |
| selectedColor |
[
ResourceColor
](
ts-types.md
)
| 设置被选中或部分选中状态的颜色。 |
| selectedColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置被选中或部分选中状态的颜色。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md
浏览文件 @
280a29da
...
...
@@ -7,9 +7,6 @@
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
...
...
@@ -21,19 +18,20 @@
DataPanel(options:{values: number[], max?: number, type?: DataPanelType})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| values | number[] | 是 | - | 数据值列表，最大支持9个数据。 |
| max | number | 否 | 100 | -
max大于0，表示数据的最大值。
<br/>
-
max小于等于0，max等于value数组各项的和，按比例显示。 |
| type
<sup>
8+
</sup>
| DataPanelType | 否 | DataPanelType.Circle | 数据面板的类型。 |
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----------------- | -------- | ----- | -------- |
| values | number[] | 是 | 数据值列表，最大支持9个数据。 |
| max | number | 否 | -
max大于0，表示数据的最大值。
<br/>
-
max小于等于0，max等于value数组各项的和，按比例显示。
<br/>
默认值：100 |
| type
<sup>
8+
</sup>
| DataPanelType | 否 | 数据面板的类型。
<br/>
默认值：DataPanelType.Circle |
-
DataPanelType枚举说明
| 名称 | 描述 |
| -------- |
-------- |
| Line
| 线型数据面板。 |
| Circle | 环形数据面板。 |
##
DataPanelType枚举说明
| 名称 | 描述 |
| -------| ----
-------- |
| Line
| 线型数据面板。 |
| Circle | 环形数据面板。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md
浏览文件 @
280a29da
# DatePicker
选择日期的滑动选择器组件
> **说明：**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
选择日期的滑动选择器组件。
## 权限列表
无
## 子组件
...
...
@@ -24,18 +23,18 @@ DatePicker(options?: {start?: Date, end?: Date, selected?: Date})
根据指定范围的Date创建可以选择日期的滑动选择器。
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值
| 参数描述 |
| -------- | -------- | -------- |
-------- | -------- |
| start | Date | 否 | Date('1970-1-1') | 指定选择器的起始日期。
|
| end | Date | 否 | Date('2100-12-31') | 指定选择器的结束日期。
|
| selected | Date | 否 | 当前系统日期 | 设置选中项的日期。
|
| 参数名 | 参数类型 | 必填
| 参数描述 |
| -------- | -------- | -----
-------- | -------- |
| start | Date | 否 | 指定选择器的起始日期。
<br/>
默认值：Date('1970-1-1')
|
| end | Date | 否 | 指定选择器的结束日期。
<br/>
默认值：Date('2100-12-31')
|
| selected | Date | 否 | 设置选中项的日期。
<br/>
默认值：当前系统日期
|
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| ------
-- | -------- |
-------- | -------- |
| lunar | boolean
| false | 日期是否显示农历。
<br/>
-
true：展示农历。
<br/>
-
false：不展示农历。
|
| 名称
| 参数类型 | 描述
|
| ------
| ------
-------- | -------- |
| lunar | boolean
| 日期是否显示农历。
<br/>
-
true：展示农历。
<br/>
-
false：不展示农历。
<br/>
默认值：false
|
## 事件
...
...
@@ -44,12 +43,13 @@ DatePicker(options?: {start?: Date, end?: Date, selected?: Date})
| -------- | -------- |
| onChange(callback:
(value:
DatePickerResult)
=
>
void) | 选择日期时触发该事件。 |
### DatePickerResult对象说明
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| year | number | 选中日期的年。 |
| month | number | 选中日期的月(0~11)，0表示1月，11表示12月。 |
| day | number | 选中日期的日。 |
## DatePickerResult对象说明
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| year | number | 选中日期的年。 |
| month | number | 选中日期的月(0~11)，0表示1月，11表示12月。 |
| day | number | 选中日期的日。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md
浏览文件 @
280a29da
...
...
@@ -20,12 +20,12 @@ Divider()
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外，还支持以下属性：
| 名称
| 参数类型 | 描述
|
| --------
| -------- |
-------- |
| vertical | boolean | 使用水平分割线还是垂直分割线。false：水平分割线；true：垂直分割线。
<br/>
默认值：false |
| color
|
[
ResourceColor
](
ts-types.md
)
| 分割线颜色。 |
| 名称
| 参数类型 | 描述
|
| --------
--- | ---------- | ----------
-------- |
| vertical
| boolean | 使用水平分割线还是垂直分割线。false：水平分割线；true：垂直分割线。
<br/>
默认值：false |
| color
|
[
ResourceColor
](
ts-types.md#resourcecolor
)
| 分割线颜色。 |
| strokeWidth | number
\|
string | 分割线宽度。
<br/>
默认值：1 |
| lineCap |
[
LineCapStyle
](
ts-appendix-enums.md#linecapstyle
)
| 分割线的端点样式。
<br/>
默认值：LineCapStyle.Butt |
| lineCap
|
[
LineCapStyle
](
ts-appendix-enums.md#linecapstyle
)
| 分割线的端点样式。
<br/>
默认值：LineCapStyle.Butt |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md
浏览文件 @
280a29da
# ImageAnimator
> **说明：**
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
提供帧动画组件来实现逐帧播放图片的能力，可以配置需要播放的图片列表，每张图片可以配置时长。
> **说明：**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
...
...
@@ -24,26 +21,27 @@ ImageAnimator()
## 属性
| 参数名称
| 参数类型 | 默认值 | 必填 | 参数描述
|
| --------
| -------- |
-------- | -------- | -------- |
| images
| Array
<
ImageFrameInfo
>
| [] | 是 | 设置图片帧信息集合。每一帧的帧信息(ImageFrameInfo)包含图片路径、图片大小、图片位置和图片播放时长信息，详见ImageFrameInfo属性说明。
|
| state
|
[
AnimationStatus
](
ts-appendix-enums.md#animationstatus
)
| Initial | 否 | 默认为初始状态，用于控制播放状态。
|
| duration
| number | 1000 | 否 | 单位为毫秒，默认时长为1000ms；duration为0时，不播放图片；值的改变只会在下一次循环开始时生效；当images中任意一帧图片设置了单独的duration后，该属性设置无效。
|
| reverse
| boolean | false | 否 | 设置播放顺序。false表示从第1张图片播放到最后1张图片；
true表示从最后1张图片播放到第1张图片。
|
| fixedSize
| boolean | true | 否 | 设置图片大小是否固定为组件大小。
true表示图片大小与组件大小一致，此时设置图片的width
、height
、top
和left属性是无效的。false表示每一张图片的width
、height
、top和left属性都要单独设置。
|
| preDecode
| number | 0 | 否 | 是否启用预解码，默认值为0，即不启用预解码，如该值设为2，则播放当前页时会提前加载后面两张图片至缓存以提升性能。
|
| fillMode
|
[
FillMode
](
ts-appendix-enums.md#fillmode
)
| Forwards | 否 | 设置动画开始前和结束后的状态，可选值参见FillMode说明。
|
| iterations | number
| 1 | 否 | 默认播放一次，设置为-1时表示无限次播放。
|
| 参数名称
| 参数类型 | 必填 | 参数描述
|
| --------
-- | ---------------
-------- | -------- | -------- |
| images
| Array
<
ImageFrameInfo
>
| 是 | 设置图片帧信息集合。每一帧的帧信息(ImageFrameInfo)包含图片路径、图片大小、图片位置和图片播放时长信息，详见ImageFrameInfo属性说明。
<br/>
默认值：[]
|
| state
|
[
AnimationStatus
](
ts-appendix-enums.md#animationstatus
)
| 否 | 默认为初始状态，用于控制播放状态。
<br/>
默认值：Initial
|
| duration
| number | 否 | 单位为毫秒，默认时长为1000ms；duration为0时，不播放图片；值的改变只会在下一次循环开始时生效；当images中任意一帧图片设置了单独的duration后，该属性设置无效。
<br/>
默认值：1000
|
| reverse
| boolean | 否 | 设置播放顺序。false表示从第1张图片播放到最后1张图片；
true表示从最后1张图片播放到第1张图片。
<br/>
默认值：false
|
| fixedSize
| boolean | 否 | 设置图片大小是否固定为组件大小。
true表示图片大小与组件大小一致，此时设置图片的width
、height
、top
和left属性是无效的。false表示每一张图片的width
、height
、top和left属性都要单独设置。
<br/>
默认值：true
|
| preDecode
| number | 否 | 是否启用预解码，默认值为0，即不启用预解码，如该值设为2，则播放当前页时会提前加载后面两张图片至缓存以提升性能。
<br/>
默认值：0
|
| fillMode
|
[
FillMode
](
ts-appendix-enums.md#fillmode
)
| 否 | 设置动画开始前和结束后的状态，可选值参见FillMode说明。
<br/>
默认值：Forwards
|
| iterations | number
| 否 | 默认播放一次，设置为-1时表示无限次播放。
<br/>
默认值：1
|
-
ImageFrameInfo属性说明
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| src | string
\|
[
Resource
](
ts-types.md#resource类型
)
<sup>
9+
</sup>
| "" | 是 | 图片路径，图片格式为svg，png和jpg，从API Version9开始支持
[
Resource
](
ts-types.md#resource类型
)
类型的路径 |
| width |
[
Length
](
ts-types.md#长度类型
)
| 0 | 否 | 图片宽度 |
| height |
[
Length
](
ts-types.md#长度类型
)
| 0 | 否 | 图片高度 |
| top |
[
Length
](
ts-types.md#长度类型
)
| 0 | 否 | 图片相对于组件左上角的纵向坐标 |
| left |
[
Length
](
ts-types.md#长度类型
)
| 0 | 否 | 图片相对于组件左上角的横向坐标 |
| duration | number | 0 | 否 | 每一帧图片的播放时长，单位毫秒 |
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------------- | -------- | -------- |
| src | string
\|
[
Resource
](
ts-types.md#resource
)
<sup>
9+
</sup>
| 是 | 图片路径，图片格式为svg，png和jpg，从API Version9开始支持
[
Resource
](
ts-types.md#resource类型
)
类型的路径。
<br/>
默认值："" |
| width |
[
Length
](
ts-types.md#length
)
| 否 | 图片宽度。
<br/>
默认值：0 |
| height |
[
Length
](
ts-types.md#length
)
| 否 | 图片高度。
<br/>
默认值：0 |
| top |
[
Length
](
ts-types.md#length
)
| 否 | 图片相对于组件左上角的纵向坐标。
<br/>
默认值：0 |
| left |
[
Length
](
ts-types.md#length
)
| 否 | 图片相对于组件左上角的横向坐标。
<br/>
默认值：0 |
| duration | number | 否 | 每一帧图片的播放时长，单位毫秒。
<br/>
默认值：0 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
浏览文件 @
280a29da
...
...
@@ -21,7 +21,7 @@ LoadingProgress()
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| color |
[
ResourceColor
](
ts-types.md
)
| 设置加载进度条前景色。 |
| color |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置加载进度条前景色。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md
浏览文件 @
280a29da
...
...
@@ -84,7 +84,7 @@ struct MarqueeExample {
Button
(
'
start
'
)
.
onClick
(()
=>
{
this
.
start
=
true
})
})
.
width
(
200
)
.
height
(
60
)
.
margin
({
bottom
:
20
})
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md
浏览文件 @
280a29da
...
...
@@ -24,9 +24,9 @@ Navigation()
| 名称 | 参数类型 | 描述 |
| -------------- | ---------------------------------------- | ---------------------------------------- |
| title | string
\|
[
CustomBuilder
](
ts-types.md
)
| 页面标题。 |
| title | string
\|
[
CustomBuilder
](
ts-types.md
#custombuilder8
)
<sup>
8+
</sup>
| 页面标题。 |
| subTitle | string | 页面副标题。 |
| menus | Array
<NavigationMenuItem
&
gt
;&
nbsp
;\|&
nbsp
;[
CustomBuilder
](
ts-types.md
)<
sup
>
8+
</sup>
| 页面右上角菜单。 |
| menus | Array
<NavigationMenuItem
&
gt
;&
nbsp
;\|&
nbsp
;[
CustomBuilder
](
ts-types.md
#custombuilder8
)<
sup
>
8+
</sup>
| 页面右上角菜单。 |
| titleMode | NavigationTitleMode | 页面标题栏显示模式。
<br/>
默认值：NavigationTitleMode.Free |
| toolBar | object
\|
[
CustomBuilder
](
ts-types.md#custombuilder8
)
<sup>
8+
</sup>
| 设置工具栏内容。
<br/>
items:
工具栏所有项。 |
| hideToolBar | boolean | 设置隐藏/显示工具栏：
<br/>
默认值：false
<br/>
true:
隐藏工具栏。
<br/>
false:
显示工具栏。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md
浏览文件 @
280a29da
...
...
@@ -26,12 +26,12 @@ PatternLock(controller?: PatternLockController)
| 名称 | 参数类型 | 描述 |
| --------------- | ------------------------------------- | ------------------------------------------------------------ |
| sideLength |
[
Length
](
ts-types.md
)
| 设置组件的宽度和高度（相同值）。最小可以设置为0。
<br/>
默认值：300vp |
| circleRadius |
[
Length
](
ts-types.md
)
| 设置宫格圆点的半径。
<br/>
默认值：14vp |
| regularColor |
[
ResourceColor
](
ts-types.md
)
| 设置宫格圆点在“未选中”状态的填充颜色。
<br/>
默认值：Color.Black |
| selectedColor |
[
ResourceColor
](
ts-types.md
)
| 设置宫格圆点在“选中”状态的填充颜色。
<br/>
默认值：Color.Black |
| activeColor |
[
ResourceColor
](
ts-types.md
)
| 设置宫格圆点在“激活”状态的填充颜色。
<br/>
默认值：Color.Black |
| pathColor |
[
ResourceColor
](
ts-types.md
)
| 设置连线的颜色。
<br/>
默认值：Color.Blue |
| sideLength |
[
Length
](
ts-types.md
#length
)
| 设置组件的宽度和高度（相同值）。最小可以设置为0。
<br/>
默认值：300vp |
| circleRadius |
[
Length
](
ts-types.md
#length
)
| 设置宫格圆点的半径。
<br/>
默认值：14vp |
| regularColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置宫格圆点在“未选中”状态的填充颜色。
<br/>
默认值：Color.Black |
| selectedColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置宫格圆点在“选中”状态的填充颜色。
<br/>
默认值：Color.Black |
| activeColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置宫格圆点在“激活”状态的填充颜色。
<br/>
默认值：Color.Black |
| pathColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置连线的颜色。
<br/>
默认值：Color.Blue |
| pathStrokeWidth | number
\|
string | 设置连线的宽度。最小可以设置为0。
<br/>
默认值：34vp |
| autoReset | boolean | 设置是否支持用户在完成输入后再次触屏重置组件状态。如果设置为true，用户可以通过触摸图案密码锁重置组件状态（清除之前的输入效果）；如果设置为false，用户手指离开屏幕完成输入后，再次触摸图案密码锁（包括圆点）不能改变之前的输入状态。
<br/>
默认值：true |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md
浏览文件 @
280a29da
...
...
@@ -52,7 +52,7 @@ Progress(options: {value: number, total?: number, type?: ProgressType})
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| value | number | 设置当前进度值。 |
| color |
[
ResourceColor
](
ts-types.md
)
| 设置进度条前景色。 |
| color |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置进度条前景色。 |
| style
<sup>
8+
</sup>
| {
<br/>
strokeWidth?:
[Length](ts-types.md#length),
<br/>
scaleCount?:
number,
<br/>
scaleWidth?:
[
Length
](
ts-types.md#length
)
<br/>
} | 定义组件的样式。
<br/>
-
strokeWidth:
设置进度条宽度。
<br/>
-
scaleCount:
设置环形进度条总刻度数。
<br/>
-
scaleWidth:
设置环形进度条刻度粗细，刻度粗细大于进度条宽度时，为系统默认粗细。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md
浏览文件 @
280a29da
...
...
@@ -27,8 +27,8 @@ QRCode(value: string)
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| color |
[
ResourceColor
](
ts-types.md
)
| 设置二维码颜色。
<br/>
默认值：Color.Black |
| backgroundColor |
[
ResourceColor
](
ts-types.md
)
| 设置二维码背景颜色。
<br/>
默认值：Color.White |
| color |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置二维码颜色。
<br/>
默认值：Color.Black |
| backgroundColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置二维码背景颜色。
<br/>
默认值：Color.White |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-remotewindow.md
浏览文件 @
280a29da
...
...
@@ -18,10 +18,10 @@ RemoteWindow(target: WindowAnimationTarget)
通过窗口动画对象创建组件。
-
参数
| 参数名 | 参数类型 | 必填 | 默认值
| 参数描述 |
| -------- | -------- | -------- |
-------- | -------- |
| target |
[
WindowAnimationTarget
](
#windowanimationtarget
)
| 是 | -
| 需要控制的动画窗口的描述。 |
**参数:**
| 参数名 | 参数类型 | 必填
| 参数描述 |
| -------- | -------- | -------
-------- | -------- |
| target |
[
WindowAnimationTarget
](
#windowanimationtarget
)
| 是
| 需要控制的动画窗口的描述。 |
## WindowAnimationTarget
目标窗口，用来远程控制实现动画。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md
浏览文件 @
280a29da
# RichText
富文本组件，解析并显示HTML格式文本。
> **说明：**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
富文本组件，解析并显示HTML格式文本。
## 权限列表
无
## 子组件
...
...
@@ -17,11 +16,11 @@
RichText(content:string)
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值
| 参数描述 |
| -------- | -------- | -------- |
-------- | -------- |
| content | string | 是 | -
| 表示HTML格式的字符串。 |
| 参数名 | 参数类型 | 必填
| 参数描述 |
| ------- | -------- | -----
-------- | -------- |
| content | string | 是
| 表示HTML格式的字符串。 |
## 事件
...
...
@@ -48,7 +47,9 @@ RichText(content:string)
|
\<
script>
\<
/script> | 用于定义客户端文本，比如JavaScript。 |
\<
script>document.write("Hello World!")
\<
/script> |
## 示例
示例效果请以真机运行为准，当前IDE预览器不支持。
```
ts
// xxx.ets
@
Entry
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md
浏览文件 @
280a29da
...
...
@@ -29,12 +29,12 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controll
| 名称 | 参数类型 | 描述 |
| ----------------------- | ------------------------------------------------ | ---------------------------------------------- |
| searchButton | string | 搜索框末尾搜索按钮文本值，默认无搜索按钮。 |
| placeholderColor |
[
ResourceColor
](
ts-types.md
)
| 设置placeholder颜色。
|
| placeholderFont |
[
Font
](
ts-types.md
)
| 设置placeholder文本样式。
|
| textFont |
[
Font
](
ts-types.md
)
| 设置搜索框内文本样式。
|
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 设置文本是否可复制。 |
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| 设置文本对齐方式。
<br/>
默认值：TextAlign.Start |
| searchButton | string | 搜索框末尾搜索按钮文本值，默认无搜索按钮。
|
| placeholderColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置placeholder颜色。
|
| placeholderFont |
[
Font
](
ts-types.md
#font
)
| 设置placeholder文本样式。
|
| textFont |
[
Font
](
ts-types.md
#font
)
| 设置搜索框内文本样式。
|
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 设置文本是否可复制。
|
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| 设置文本对齐方式。
<br/>
默认值：TextAlign.Start
|
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md
浏览文件 @
280a29da
...
...
@@ -27,20 +27,20 @@ Select(options: Array\<SelectOption\>)
| ----------------------- | ------------------------------------- | --------------------------------------------- |
| selected | number | 设置下拉菜单初始选项的索引，第一项的索引为0。 |
| value | string | 设置下拉按钮本身的文本显示。 |
| font |
[
Font
](
ts-types.md
)
| 设置下拉按钮本身的文本样式。 |
| fontColor |
[
ResourceColor
](
ts-types.md
)
| 设置下拉按钮本身的文本颜色。 |
| selectedOptionBgColor |
[
ResourceColor
](
ts-types.md
)
| 设置下拉菜单选中项的背景色。 |
| selectedOptionFont |
[
Font
](
ts-types.md
)
| 设置下拉菜单选中项的文本样式。 |
| selectedOptionFontColor |
[
ResourceColor
](
ts-types.md
)
| 设置下拉菜单选中项的文本颜色。 |
| optionBgColor |
[
ResourceColor
](
ts-types.md
)
| 设置下拉菜单项的背景色。 |
| optionFont |
[
Font
](
ts-types.md
)
| 设置下拉菜单项的文本样式。 |
| optionFontColor |
[
ResourceColor
](
ts-types.md
)
| 设置下拉菜单项的文本颜色。 |
| font |
[
Font
](
ts-types.md
#font
)
| 设置下拉按钮本身的文本样式。 |
| fontColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置下拉按钮本身的文本颜色。 |
| selectedOptionBgColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置下拉菜单选中项的背景色。 |
| selectedOptionFont |
[
Font
](
ts-types.md
#font
)
| 设置下拉菜单选中项的文本样式。 |
| selectedOptionFontColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置下拉菜单选中项的文本颜色。 |
| optionBgColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置下拉菜单项的背景色。 |
| optionFont |
[
Font
](
ts-types.md
#font
)
| 设置下拉菜单项的文本样式。 |
| optionFontColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置下拉菜单项的文本颜色。 |
## 事件
| 名称 | 功能描述 |
| ---------------------------------------- | -------------------------------------- |
| onSelect(callback: (index: number, value?:string) => void) | 下拉菜单选中某一项的回调。
index：选中项的索引。
value：选中项的值。 |
| onSelect(callback: (index: number, value?:string) => void) | 下拉菜单选中某一项的回调。
<br/>
index：选中项的索引。
<br/>
value：选中项的值。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md
浏览文件 @
280a29da
...
...
@@ -23,10 +23,9 @@ Span(value: string | Resource)
| value | string
\|
[
Resource
](
ts-types.md#resource
)
| 是 | 文本内容。 |
## 属性
通用属性方法仅支持
通用文本样式，不支持触摸热区设置
。
通用属性方法仅支持
[
通用文本样式
](
ts-universal-attributes-text-style.md
)
，不支持
[
触摸热区设置
](
ts-universal-attributes-touch-target.md
)
。
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md
浏览文件 @
280a29da
...
...
@@ -4,12 +4,10 @@
> **说明：**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
...
...
@@ -22,10 +20,11 @@
Stepper(value?: { index?: number })
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| index | number | 否 | 0 | 设置步骤导航器显示第几个StepperItem。 |
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ------| -------- | --------------- | -------- |
| index | number | 否 | 设置步骤导航器显示第几个StepperItem。
<br/>
默认值：0 |
## 属性
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md
浏览文件 @
280a29da
...
...
@@ -26,18 +26,18 @@ Text(content?: string | Resource)
除支持
[
通用属性
](
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
](
ts-types.md
)
| 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 |
| decoration
| {
<br/>
type:
TextDecorationType,
<br/>
color?:
[
ResourceColor
](
ts-types.md
)
<br/>
} | 设置文本装饰线样式及其颜色。
<br
/>
默认值：{
<br/>
type:
TextDecorationType.None,
<br/>
color：Color.Black
<br/>
} |
| baselineOffset | number
\|
string | 设置文本基线的偏移量。 |
| letterSpacing | number
\|
string | 设置文本字符间距。 |
| minFontSize
| number
\|
string
\|
[
Resource
](
ts-types.md
)
| 设置文本最小显示字号。 |
| maxFontSize
| number
\|
string
\|
[
Resource
](
ts-types.md
)
| 设置文本最大显示字号。 |
| textCase |
[
TextCase
](
ts-appendix-enums.md#textcase
)
| 设置文本大小写。
<br
/>
默认值：TextCase.Normal |
| 名称
| 参数类型 | 描述
|
| --------
--------------- | ----------------------------------- | -----------------------------------
-------- |
| 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
](
ts-types.md#resource
)
| 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 |
| decoration
| {
<br/>
type:
TextDecorationType,
<br/>
color?:
[
ResourceColor
](
ts-types.md#resourcecolor
)
<br/>
} | 设置文本装饰线样式及其颜色。
<br
/>
默认值：{
<br/>
type:
TextDecorationType.None,
<br/>
color：Color.Black
<br/>
} |
| baselineOffset
| number
\|
string | 设置文本基线的偏移量。 |
| letterSpacing
| number
\|
string | 设置文本字符间距。 |
| minFontSize
| number
\|
string
\|
[
Resource
](
ts-types.md#resource
)
| 设置文本最小显示字号。 |
| maxFontSize
| number
\|
string
\|
[
Resource
](
ts-types.md#resource
)
| 设置文本最大显示字号。 |
| textCase
|
[
TextCase
](
ts-appendix-enums.md#textcase
)
| 设置文本大小写。
<br
/>
默认值：TextCase.Normal |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 组件支持设置文本是否可复制粘贴。
<br
/>
默认值：CopyOptions.None |
> **说明：**
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md
浏览文件 @
280a29da
...
...
@@ -36,7 +36,8 @@ TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Tex
| textAlign |
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| 设置文本水平对齐式。
<br/>
默认值：TextAlign.Start |
| caretColor |
[
ResourceColor
](
ts-types.md#resourcecolor
)
| 设置输入框光标颜色。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](ts-types.md#resourcestr),
<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
)
| 设置文本是否可复制。 |
| copyOption
<sup>
9+
</sup>
|
[
CopyOptions
](
ts-appendix-enums.md#copyoptions9
)
| 设置文本是否可复制。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md
浏览文件 @
280a29da
...
...
@@ -3,12 +3,9 @@
TextClock组件通过文本将当前系统时间显示在设备上。支持不同时区的时间显示，最高精度到秒级。
>**说明：**
>
>该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
无
...
...
@@ -19,18 +16,18 @@ TextClock(options?: { timeZoneOffset?: number, controller?: TextClockController
**参数：**
| 参数名
| 参数类型 | 必填 | 默认值
| 参数描述 |
| --------
| -------- | ---- | ------------------ |
------------------------------------------------------------ |
| timeZoneOffset | number | 否
| 当前系统的时区偏移量 | 设置时区偏移量。
<br>
取值范围为[-14, 12]，表示东十二区到西十二区，其中负值表示东时区，正值表示西时区，比如东八区为-8。
<br>
对横跨国际日界线的国家或地区，用-13（UTC+13）和-14（UTC+14）来保证整个国家或者区域处在相同的时间，当设置的值不在取值范围内时，将使用当前系统的时区偏移量。
|
| controller
|
[
TextClockController
](
#textclockcontroller
)
| 否 | null | 绑定一个控制器，用来控制文本时钟的状态。
|
| 参数名
| 参数类型 | 必填
| 参数描述 |
| --------
------ | -------- | ------ | ---------------
------------------------------------------------------------ |
| timeZoneOffset | number | 否
| 设置时区偏移量。
<br>
取值范围为[-14, 12]，表示东十二区到西十二区，其中负值表示东时区，正值表示西时区，比如东八区为-8。
<br>
对横跨国际日界线的国家或地区，用-13（UTC+13）和-14（UTC+14）来保证整个国家或者区域处在相同的时间，当设置的值不在取值范围内时，将使用当前系统的时区偏移量。
<br/>
默认值：当前系统的时区偏移量
|
| controller
|
[
TextClockController
](
#textclockcontroller
)
| 否 | 绑定一个控制器，用来控制文本时钟的状态。
<br/>
默认值：null
|
## 属性
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外，还支持以下属性：
| 名称 | 参数类型
| 默认值
| 描述 |
| ------ | --------
| -
------- | ------------------------------------------------------------ |
| format | string
| 'hms' | 设置显示时间格式。
<br/>
日期间隔符固定为"/"，时间间隔符为":"。
<br/>
如yyyyMMdd，yyyy-MM-dd显示为yyyy/MM/dd，
<br/>
hhmmss显示为hh:mm:ss。
<br/>
时间格式只用写一位即可，如"hhmmss"等同于"hms"。
<br/>
支持的时间格式化字符串：
<br/>
- YYYY/yyyy：完整年份。
<br/>
- YY/yy：年份后两位。
<br/>
- M：月份(若想使用01月则使用MM)。
<br/>
- d：日期(若想使用01日则使用dd)。
<br/>
- D：年中日(一年中的第几天)。
<br/>
- H：24小时制。
<br/>
- h：12小时制。
<br/>
- m：分钟。
<br/>
- s：秒。
<br/>
- SSS：毫秒。
|
| 名称 | 参数类型 | 描述 |
| ------ | --------------- | ------------------------------------------------------------ |
| format | string
| 设置显示时间格式。
<br/>
日期间隔符固定为"/"，时间间隔符为":"。
<br/>
如yyyyMMdd，yyyy-MM-dd显示为yyyy/MM/dd，
<br/>
hhmmss显示为hh:mm:ss。
<br/>
时间格式只用写一位即可，如"hhmmss"等同于"hms"。
<br/>
支持的时间格式化字符串：
<br/>
- YYYY/yyyy：完整年份。
<br/>
- YY/yy：年份后两位。
<br/>
- M：月份(若想使用01月则使用MM)。
<br/>
- d：日期(若想使用01日则使用dd)。
<br/>
- D：年中日(一年中的第几天)。
<br/>
- H：24小时制。
<br/>
- h：12小时制。
<br/>
- m：分钟。
<br/>
- s：秒。
<br/>
- SSS：毫秒。
<br/>
默认值： 'hms'
|
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md
浏览文件 @
280a29da
...
...
@@ -20,6 +20,7 @@ TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Te
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----------------------- | ---------------------------------------- | ---- | --------------- |
<<<<<<< Updated upstream
| placeholder |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否 | 无输入时的提示文本。 |
| text |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否 | 设置输入框当前的文本内容。 |
| controller
<sup>
8+
</sup>
|
[
TextInputController
](
#textinputcontroller8
)
| 否 | 设置TextInput控制器。 |
...
...
@@ -32,13 +33,13 @@ TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Te
| 名称 | 参数类型 | 描述 |
| ------------------------ | ---------------------------------------- | ---------------------------------------- |
| type | InputType | 设置输入框类型。
<br/>
默认值：InputType.Normal |
| placeholderColor |
[
ResourceColor
](
ts-types.md
)
| 设置placeholder颜色。|
| placeholderColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置placeholder颜色。|
| placeholderFont |
[
Font
](
ts-types.md#font
)
| 设置placeholder文本样式。 |
| enterKeyType | EnterKeyType | 设置输入法回车键类型。
<br/>
默认值：EnterKeyType.Done |
| caretColor |
[
ResourceColor
](
ts-types.md
)
| 设置输入框光标颜色。 |
| caretColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置输入框光标颜色。 |
| maxLength | number | 设置文本的最大输入字符数。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](ts-types.md#resourcestr),
<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
)
| 设置文本是否可复制。 |
| inputFilter
<sup>
8+
</sup>
| {
<br/>
value:
[ResourceStr](ts-types.md#resourcestr),
<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/>
默认值：TextInputStyle.Default |
| textAlign
<sup>
9+
</sup>
|
[
TextAlign
](
ts-appendix-enums.md#textalign
)
| 设置文本水平对齐式。
<br/>
默认值：TextAlign.Start |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md
浏览文件 @
280a29da
...
...
@@ -3,12 +3,11 @@
通过文本显示计时信息并控制其计时器状态的组件。
> **说明：**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
...
...
@@ -20,18 +19,19 @@
TextTimer(options?: { isCountDown?: boolean, count?: number, controller?: TextTimerController })
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| isCountDown | boolean | 否 | false | 是否倒计时。 |
| count | number | 否 | 60000 | 倒计时时间（isCountDown为true时生效），单位为毫秒。
<br/>
-
count
<
=0时，使用默认值为倒计时初始值。
<br/>
-
count
>
0时，count值为倒计时初始值。 |
| controller |
[
TextTimerController
](
#texttimercontroller
)
| 否 | - | TextTimer控制器。 |
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----------- | -------- | -------- | -------- | -------- |
| isCountDown | boolean | 否 | 是否倒计时。
<br/>
默认值：false |
| count | number | 否 | 倒计时时间（isCountDown为true时生效），单位为毫秒。
<br/>
-
count
<
=0时，使用默认值为倒计时初始值。
<br/>
-
count
>
0时，count值为倒计时初始值。
<br/>
默认值：60000 |
| controller |
[
TextTimerController
](
#texttimercontroller
)
| 否 | TextTimer控制器。 |
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| -------- | --------
| -------- |
-------- |
| format
| string | 'hh:mm:ss.ms' | 自定义格式，需至少包含一个hh、mm、ss、ms中的关键字。
|
| 名称
| 参数类型 | 描述
|
| -------- | --------
-------------- | --------------
-------- |
| format
| string | 自定义格式，需至少包含一个hh、mm、ss、ms中的关键字。
<br/>
默认值：'hh:mm:ss.ms'
|
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md
浏览文件 @
280a29da
...
...
@@ -3,12 +3,11 @@
组件提供勾选框样式、状态按钮样式及开关样式。
> **说明：**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
...
...
@@ -20,27 +19,28 @@
Toggle(options: { type: ToggleType, isOn?: boolean })
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| type | ToggleType | 是 | - | 开关类型。 |
| isOn | boolean | 否 | false | 开关是否打开，true：打开，false：关闭。 |
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ---- | ---------- | -----| -------------- |
| type | ToggleType | 是 | 开关类型。 |
| isOn | boolean | 否 | 开关是否打开，true：打开，false：关闭。
<br/>
默认值：false |
-
ToggleType枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Checkbox | 提供单选框样式。
<br>
>
**说明：**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)的默认值为：
<br>
{
<br>
top: 14 vp,
<br>
right: 6 vp,
<br>
bottom: 14 vp,
<br>
left: 6 vp
<br>
} |
| Button | 提供状态按钮样式，如果子组件有文本设置，则相应的文本内容会显示在按钮内部。 |
| Switch | 提供开关样式。
<br>
>
**说明：**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)默认值为：
<br>
{
<br/>
top: 12 vp,
<br/>
right: 12 vp,
<br/>
bottom: 12 vp,
<br/>
left: 12 vp
<br/>
} |
## ToggleType枚举说明
| 名称 | 描述 |
| -------- | ---------------- |
| Checkbox | 提供单选框样式。
<br>
>
**说明：**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)的默认值为：
<br>
{
<br>
top: 14 vp,
<br>
right: 6 vp,
<br>
bottom: 14 vp,
<br>
left: 6 vp
<br>
} |
| Button | 提供状态按钮样式，如果子组件有文本设置，则相应的文本内容会显示在按钮内部。 |
| Switch | 提供开关样式。
<br>
>
**说明：**
<br/>
>
[通用属性padding](ts-universal-attributes-size.md)默认值为：
<br>
{
<br/>
top: 12 vp,
<br/>
right: 12 vp,
<br/>
bottom: 12 vp,
<br/>
left: 12 vp
<br/>
} |
## 属性
| 名称
| 参数 | 默认值 | 参数描述
|
| --------
| -------- | -------- |
-------- |
| selectedColor
|
[
ResourceColor
](
ts-types.md
)
| -
| 设置组件打开状态的背景颜色。 |
| switchPointColor |
[
ResourceColor
](
ts-types.md
)
| -
| 设置Switch类型的圆形滑块颜色。
<br/>
>
**说明：**
<br/>
>
仅对type为ToggleType.Switch生效。 |
| 名称
| 参数 | 参数描述
|
| --------
-------- | --------------------------- | --------------
-------- |
| selectedColor
|
[
ResourceColor
](
ts-types.md#resourcecolor
)
| 设置组件打开状态的背景颜色。 |
| switchPointColor |
[
ResourceColor
](
ts-types.md
#resourcecolor
)
| 设置Switch类型的圆形滑块颜色。
<br/>
>
**说明：**
<br/>
>
仅对type为ToggleType.Switch生效。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md
浏览文件 @
280a29da
# XComponent
> **说明：**
可用于EGL/OpenGLES和媒体数据写入，并显示在XComponent组件。
> 该组件从API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
> **说明：**
>
> 该组件从API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
可用于EGL/OpenGLES和媒体数据写入，并显示在XComponent组件。
## 权限列表
无
## 子组件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md
浏览文件 @
280a29da
...
...
@@ -3,40 +3,41 @@
显示警告弹窗组件，可设置文本内容与响应回调。
> **说明：**
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 属性
| 名称 | 参数类型 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- |
| show | AlertDialogParamWithConfirm
\|
AlertDialogParamWithButtons | - | 定义并显示AlertDialog组件。 |
<<<<<<< Updated upstream
| 名称 | 参数类型 | 参数描述 |
| ---- | --------------- | -------- |
| show | AlertDialogParamWithConfirm
\|
AlertDialogParamWithButtons | 定义并显示AlertDialog组件。 |
## AlertDialogParamWithConfirm对象说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述
|
| -------- | -------- | -------- | -------- |
-------- |
| title |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否 | -
| 弹窗标题。 |
| message |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 是 | -
| 弹窗内容。 |
| autoCancel | boolean | 否 | true | 点击遮障层时，是否关闭弹窗。
|
| confirm | {
<br/>
value:
string
\|
[Resource](ts-types.md#resource类型),
<br/>
fontColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource类型),
<br/>
backgroundColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource类型),
<br/>
action:
()
=
>
void
<br/>
} | 否 | -
| 确认按钮的文本内容、文本色、按钮背景色和点击回调。 |
| cancel | ()
=
>
void | 否 | -
| 点击遮障层关闭dialog时的回调。 |
| alignment |
[
DialogAlignment
](
ts-methods-custom-dialog-box.md
)
| 否 | DialogAlignment.Default | 弹窗在竖直方向上的对齐方式。
|
| offset |
[
Offset
](
ts-types.md#offset
)
| 否 | -
| 弹窗相对alignment所在位置的偏移量。 |
| gridCount | number | 否 | - | 弹窗容器宽度所占用栅格数。
|
| 参数名 | 参数类型 | 必填 | 参数描述
|
| ---------- | ---------------- | ---------- | -----------------------
-------- |
| title |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否
| 弹窗标题。 |
| message |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 是
| 弹窗内容。 |
| autoCancel | boolean | 否 | 点击遮障层时，是否关闭弹窗。
<br>
默认值：true
|
| confirm | {
<br/>
value:
string
\|
[Resource](ts-types.md#resource),
<br/>
fontColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource),
<br/>
backgroundColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource),
<br/>
action:
()
=
>
void
<br/>
} | 否
| 确认按钮的文本内容、文本色、按钮背景色和点击回调。 |
| cancel | ()
=
>
void | 否
| 点击遮障层关闭dialog时的回调。 |
| alignment |
[
DialogAlignment
](
ts-methods-custom-dialog-box.md
)
| 否 | 弹窗在竖直方向上的对齐方式。
<br>
默认值：DialogAlignment.Default
|
| offset |
[
Offset
](
ts-types.md#offset
)
| 否
| 弹窗相对alignment所在位置的偏移量。 |
| gridCount | number | 否 | 弹窗容器宽度所占用栅格数。
|
## AlertDialogParamWithButtons对象说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| title |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否 | - | 弹窗标题。 |
| message |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 是 | - | 弹窗内容。 |
| autoCancel | boolean | 否 | true | 点击遮障层时，是否关闭弹窗。 |
| primaryButton | {
<br/>
value:
string
\|
[Resource](ts-types.md#resource类型),
<br/>
fontColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource类型),
<br/>
backgroundColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource类型),
<br/>
action:
()
=
>
void;
<br/>
} | 否 | - | 按钮的文本内容、文本色、按钮背景色和点击回调。 |
| secondaryButton | {
<br/>
value:
string
\|
[Resource](ts-types.md#resource类型),
<br/>
fontColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource类型),
<br/>
backgroundColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource类型),
<br/>
action:
()
=
>
void;
<br/>
} | 否 | - | 按钮的文本内容、文本色、按钮背景色和点击回调。 |
| cancel | ()
=
>
void | 否 | - | 点击遮障层关闭dialog时的回调。 |
| alignment |
[
DialogAlignment
](
ts-methods-custom-dialog-box.md
)
| 否 | DialogAlignment.Default | 弹窗在竖直方向上的对齐方式。 |
| offset |
[
Offset
](
ts-types.md#offset
)
| 否 | - | 弹窗相对alignment所在位置的偏移量。 |
| gridCount | number | 否 | - | 弹窗容器宽度所占用栅格数。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| --------------- | ---------------------- | ------------ | --------------------- |
| title |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 否 | 弹窗标题。 |
| message |
[
ResourceStr
](
ts-types.md#resourcestr
)
| 是 | 弹窗内容。 |
| autoCancel | boolean | 否 | 点击遮障层时，是否关闭弹窗。
<br>
默认值：true |
| primaryButton | {
<br/>
value:
string
\|
[Resource](ts-types.md#resource),
<br/>
fontColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource),
<br/>
backgroundColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource),
<br/>
action:
()
=
>
void;
<br/>
} | 否 | 按钮的文本内容、文本色、按钮背景色和点击回调。 |
| secondaryButton | {
<br/>
value:
string
\|
[Resource](ts-types.md#resource),
<br/>
fontColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource),
<br/>
backgroundColor?:
Color
\|
number
\|
string
\|
[Resource](ts-types.md#resource),
<br/>
action:
()
=
>
void;
<br/>
} | 否 | 按钮的文本内容、文本色、按钮背景色和点击回调。 |
| cancel | ()
=
>
void | 否 | 点击遮障层关闭dialog时的回调。 |
| alignment |
[
DialogAlignment
](
ts-methods-custom-dialog-box.md
)
| 否 | 弹窗在竖直方向上的对齐方式。
<br>
默认值：DialogAlignment.Default |
| offset |
[
Offset
](
ts-types.md#offset
)
| 否 | 弹窗相对alignment所在位置的偏移量。 |
| gridCount | number | 否 | 弹窗容器宽度所占用栅格数。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-backgroundBlurStyle.md
浏览文件 @
280a29da
...
...
@@ -6,25 +6,19 @@
>
>从API Version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称
| 参数类型 | 默认值
| 描述 |
| ------------
| -----
-------- | ----------------------- | ------------------------ |
| backgroundBlurStyle
|
[
BlurStyle
](
#blurstyle
)
| - | 为当前组件提供一种在背景和内容之间的模糊能力，入参为模糊材质。
| 名称
| 参数类型
| 描述 |
| -------------------- | ----------------------- | ------------------------ |
| backgroundBlurStyle
|
[
BlurStyle
](
#blurstyle
)
| 为当前组件提供一种在背景和内容之间的模糊能力，入参为模糊材质。|
## BlurStyle
| 名称 | 描述 |
| ------ | ----------------------------------------------- |
| Thin | 轻薄材质。 |
| Regular | 普通厚度材质。 |
| Thick | 厚材质。 |
| 名称 | 描述 |
| ------- | ---------- |
| Thin | 轻薄材质。 |
| Regular | 普通厚度材质。 |
| Thick | 厚材质。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md
浏览文件 @
280a29da
...
...
@@ -10,9 +10,9 @@
## 属性
|
**名称**
|
**参数类型**
|
**默认值**
|
**描述**
|
| ---------
| -------- | ------- |
-------------- |
| touchable
| boolean | true | 设置当前组件是否可以响应点击事件、触摸事件等手指交互事件。
|
|
**名称**
|
**参数类型**
|
**描述**
|
| ---------
-- | -------- | ----------
-------------- |
| touchable
| boolean | 设置当前组件是否可以响应点击事件、触摸事件等手指交互事件。
<br>
默认值：true
|
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md
浏览文件 @
280a29da
...
...
@@ -3,19 +3,15 @@
id为组件的唯一标识，在整个应用内唯一。本模块提供组件标识相关接口，可以获取指定id组件的属性，也提供向指定id组件发送事件的功能。
> **说明：**
>
> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称
| 参数说明 | 默认值 | 描述
|
| -----
--- | -------- | -------- |
-------- |
| id
| string | '' | 组件的唯一标识，唯一性由使用者保证。
|
| 名称
| 参数说明 | 描述
|
| -----
| -------- | ---------------------
-------- |
| id
| string | 组件的唯一标识，唯一性由使用者保证。
<br>
默认值：' '
|
## 接口
...
...
@@ -27,15 +23,17 @@ getInspectorByKey(id: string): string
获取指定id的组件的所有属性，不包括子组件信息。
-
参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| id | string | 是 | - | 要获取属性的组件id。 |
**参数:**
| 参数 | 类型 | 必填 | 描述 |
| ---- | -------- | ---- | -------------|
| id | string | 是 | 要获取属性的组件id。 |
-
返回值
| 类型 | 描述 |
| -------- | -------- |
| string | 组件属性列表的JSON字符串。 |
**返回值:**
| 类型 | 描述 |
| -------| -------------- |
| string | 组件属性列表的JSON字符串。 |
### getInspectorTree<sup>9+</sup>
...
...
@@ -43,11 +41,11 @@ getInspectorTree(): string
获取组件树及组件属性。
-
返回值
**返回值:**
| 类型 | 描述
|
| ------ | -------
--------------------------- |
| string | 组件树及组件属性列表的JSON字符串。 |
| 类型 | 描述
|
| ------ |
--------------------------- |
| string | 组件树及组件属性列表的JSON字符串。 |
### sendEventByKey<sup>9+</sup>
...
...
@@ -55,17 +53,19 @@ sendEventByKey(id: string, action: number, params: string): boolean
给指定id的组件发送事件。
-
参数
| 参数 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| id | string | 是 | - | 要触发事件的组件的id。 |
| action | number | 是 | - | 要触发的事件类型，目前支持取值：
<br/>
-
点击事件Click:
10
<br/>
-
长按事件LongClick:
11。 |
| params | string | 是 | - | 事件参数，无参数传空字符串
""。 |
**参数:**
| 参数 | 类型 | 必填 | 描述 |
| ------ | -------| ---- | -------------------------- |
| id | string | 是 | 要触发事件的组件的id。 |
| action | number | 是 | 要触发的事件类型，目前支持取值：
<br/>
-
点击事件Click:
10
<br/>
-
长按事件LongClick:
11。 |
| params | string | 是 | 事件参数，无参数传空字符串
""。 |
**返回值:**
-
返回值
| 类型 | 描述 |
| -------- | -------- |
| boolean | 找不到指定id的组件时返回false，其余情况返回true。 |
| 类型 | 描述 |
| -------- | --------------------------|
| boolean | 找不到指定id的组件时返回false，其余情况返回true。 |
### sendTouchEvent<sup>9+</sup>
...
...
@@ -73,17 +73,17 @@ sendTouchEvent(event: TouchObject): boolean
发送触摸事件。
-
参数
**参数:**
| 参数 | 类型 | 必填 | 默认值
| 描述 |
| ----- | ----------- | ---- | --
---- | ------------------------------------------------------------ |
| event | TouchObject | 是 | -
| 触发触摸事件的位置，event参数见
[
TouchEvent
](
ts-universal-events-touch.md#touchevent对象说明
)
中TouchObject的介绍。 |
| 参数 | 类型 | 必填
| 描述 |
| ----- | ----------- |
---- | ------------------------------------------------------------ |
| event | TouchObject | 是
| 触发触摸事件的位置，event参数见
[
TouchEvent
](
ts-universal-events-touch.md#touchevent对象说明
)
中TouchObject的介绍。 |
-
返回值
**返回值:**
| 类型 | 描述
|
| ------- | -------------------------------------------
|
| boolean | 事件发送失败时返回false，其余情况返回true。 |
| 类型 | 描述
|
| ------- | ---------------------------
|
| boolean | 事件发送失败时返回false，其余情况返回true。 |
### sendKeyEvent<sup>9+</sup>
...
...
@@ -91,17 +91,17 @@ sendKeyEvent(event: KeyEvent): boolean
发送按键事件。
-
参数
**参数:**
| 参数 | 类型 | 必填 | 默认值
| 描述 |
| ----- | -------- | ---- | ------
| ------------------------------------------------------------ |
| event | KeyEvent | 是 | -
| 按键事件，event参数见
[
KeyEvent
](
ts-universal-events-key.md#keyevent对象说明
)
介绍。 |
| 参数 | 类型 | 必填
| 描述 |
| ----- | -------- | ----
| ------------------------------------------------------------ |
| event | KeyEvent | 是
| 按键事件，event参数见
[
KeyEvent
](
ts-universal-events-key.md#keyevent对象说明
)
介绍。 |
-
返回值
**返回值:**
| 类型 | 描述
|
| ------- | ---------------------------------------------
|
| boolean | 事件发送失败时时返回false，其余情况返回true。 |
| 类型 | 描述
|
| ------- | ------------------------------
|
| boolean | 事件发送失败时时返回false，其余情况返回true。 |
### sendMouseEvent<sup>9+</sup>
...
...
@@ -109,17 +109,17 @@ sendMouseEvent(event: MouseEvent): boolean
发送鼠标事件。
-
参数
**参数：**
| 参数 | 类型 | 必填 | 默认值 | 描述
|
| ----- | ---------- | ---- | ------ | ---------------------
--------------------------------------- |
| event | MouseEvent | 是 | -
| 鼠标事件，event参数见
[
MouseEvent
](
ts-universal-mouse-key.md#mouseevent对象说明
)
介绍。 |
| 参数 | 类型 | 必填 | 描述
|
| ----- | ---------- | ---- |
--------------------------------------- |
| event | MouseEvent | 是
| 鼠标事件，event参数见
[
MouseEvent
](
ts-universal-mouse-key.md#mouseevent对象说明
)
介绍。 |
-
返回值
**返回值：**
| 类型 | 描述
|
| ------- | -----------
---------------------------------- |
| boolean | 事件发送失败时
时返回false，其余情况返回true。 |
| 类型 | 描述
|
| ------- |
---------------------------------- |
| boolean | 事件发送失败
时返回false，其余情况返回true。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md
浏览文件 @
280a29da
...
...
@@ -7,19 +7,14 @@
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| --------
| -------- | -------- |
-------- |
| linearGradient | {
<br/>
angle?:
number
\|
string,
<br/>
direction?:
[GradientDirection](ts-appendix-enums.md#gradientdirection),
<br/>
colors:
Array
<
[ColorStop](ts-basic-components-gauge.md#colorstop)
>
,
<br/>
repeating?:
boolean
<br/>
} |
- | 线性渐变。
<br/>
angle:
线性渐变的角度。
<br/>
direction:
线性渐变的方向，设置angle后不生效。
<br/>
colors:
为渐变的颜色描述。
<br/>
repeating:
为渐变的颜色重复着色。 |
| sweepGradient
| {
<br/>
center:
Point,
<br/>
start?:
number
\|
string,
<br/>
end?:
number
\|
string,
<br/>
rotation?:
number\|string,
<br/>
colors:
Array
<
[ColorStop](ts-basic-components-gauge.md#colorstop)
>
,
<br/>
repeating?:
boolean
<br/>
} | - | 角度渐变。
<br/>
center：为角度渐变的中心点。
<br/>
start：角度渐变的起点。
<br/>
end：角度渐变的终点。
<br/>
rotation:
角度渐变的旋转角度。
<br/>
colors:
为渐变的颜色描述。
<br/>
repeating:
为渐变的颜色重复着色。 |
| radialGradient | {
<br/>
center:
Point,
<br/>
radius:
number
\|
string,
<br/>
colors:
Array
<
[ColorStop](ts-basic-components-gauge.md#colorstop)
>
,
<br/>
repeating?:
boolean
<br/>
} | - | 径向渐变。
<br/>
center：径向渐变的中心点。
<br/>
radius：径向渐变的半径。
<br/>
colors:
为渐变的颜色描述。
<br/>
repeating:
为渐变的颜色重复着色。 |
| 名称
| 参数类型 | 描述
|
| --------
------ | -------------------------------------------- | ---------------------------
-------- |
| linearGradient | {
<br/>
angle?:
number
\|
string,
<br/>
direction?:
[GradientDirection](ts-appendix-enums.md#gradientdirection),
<br/>
colors:
Array
<
[ColorStop](ts-basic-components-gauge.md#colorstop)
>
,
<br/>
repeating?:
boolean
<br/>
} |
线性渐变。
<br/>
- angle:
线性渐变的角度。
<br/>
- direction:
线性渐变的方向，设置angle后不生效。
<br/>
- colors:
为渐变的颜色描述。
<br/>
-
repeating:
为渐变的颜色重复着色。 |
| sweepGradient
| {
<br/>
center:
Point,
<br/>
start?:
number
\|
string,
<br/>
end?:
number
\|
string,
<br/>
rotation?:
number\|string,
<br/>
colors:
Array
<
[ColorStop](ts-basic-components-gauge.md#colorstop)
>
,
<br/>
repeating?:
boolean
<br/>
} | 角度渐变。
<br/>
- center：为角度渐变的中心点。
<br/>
- start：角度渐变的起点。
<br/>
- end：角度渐变的终点。
<br/>
- rotation:
角度渐变的旋转角度。
<br/>
- colors:
为渐变的颜色描述。
<br/>
-
repeating:
为渐变的颜色重复着色。 |
| radialGradient | {
<br/>
center:
Point,
<br/>
-radius:
number
\|
string,
<br/>
colors:
Array
<
[ColorStop](ts-basic-components-gauge.md#colorstop)
>
,
<br/>
repeating?:
boolean
<br/>
} | 径向渐变。
<br/>
- center：径向渐变的中心点。
<br/>
- radius：径向渐变的半径。
<br/>
- colors:
为渐变的颜色描述。
<br/>
-
repeating:
为渐变的颜色重复着色。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-grid.md
浏览文件 @
280a29da
...
...
@@ -6,19 +6,14 @@
> - 栅格布局的列宽、列间距由距离最近的GridContainer父组件决定。使用栅格属性的组件树上至少需要有1个GridContainer容器组件。
## 权限列表
无
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| --------
| -------- | -------- |
-------- |
| useSizeType | {
<br/>
xs?:
number
\|
{
span:
number,
offset:
number
},
<br/>
sm?:
number
\|
{
span:
number,
offset:
number
},
<br/>
md?:
number
\|
{
span:
number,
offset:
number
},
<br/>
lg?:
number
\|
{
span:
number,
offset:
number
}
<br/>
} |
- |
设置在特定设备宽度类型下的占用列数和偏移列数，span:
占用列数;
offset:
偏移列数。
<br/>
当值为number类型时，仅设置列数，
当格式如{"span":
1,
"offset":
0}时，指同时设置占用列数与偏移列数。
<br/>
-
xs:
指设备宽度类型为SizeType.XS时的占用列数和偏移列数。
<br/>
-
sm:
指设备宽度类型为SizeType.SM时的占用列数和偏移列数。
<br/>
-
md:
指设备宽度类型为SizeType.MD时的占用列数和偏移列数。
<br/>
-
lg:
指设备宽度类型为SizeType.LG时的占用列数和偏移列数。 |
| gridSpan
| number | 1 | 默认占用列数，指useSizeType属性没有设置对应尺寸的列数（span)时，占用的栅格列数。
<br/>
>
**说明：**
<br/>
>
设置了栅格span属性，组件的宽度由栅格布局决定。
|
| gridOffset
| number | 0 | 默认偏移列数，指useSizeType属性没有设置对应尺寸的偏移(offset)时，
当前组件沿着父组件Start方向，偏移的列数，也就是当前组件位于第n列。
<br/>
>
**说明：**
<br/>
>
-配置该属性后，当前组件在父组件水平方向的布局不再跟随父组件原有的布局方式，而是沿着父组件的Start方向偏移一定位移。
<br/>
>
-偏移位移
=
（列宽
+
间距）\*
列数。
<br/>
>
-设置了偏移(gridOffset)的组件之后的兄弟组件会根据该组件进行相对布局，类似相对布局。
|
| 名称
| 参数类型 | 描述
|
| --------
--- | --------------------------| ---------------------------------------
-------- |
| useSizeType | {
<br/>
xs?:
number
\|
{
span:
number,
offset:
number
},
<br/>
sm?:
number
\|
{
span:
number,
offset:
number
},
<br/>
md?:
number
\|
{
span:
number,
offset:
number
},
<br/>
lg?:
number
\|
{
span:
number,
offset:
number
}
<br/>
} | 设置在特定设备宽度类型下的占用列数和偏移列数，span:
占用列数;
offset:
偏移列数。
<br/>
当值为number类型时，仅设置列数，
当格式如{"span":
1,
"offset":
0}时，指同时设置占用列数与偏移列数。
<br/>
-
xs:
指设备宽度类型为SizeType.XS时的占用列数和偏移列数。
<br/>
-
sm:
指设备宽度类型为SizeType.SM时的占用列数和偏移列数。
<br/>
-
md:
指设备宽度类型为SizeType.MD时的占用列数和偏移列数。
<br/>
-
lg:
指设备宽度类型为SizeType.LG时的占用列数和偏移列数。 |
| gridSpan
| number | 默认占用列数，指useSizeType属性没有设置对应尺寸的列数（span)时，占用的栅格列数。
<br/>
**说明：**
<br/>
设置了栅格span属性，组件的宽度由栅格布局决定。
<br>
默认值：1
|
| gridOffset
| number | 默认偏移列数，指useSizeType属性没有设置对应尺寸的偏移(offset)时，
当前组件沿着父组件Start方向，偏移的列数，也就是当前组件位于第n列。
<br/>
**说明：**
<br/>
-配置该属性后，当前组件在父组件水平方向的布局不再跟随父组件原有的布局方式，而是沿着父组件的Start方向偏移一定位移。
<br/>
-偏移位移
=
（列宽
+
间距）\*
列数。
<br/>
-设置了偏移(gridOffset)的组件之后的兄弟组件会根据该组件进行相对布局，类似相对布局。
<br>
默认值：0
|
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hit-test-behavior.md
浏览文件 @
280a29da
...
...
@@ -4,28 +4,23 @@
> **说明：**
> - 从API Version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
> - 当Stack组件中有多个节点触摸区域重叠时，如两个节点，默认只会对显示在最上层的节点做触摸测试，若需要显示在下层的节点触发触摸测试，请给显示在上层的节点设置hitTestBehavior为HitTestMode.Transparent。
## 权限列表
无
> - 当Stack组件中有多个节点触摸区域重叠时，如两个节点，默认只会对显示在最上层的节点做触摸测试，若需要显示在下层的节点触发触摸测试，请给显示在上层的节点设置hitTestBehavior为HitTestMode.Transparent。
## 属性
|
**名称**
|
**参数类型**
|
**默认值**
|
**描述**
|
| -------------------- | -------- | -------
| -------
--------------------------------- |
| hitTestBehavior | HitTestMode |
HitTestMode.Default | 设置当前组件的触摸测试类型。
|
|
**名称**
|
**参数类型**
|
**描述**
|
| -------------------- | -------- | ---------------------------------------- |
| hitTestBehavior | HitTestMode |
设置当前组件的触摸测试类型。
<br>
默认值： HitTestMode.Default
|
-
HitTestMode 枚举说明
##
HitTestMode 枚举说明
| 名称
| 描述
|
| --------
|
-------- |
| Default | 默认触摸测试效果，自身和子节点都响应触摸测试，但会阻塞兄弟节点的触摸测试。 |
| Block | 自身响应触摸测试，阻塞子节点和兄弟节点的触摸测试。 |
| 名称
| 描述
|
| --------
----| ---------------------------------
-------- |
| Default
| 默认触摸测试效果，自身和子节点都响应触摸测试，但会阻塞兄弟节点的触摸测试。 |
| Block
| 自身响应触摸测试，阻塞子节点和兄弟节点的触摸测试。 |
| Transparent | 自身和子节点都响应触摸测试，不会阻塞兄弟节点的触摸测试。 |
| None | 自身不响应触摸测试，不会阻塞子节点和兄弟节点的触摸测试。 |
| None
| 自身不响应触摸测试，不会阻塞子节点和兄弟节点的触摸测试。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md
浏览文件 @
280a29da
...
...
@@ -3,19 +3,15 @@
设置组件的鼠标悬浮态显示效果。
> **说明：**
>
> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| --------
| -------- | -------- |
-------- |
| hoverEffect |
[
HoverEffect
](
ts-appendix-enums.md#hovereffect8
)
| HoverEffect.Auto | 设置当前组件悬停态下的悬浮效果。
|
| 名称
| 参数类型 | 描述
|
| --------
--- | --------------------------------------------------| ----------------------------------------
-------- |
| hoverEffect |
[
HoverEffect
](
ts-appendix-enums.md#hovereffect8
)
| 设置当前组件悬停态下的悬浮效果。
<br>
默认值：HoverEffect.Auto
|
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
浏览文件 @
280a29da
...
...
@@ -10,10 +10,10 @@
## 属性
| 名称
| 参数类型
| 描述 |
| 名称
| 参数类型
| 描述 |
| ---------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| bindMenu | Array<MenuItem
>
\|
[
CustomBuilder
](
ts-types.md
)
| 给组件绑定菜单，点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 |
| bindContextMenu
<sup>
8+
</sup>
| content:
[CustomBuilder](ts-types.md),
<br>
responseType:
[
ResponseType
](
ts-appendix-enums.md#responsetype8
)
| 给组件绑定菜单，触发方式为长按或者右键点击，弹出菜单项需要自定义。 |
| bindMenu | Array<MenuItem
>
\|
[
CustomBuilder
](
ts-types.md
#custombuilder8
)
| 给组件绑定菜单，点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 |
| bindContextMenu
<sup>
8+
</sup>
| content:
[CustomBuilder](ts-types.md
#custombuilder8
),
<br>
responseType:
[
ResponseType
](
ts-appendix-enums.md#responsetype8
)
| 给组件绑定菜单，触发方式为长按或者右键点击，弹出菜单项需要自定义。 |
## MenuItem
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
浏览文件 @
280a29da
...
...
@@ -3,20 +3,14 @@
设置组件的遮罩文本。
> **说明：**
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| overlay | value:
string,
<br/>
options?:
{
<br/>
align?:
[Alignment](ts-appendix-enums.md#alignment),
<br/>
offset?:
{x?:
number, y?:
number}
<br/>
} | {
<br/>
align:
Alignment.Center,
<br/>
offset:
{0,
0}
<br/>
} | 在当前组件上，增加遮罩文本，布局与当前组件相同。 |
| 名称 | 参数类型 | 描述 |
| ------- | ----------------------------- | ------------------------- |
| overlay | value:
string,
<br/>
options?:
{
<br/>
align?:
[Alignment](ts-appendix-enums.md#alignment),
<br/>
offset?:
{
<br>
x?:
number,
<br>
y?:
number
<br>
}
<br/>
} | 在当前组件上，增加遮罩文本，布局与当前组件相同。
<br>
默认值：
<br>
{
<br/>
align:
Alignment.Center,
<br/>
offset:
{0,
0}
<br/>
} |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
浏览文件 @
280a29da
...
...
@@ -10,33 +10,33 @@
## 接口
| 名称
| 参数类型 | 描述
|
| --------
| -------- |
-------- |
| bindPopup | show:
boolean,
<br/>
popup:
PopupOptions
\|
CustomPopupOptions
<sup>
8+
</sup>
| 给组件绑定Popup，点击弹出弹窗。
<br/>
show:
创建页面弹窗提示是否默认显示，默认值为false。
<br/>
popup:
配置当前弹窗提示的参数。 |
| 名称
| 参数类型 | 描述
|
| --------
-- | ------------------------------------- | -------------------------------
-------- |
| bindPopup
| show:
boolean,
<br/>
popup:
PopupOptions
\|
CustomPopupOptions
<sup>
8+
</sup>
| 给组件绑定Popup，点击弹出弹窗。
<br/>
show:
创建页面弹窗提示是否默认显示，默认值为false。
<br/>
popup:
配置当前弹窗提示的参数。 |
## PopupOptions类型说明
| 名称
| 类型 | 必填 | 描述
|
| --------
| -------- | -------- |
-------- |
| message
| string | 是 | 弹窗信息内容。
|
| placementOnTop
| boolean | 否 | 是否在组件上方显示，默认值为false。
|
| arrowOffset
<sup>
9+
</sup>
|
[
Length
](
ts-types.md#length
)
| 否 | popup箭头在弹窗处的偏移。箭头在气泡上下方时，默认居左；箭头在气泡左右侧时，默认居上。
|
| primaryButton
| {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | 第一个按钮。
<br/>
value:
弹窗里主按钮的文本。
<br/>
action:
点击主按钮的回调函数。 |
| secondaryButton
| {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | 第二个按钮。
<br/>
value:
弹窗里辅助按钮的文本。
<br/>
action:
点击辅助按钮的回调函数。 |
| onStateChange
| (event:
{
isVisible:
boolean
})
=
>
void | 否 | 弹窗状态变化事件回调，参数isVisible为弹窗当前的显示状态。
|
| 名称
| 类型 | 必填 | 描述
|
| --------
-----------------| ------------------------------------------------| -----| ---------------------------------
-------- |
| message
| string | 是 | 弹窗信息内容。
|
| placementOnTop
| boolean | 否 | 是否在组件上方显示，默认值为false。
|
| arrowOffset
<sup>
9+
</sup>
|
[
Length
](
ts-types.md#length
)
| 否 | popup箭头在弹窗处的偏移。箭头在气泡上下方时，默认居左；箭头在气泡左右侧时，默认居上。
|
| primaryButton
| {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | 第一个按钮。
<br/>
- value:
弹窗里主按钮的文本。
<br/>
-
action:
点击主按钮的回调函数。 |
| secondaryButton
| {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | 第二个按钮。
<br/>
- value:
弹窗里辅助按钮的文本。
<br/>
-
action:
点击辅助按钮的回调函数。 |
| onStateChange
| (event:
{
isVisible:
boolean
})
=
>
void | 否 | 弹窗状态变化事件回调，参数isVisible为弹窗当前的显示状态。
|
## CustomPopupOptions<sup>8+</sup>类型说明
| 名称
| 类型 | 必填 | 描述
|
| --------
| -------- | -------- |
-------- |
| builder
|
[
CustomBuilder
](
ts-types.md
)
| 是 | 提示气泡内容的构造器。
|
| placement
|
[
Placement
](
ts-appendix-enums.md#placement8
)
| 否 | 气泡组件优先显示的位置，当前位置显示不下时，会自动调整位置。
<br/>
默认值：Placement.Bottom
|
| arrowOffset
<sup>
9+
</sup>
|
[
Length
](
ts-types.md#length
)
| 否 | popup箭头在弹窗处的偏移。箭头在气泡上下方时，默认居左；箭头在气泡左右侧时，默认居上。
|
| maskColor
|
[
ResourceColor
](
ts-types.md
)
| 否 | 提示气泡遮障层的颜色。
|
| popupColor
|
[
ResourceColor
](
ts-types.md
)
| 否 | 提示气泡的颜色。
|
| enableArrow
| boolean | 否
| 是否显示箭头。
<br/>
从API Version 9开始，如果箭头所在方位侧的气泡长度不足以显示下箭头，则会默认不显示箭头。比如：placement设置为Left，但气泡高度小于箭头的宽度（32vp），则实际不会显示箭头。
<br/>
默认值：true |
| autoCancel
| boolean | 否 | 页面有操作时，是否自动关闭气泡
<br/>
默认值：true
|
| onStateChange
| (event:
{
isVisible:
boolean
})
=
>
void | 否
| 弹窗状态变化事件回调，参数为弹窗当前的显示状态。 |
| 名称
| 类型 | 必填 | 描述
|
| --------
-----------------| ------------------------- | ---- | --------------------------------------------
-------- |
| builder
|
[
CustomBuilder
](
ts-types.md#custombuilder8
)
| 是 | 提示气泡内容的构造器。
|
| placement
|
[
Placement
](
ts-appendix-enums.md#placement8
)
| 否 | 气泡组件优先显示的位置，当前位置显示不下时，会自动调整位置。
<br/>
默认值：Placement.Bottom
|
| arrowOffset
<sup>
9+
</sup>
|
[
Length
](
ts-types.md#length
)
| 否 | popup箭头在弹窗处的偏移。箭头在气泡上下方时，默认居左；箭头在气泡左右侧时，默认居上。
|
| maskColor
|
[
ResourceColor
](
ts-types.md#resourcecolor
)
| 否 | 提示气泡遮障层的颜色。
|
| popupColor
|
[
ResourceColor
](
ts-types.md#resourcecolor
)
| 否 | 提示气泡的颜色。
|
| enableArrow
| boolean | 否
| 是否显示箭头。
<br/>
从API Version 9开始，如果箭头所在方位侧的气泡长度不足以显示下箭头，则会默认不显示箭头。比如：placement设置为Left，但气泡高度小于箭头的宽度（32vp），则实际不会显示箭头。
<br/>
默认值：true |
| autoCancel
| boolean | 否 | 页面有操作时，是否自动关闭气泡
<br/>
默认值：true
|
| onStateChange
| (event:
{
isVisible:
boolean
})
=
>
void | 否
| 弹窗状态变化事件回调，参数为弹窗当前的显示状态。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-sharp-clipping.md
浏览文件 @
280a29da
...
...
@@ -7,18 +7,13 @@
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| -----
--- | -------- | -------- |
-------- |
| clip |
[
Circle
](
ts-drawing-components-circle.md
)
\|
[Ellipse](ts-drawing-components-ellipse.md)
\|
[Path](ts-drawing-components-path.md)
\|
[Rect](ts-drawing-components-rect.md)
\|
boolean |
false | 参数为相应类型的组件，按指定的形状对当前组件进行裁剪；参数为boolean类型时，设置是否按照边缘轮廓进行裁剪。
|
| mask |
[
Circle
](
ts-drawing-components-circle.md
)
\|
[Ellipse](ts-drawing-components-ellipse.md)
\|
[Path](ts-drawing-components-path.md)
\|
[Rect](ts-drawing-components-rect.md)
|
- |
在当前组件上加上指定形状的遮罩。 |
| 名称
| 参数类型 | 描述
|
| -----
| ------------------------------------------ | ----------------------------
-------- |
| clip |
[
Circle
](
ts-drawing-components-circle.md
)
\|
[Ellipse](ts-drawing-components-ellipse.md)
\|
[Path](ts-drawing-components-path.md)
\|
[Rect](ts-drawing-components-rect.md)
\|
boolean |
参数为相应类型的组件，按指定的形状对当前组件进行裁剪；参数为boolean类型时，设置是否按照边缘轮廓进行裁剪。
<br>
默认值：false
|
| mask |
[
Circle
](
ts-drawing-components-circle.md
)
\|
[Ellipse](ts-drawing-components-ellipse.md)
\|
[Path](ts-drawing-components-path.md)
\|
[Rect](ts-drawing-components-rect.md)
| 在当前组件上加上指定形状的遮罩。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md
浏览文件 @
280a29da
...
...
@@ -7,22 +7,16 @@
针对包含文本元素的组件，设置文本样式。
## 权限列表
无
## 属性
| 名称
| 参数类型 | 默认值 | 描述
|
| --------
| -------- | -------- |
-------- |
| fontColor
|
[
ResourceColor
](
ts-types.md
)
| - | 设置文本颜色。
|
| fontSize
| Length
\|
[
Resource
](
ts-types.md#resource类型
)
| - | 设置文本尺寸，Length为number类型时，使用fp单位。
|
| fontStyle
|
[
FontStyle
](
ts-appendix-enums.md#fontstyle
)
| FontStyle.Normal | 设置文本的字体样式。
|
| fontWeight | number
\|
[FontWeight](ts-appendix-enums.md#fontweight)
\|
string
| FontWeight.FontWeightNormal | 设置文本的字体粗细，number类型取值[100,
900]，取值间隔为100，默认为400，取值越大，字体越粗。
<br/>
提供常用枚举值，参考：FontWeight枚举说明。
|
| fontFamily | string
\|
[
Resource
](
ts-types.md#resource
类型
)
| -
| 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial,
sans-serif'。 |
| 名称
| 参数类型 | 描述
|
| --------
---| ---------------------------------------- | ----------------------------
-------- |
| fontColor
|
[
ResourceColor
](
ts-types.md#resourcecolor
)
| 设置文本颜色。
|
| fontSize
| Length
\|
[
Resource
](
ts-types.md#resource
)
| 设置文本尺寸，Length为number类型时，使用fp单位。
|
| fontStyle
|
[
FontStyle
](
ts-appendix-enums.md#fontstyle
)
| 设置文本的字体样式。
<br>
默认值：FontStyle.Normal
|
| fontWeight | number
\|
[FontWeight](ts-appendix-enums.md#fontweight)
\|
string
| 设置文本的字体粗细，number类型取值[100,
900]，取值间隔为100，默认为400，取值越大，字体越粗。
<br/>
默认值：FontWeight.FontWeightNormal
|
| fontFamily | string
\|
[
Resource
](
ts-types.md#resource
)
| 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial,
sans-serif'。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md
浏览文件 @
280a29da
...
...
@@ -10,18 +10,18 @@
## 属性
| 名称
| 参数类型 | 描述
|
| --------
| -------- |
-------- |
| 名称
| 参数类型 | 描述
|
| --------
------ | --------------------------------------------- | ---------------------------------
-------- |
| responseRegion | Array
<
Rectangle
>
\|
Rectangle | 设置一个或多个触摸热区，包括位置和大小。
<br/>
默认值：
<br/>
{
<br/>
x：0,
<br/>
y：0,
<br/>
width：'100%',
<br/>
height：'100%'
<br/>
} |
### Rectangle对象说明
| 名称
| 类型 | 必填 | 描述
|
| ------
-- | -------- | -------- |
-------- |
| x
|
[
Length
](
ts-types.md
)
| 否
| 触摸点相对于组件本身左边沿的X坐标。
<br/>
默认值：0vp |
| y
|
[
Length
](
ts-types.md
)
| 否
| 触摸点相对于组件本身左边沿的Y坐标。
<br/>
默认值：0vp |
| width
|
[
Length
](
ts-types.md
)
| 否
| 触摸热区范围的宽度。
<br/>
默认值：100% |
| height |
[
Length
](
ts-types.md
)
| 否
| 触摸热区范围的高度。
<br/>
默认值：100% |
| 名称
| 类型 | 必填 | 描述
|
| ------
| ----------------------------- | -----| ------------------------
-------- |
| x
|
[
Length
](
ts-types.md#length
)
| 否
| 触摸点相对于组件本身左边沿的X坐标。
<br/>
默认值：0vp |
| y
|
[
Length
](
ts-types.md#length
)
| 否
| 触摸点相对于组件本身左边沿的Y坐标。
<br/>
默认值：0vp |
| width
|
[
Length
](
ts-types.md#length
)
| 否
| 触摸热区范围的宽度。
<br/>
默认值：100% |
| height |
[
Length
](
ts-types.md
#length
)
| 否
| 触摸热区范围的高度。
<br/>
默认值：100% |
> **说明：**
>
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
浏览文件 @
280a29da
...
...
@@ -3,23 +3,18 @@
用于对组件进行旋转、平移、缩放、矩阵变换等操作。
> **说明：**
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称 | 参数类型
| 默认值
| 描述 |
| --------- | ----------------------------------------
| --------
-------------------------------- | ---------------------------------------- |
| rotate | {
<br/>
x?:
number,
<br/>
y?:
number,
<br/>
z?:
number,
<br/>
angle?:
Angle,
<br/>
centerX?:
number
\|
string,
<br/>
centerY?:
number
\|
string
<br/>
} |
{
<br/>
x:
0,
<br/>
y:
0,
<br/>
z:
0,
<br/>
angle:
0,
<br/>
centerX:
'50%',
<br/>
centerY:
'50%'
<br/>
} | (x,
y,
z)指定一个矢量，表示旋转轴，正角度为顺时针转动，负角度为逆时针转动，默认值为0，同时可以通过centerX和centerY设置旋转的中心点。
|
| translate | {
<br/>
x?:
number
\|
string,
<br/>
y?:
number
\|
string,
<br/>
z?
:
number
\|
string
<br/>
}
| {
<br/>
x:
0,
<br/>
y:
0,
<br/>
z:
0
<br/>
} | 可以分别设置X轴、Y轴、Z轴的平移距离，距离的正负控制平移的方向，默认值为0。不支持百分比形式的输入。
|
| scale | {
<br/>
x?:
number,
<br/>
y?:
number,
<br/>
z?:
number,
<br/>
centerX?:
number
\|
string,
<br/>
centerY?:
number
\|
string
<br/>
} |
{
<br/>
x:
1,
<br/>
y:
1,
<br/>
z:
1,
<br/>
centerX:'50%',
<br/>
centerY:'50%'
<br/>
} | 可以分别设置X轴、Y轴、Z轴的缩放比例，默认值为1，同时可以通过centerX和centerY设置缩放的中心点。
|
| transform | Matrix4Transit
| -
| 设置当前组件的变换矩阵。 |
| 名称 | 参数类型 | 描述 |
| --------- | ------------------------------------------------------------------------ | ---------------------------------------- |
| rotate | {
<br/>
x?:
number,
<br/>
y?:
number,
<br/>
z?:
number,
<br/>
angle?:
Angle,
<br/>
centerX?:
number
\|
string,
<br/>
centerY?:
number
\|
string
<br/>
} |
(x,
y,
z)指定一个矢量，表示旋转轴，正角度为顺时针转动，负角度为逆时针转动，默认值为0，同时可以通过centerX和centerY设置旋转的中心点。
<br>
默认值:
<br>
{
<br/>
x:
0,
<br/>
y:
0,
<br/>
z:
0,
<br/>
angle:
0,
<br/>
centerX:
'50%',
<br/>
centerY:
'50%'
<br/>
}
|
| translate | {
<br/>
x?:
number
\|
string,
<br/>
y?:
number
\|
string,
<br/>
z?
:
number
\|
string
<br/>
}
| 可以分别设置X轴、Y轴、Z轴的平移距离，距离的正负控制平移的方向，默认值为0。不支持百分比形式的输入。
<br>
默认值:
<br>
{
<br/>
x:
0,
<br/>
y:
0,
<br/>
z:
0
<br/>
}
|
| scale | {
<br/>
x?:
number,
<br/>
y?:
number,
<br/>
z?:
number,
<br/>
centerX?:
number
\|
string,
<br/>
centerY?:
number
\|
string
<br/>
} |
可以分别设置X轴、Y轴、Z轴的缩放比例，默认值为1，同时可以通过centerX和centerY设置缩放的中心点。
<br>
默认值:
<br>
{
<br/>
x:
1,
<br/>
y:
1,
<br/>
z:
1,
<br/>
centerX:'50%',
<br/>
centerY:'50%'
<br/>
}
|
| transform | Matrix4Transit | 设置当前组件的变换矩阵。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
浏览文件 @
280a29da
...
...
@@ -3,20 +3,14 @@
控制组件是否可见。
> **说明：**
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| visibility |
[
Visibility
](
ts-appendix-enums.md#visibility
)
| Visibility.Visible | 控制当前组件显示或隐藏。注意，即使组件处于隐藏状态，在页面刷新时仍存在重新创建过程，因此当对性能有严格要求时建议使用
[
条件渲染
](
../../ui/ts-rending-control-syntax-if-else.md
)
代替。|
| 名称 | 参数类型 | 描述 |
| ---------- | ---------------------------- | ------------------------------------------ |
| visibility |
[
Visibility
](
ts-appendix-enums.md#visibility
)
| 控制当前组件显示或隐藏。注意，即使组件处于隐藏状态，在页面刷新时仍存在重新创建过程，因此当对性能有严格要求时建议使用
[
条件渲染
](
../../ui/ts-rending-control-syntax-if-else.md
)
代替。
<br>
默认值：Visibility.Visible|
## 示例
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑！
取消
想要评论请
注册
或
登录
