Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
605a6e4d
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
605a6e4d
编写于
8月 08, 2022
作者:
H
HelloCrease
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update docs
Signed-off-by:
N
HelloCrease
<
lian15@huawei.com
>
上级
3a1ffd8a
变更
44
显示空白变更内容
内联
并排
Showing
44 changed file
with
673 addition
and
679 deletion
+673
-679
zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md
...plication-dev/reference/arkui-ts/ts-container-griditem.md
+14
-14
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
...n/application-dev/reference/arkui-ts/ts-container-list.md
+40
-39
zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md
...plication-dev/reference/arkui-ts/ts-container-listitem.md
+16
-16
zh-cn/application-dev/reference/arkui-ts/ts-container-navigator.md
...lication-dev/reference/arkui-ts/ts-container-navigator.md
+20
-19
zh-cn/application-dev/reference/arkui-ts/ts-container-panel.md
.../application-dev/reference/arkui-ts/ts-container-panel.md
+34
-33
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
...pplication-dev/reference/arkui-ts/ts-container-refresh.md
+22
-23
zh-cn/application-dev/reference/arkui-ts/ts-container-row.md
zh-cn/application-dev/reference/arkui-ts/ts-container-row.md
+18
-18
zh-cn/application-dev/reference/arkui-ts/ts-container-rowsplit.md
...plication-dev/reference/arkui-ts/ts-container-rowsplit.md
+8
-8
zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md
...application-dev/reference/arkui-ts/ts-container-scroll.md
+35
-38
zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md
...n-dev/reference/arkui-ts/ts-container-sidebarcontainer.md
+34
-32
zh-cn/application-dev/reference/arkui-ts/ts-container-stack.md
.../application-dev/reference/arkui-ts/ts-container-stack.md
+8
-8
zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md
...application-dev/reference/arkui-ts/ts-container-swiper.md
+4
-4
zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md
...ication-dev/reference/arkui-ts/ts-container-tabcontent.md
+6
-6
zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md
...n/application-dev/reference/arkui-ts/ts-container-tabs.md
+36
-35
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md
...on-dev/reference/arkui-ts/ts-drawing-components-circle.md
+13
-18
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md
...n-dev/reference/arkui-ts/ts-drawing-components-ellipse.md
+11
-15
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md
...tion-dev/reference/arkui-ts/ts-drawing-components-line.md
+15
-20
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md
...tion-dev/reference/arkui-ts/ts-drawing-components-path.md
+6
-7
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polygon.md
...n-dev/reference/arkui-ts/ts-drawing-components-polygon.md
+14
-19
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polyline.md
...-dev/reference/arkui-ts/ts-drawing-components-polyline.md
+12
-16
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-rect.md
...tion-dev/reference/arkui-ts/ts-drawing-components-rect.md
+17
-21
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-shape.md
...ion-dev/reference/arkui-ts/ts-drawing-components-shape.md
+29
-31
zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md
...plication-dev/reference/arkui-ts/ts-explicit-animation.md
+17
-16
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
+29
-27
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md
...ev/reference/arkui-ts/ts-universal-attributes-location.md
+15
-15
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
...on-dev/reference/arkui-ts/ts-universal-attributes-menu.md
+17
-15
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md
...dev/reference/arkui-ts/ts-universal-attributes-opacity.md
+7
-7
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
...dev/reference/arkui-ts/ts-universal-attributes-overlay.md
+4
-3
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md
...nce/arkui-ts/ts-universal-attributes-polymorphic-style.md
+10
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
...n-dev/reference/arkui-ts/ts-universal-attributes-popup.md
+40
-38
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md
...on-dev/reference/arkui-ts/ts-universal-attributes-size.md
+11
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md
.../reference/arkui-ts/ts-universal-attributes-text-style.md
+22
-22
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md
...eference/arkui-ts/ts-universal-attributes-touch-target.md
+12
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
...erence/arkui-ts/ts-universal-attributes-transformation.md
+8
-7
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
.../reference/arkui-ts/ts-universal-attributes-visibility.md
+10
-10
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
...dev/reference/arkui-ts/ts-universal-attributes-z-order.md
+5
-4
zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md
...ence/arkui-ts/ts-universal-component-area-change-event.md
+5
-4
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
...ation-dev/reference/arkui-ts/ts-universal-events-click.md
+3
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
...n-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
+1
-0
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
...ication-dev/reference/arkui-ts/ts-universal-events-key.md
+18
-16
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md
...n-dev/reference/arkui-ts/ts-universal-events-show-hide.md
+6
-5
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
...ation-dev/reference/arkui-ts/ts-universal-events-touch.md
+13
-12
zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md
...cation-dev/reference/arkui-ts/ts-universal-focus-event.md
+7
-6
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
...lication-dev/reference/arkui-ts/ts-universal-mouse-key.md
+1
-0
未找到文件。
zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md
浏览文件 @
605a6e4d
# GridItem
# GridItem
网格容器中单项内容容器。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
网格容器中单项内容容器。
## 权限列表
## 权限列表
无
无
...
@@ -25,7 +25,7 @@ GridItem()
...
@@ -25,7 +25,7 @@ GridItem()
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
--------------- | ------- | ----- | --------------------------------
-------- |
| rowStart | number | - | 用于指定当前元素起始行号。 |
| rowStart | number | - | 用于指定当前元素起始行号。 |
| rowEnd | number | - | 用于指定当前元素终点行号。 |
| rowEnd | number | - | 用于指定当前元素终点行号。 |
| columnStart | number | - | 用于指定当前元素起始列号。 |
| columnStart | number | - | 用于指定当前元素起始列号。 |
...
@@ -37,7 +37,7 @@ GridItem()
...
@@ -37,7 +37,7 @@ GridItem()
## 事件
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| --------
|
-------- |
| --------
-------------------------------- | --------------------------------
-------- |
| onSelect(callback:
(isSelected:
boolean)
=
>
any)
<sup>
8+
</sup>
| GridItem元素被鼠标框选的状态改变时触发回调。
<br/>
isSelected:进入鼠标框选范围即被选中返回true,
移出鼠标框选范围即未被选中返回false。 |
| onSelect(callback:
(isSelected:
boolean)
=
>
any)
<sup>
8+
</sup>
| GridItem元素被鼠标框选的状态改变时触发回调。
<br/>
isSelected:进入鼠标框选范围即被选中返回true,
移出鼠标框选范围即未被选中返回false。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
浏览文件 @
605a6e4d
# List
# List
列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。
## 权限列表
## 权限列表
无
无
...
@@ -21,17 +21,17 @@
...
@@ -21,17 +21,17 @@
List(value:{space?: number, initialIndex?: number})
List(value:{space?: number, initialIndex?: number})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| space | number | 否 | 0 | 列表项间距。 |
| initialIndex | number | 否 | 0 | 设置当前List初次加载时视口起始位置显示的item,即显示第一个item,如设置的序号超过了最后一个item的序号,则设置不生效。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------ | ------ | ---- | ---- | ---------------------------------------- |
| space | number | 否 | 0 | 列表项间距。 |
| initialIndex | number | 否 | 0 | 设置当前List初次加载时视口起始位置显示的item,即显示第一个item,如设置的序号超过了最后一个item的序号,则设置不生效。 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
-------------------- | ---------------------------------------- | ----------------- | --------------------------------
-------- |
| listDirection |
[
Axis
](
ts-appendix-enums.md#axis枚举说明
)
| Vertical | 设置List组件排列方向参照Axis枚举说明。 |
| listDirection |
[
Axis
](
ts-appendix-enums.md#axis枚举说明
)
| Vertical | 设置List组件排列方向参照Axis枚举说明。 |
| divider | {
<br/>
strokeWidth:
Length,
<br/>
color?:Color,
<br/>
startMargin?:
Length,
<br/>
endMargin?:
Length
<br/>
} | - | 用于设置ListItem分割线样式,默认无分割线。
<br/>
strokeWidth:
分割线的线宽。
<br/>
color:
分割线的颜色。
<br/>
startMargin:
分割线距离列表侧边起始端的距离。
<br/>
endMargin:
分割线距离列表侧边结束端的距离。 |
| divider | {
<br/>
strokeWidth:
Length,
<br/>
color?:Color,
<br/>
startMargin?:
Length,
<br/>
endMargin?:
Length
<br/>
} | - | 用于设置ListItem分割线样式,默认无分割线。
<br/>
strokeWidth:
分割线的线宽。
<br/>
color:
分割线的颜色。
<br/>
startMargin:
分割线距离列表侧边起始端的距离。
<br/>
endMargin:
分割线距离列表侧边结束端的距离。 |
| editMode | boolean | false | 声明当前List组件是否处于可编辑模式。 |
| editMode | boolean | false | 声明当前List组件是否处于可编辑模式。 |
...
@@ -40,21 +40,22 @@ List(value:{space?: number, initialIndex?: number})
...
@@ -40,21 +40,22 @@ List(value:{space?: number, initialIndex?: number})
| multiSelectable
<sup>
8+
</sup>
| boolean | false | 是否开启鼠标框选。
<br/>
-
false:关闭框选。
<br/>
-
true:开启框选。 |
| multiSelectable
<sup>
8+
</sup>
| boolean | false | 是否开启鼠标框选。
<br/>
-
false:关闭框选。
<br/>
-
true:开启框选。 |
| restoreId
<sup>
8+
</sup>
| number | - | 组件迁移标识符,标识后的组件在应用迁移时,组件状态会被迁移到被拉起方的同标识组件。
<br/>
列表组件状态,包括起始位置显示的item序号。 |
| restoreId
<sup>
8+
</sup>
| number | - | 组件迁移标识符,标识后的组件在应用迁移时,组件状态会被迁移到被拉起方的同标识组件。
<br/>
列表组件状态,包括起始位置显示的item序号。 |
-
EdgeEffect枚举说明
## EdgeEffect枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Spring | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 |
| None | 滑动到边缘后无效果。 |
| 名称 | 描述 |
| ------ | ---------------------------------------- |
| Spring | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 |
| None | 滑动到边缘后无效果。 |
## 事件
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| --------
|
-------- |
| --------
-------------------------------- | ----------------
-------- |
| onItemDelete(index:
number)
=
>
boolean | 列表项删除时触发。 |
| onItemDelete(index:
number)
=
>
boolean | 列表项删除时触发。 |
| onScrollIndex(firstIndex:
number,
lastIndex:
number)
=
>
void | 当前列表显示的起始位置和终止位置发生变化时触发。 |
| onScrollIndex(firstIndex:
number,
lastIndex:
number)
=
>
void | 当前列表显示的起始位置和终止位置发生变化时触发。 |
> **说明:**
> **说明:**
>
> List使能可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件:
> List使能可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件:
>
>
> - editMode属性设置为true。
> - editMode属性设置为true。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md
浏览文件 @
605a6e4d
# ListItem
# ListItem
用来展示列表具体item,宽度默认充满List组件,必须配合List来使用。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
用来展示列表具体item,宽度默认充满List组件,必须配合List来使用。
## 权限列表
## 权限列表
无
无
...
@@ -25,22 +25,22 @@ ListItem()
...
@@ -25,22 +25,22 @@ ListItem()
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
--------------- | ------- | ----------- | --------------------------------
-------- |
| sticky | Sticky | Sticky.None | 设置ListItem吸顶效果,参见Sticky枚举描述。 |
| sticky | Sticky | Sticky.None | 设置ListItem吸顶效果,参见Sticky枚举描述。 |
| editable | boolean | false | 当前ListItem元素是否可编辑,进入编辑模式后可删除。 |
| editable | boolean | false | 当前ListItem元素是否可编辑,进入编辑模式后可删除。 |
| selectable
<sup>
8+
</sup>
| boolean | true | 当前ListItem元素是否可以被鼠标框选。
<br/>
>
**说明:**
<br/>
>
外层List容器的鼠标框选开启时,ListItem的框选才生效。 |
| selectable
<sup>
8+
</sup>
| boolean | true | 当前ListItem元素是否可以被鼠标框选。
<br/>
>
**说明:**
<br/>
>
外层List容器的鼠标框选开启时,ListItem的框选才生效。 |
-
Sticky枚举说明
## Sticky枚举说明
| 名称 | 描述 |
| -------- | -------- |
| None | 无吸顶效果。 |
| Normal | 当前item吸顶。 |
| 名称 | 描述 |
| ------ | --------- |
| None | 无吸顶效果。 |
| Normal | 当前item吸顶。 |
## 事件
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| --------
|
-------- |
| --------
-------------------------------- | --------------------------------
-------- |
| onSelect(callback:
(isSelected:
boolean)
=
>
any)
<sup>
8+
</sup>
| ListItem元素被鼠标框选的状态改变时触发回调。
<br/>
isSelected:进入鼠标框选范围即被选中返回true,
移出鼠标框选范围即未被选中返回false。 |
| onSelect(callback:
(isSelected:
boolean)
=
>
any)
<sup>
8+
</sup>
| ListItem元素被鼠标框选的状态改变时触发回调。
<br/>
isSelected:进入鼠标框选范围即被选中返回true,
移出鼠标框选范围即未被选中返回false。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-navigator.md
浏览文件 @
605a6e4d
# Navigator
# Navigator
路由容器组件,提供路由跳转能力。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
路由容器组件,提供路由跳转能力。
## 权限列表
## 权限列表
无
无
...
@@ -23,24 +23,25 @@ Navigator(value?: {target: string, type?: NavigationType})
...
@@ -23,24 +23,25 @@ Navigator(value?: {target: string, type?: NavigationType})
创建路由组件。
创建路由组件。
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| target | string | 是 | - | 指定跳转目标页面的路径。 |
| ------ | -------------- | ---- | ------------------- | ------------ |
| type | NavigationType | 否 | NavigationType.Push | 指定路由方式。 |
| target | string | 是 | - | 指定跳转目标页面的路径。 |
| type | NavigationType | 否 | NavigationType.Push | 指定路由方式。 |
-
NavigationType枚举说明
## NavigationType枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Push | 跳转到应用内的指定页面。 |
| Replace | 用应用内的某个页面替换当前页面,并销毁被替换的页面。 |
| Back | 返回上一页面或指定的页面。 |
| 名称 | 描述 |
| ------- | -------------------------- |
| Push | 跳转到应用内的指定页面。 |
| Replace | 用应用内的某个页面替换当前页面,并销毁被替换的页面。 |
| Back | 返回上一页面或指定的页面。 |
## 属性
## 属性
| 名称 | 参数 | 默认值 | 描述 |
| 名称 | 参数 | 默认值 | 描述 |
| ------
-- | -------- | -------- |
-------- |
| ------
| ------- | --------- | --------------------------------
-------- |
| active | boolean | - | 当前路由组件是否处于激活状态,处于激活状态时,会生效相应的路由操作。 |
| active | boolean | - | 当前路由组件是否处于激活状态,处于激活状态时,会生效相应的路由操作。 |
| params | Object | undefined | 跳转时要同时传递到目标页面的数据,可在目标页面使用router.getParams()获得。 |
| params | Object | undefined | 跳转时要同时传递到目标页面的数据,可在目标页面使用router.getParams()获得。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-panel.md
浏览文件 @
605a6e4d
# Panel
# Panel
可滑动面板。提供一种轻量的内容展示的窗口,可方便的在不同尺寸中切换,属于弹出式组件。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
可滑动面板。提供一种轻量的内容展示的窗口,可方便的在不同尺寸中切换,属于弹出式组件。
## 权限列表
## 权限列表
无
无
...
@@ -21,16 +21,16 @@
...
@@ -21,16 +21,16 @@
Panel(value:{show:boolean})
Panel(value:{show:boolean})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| show | boolean | 是 | - | 控制Panel显示或隐藏。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---- | ------- | ---- | ---- | ------------- |
| show | boolean | 是 | - | 控制Panel显示或隐藏。 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
-- | --------- | ------------------ | --------------------------
-------- |
| type | PanelType | PanelType.Foldable | 设置可滑动面板的类型。 |
| type | PanelType | PanelType.Foldable | 设置可滑动面板的类型。 |
| mode | PanelMode | - | 设置可滑动面板的初始状态。 |
| mode | PanelMode | - | 设置可滑动面板的初始状态。 |
| dragBar | boolean | true | 设置是否存在dragbar,true表示存在,false表示不存在。 |
| dragBar | boolean | true | 设置是否存在dragbar,true表示存在,false表示不存在。 |
...
@@ -38,25 +38,26 @@ Panel(value:{show:boolean})
...
@@ -38,25 +38,26 @@ Panel(value:{show:boolean})
| halfHeight | Length | - | 指定PanelMode.Half状态下的高度,默认为屏幕尺寸的一半。 |
| halfHeight | Length | - | 指定PanelMode.Half状态下的高度,默认为屏幕尺寸的一半。 |
| miniHeight | Length | - | 指定PanelMode.Mini状态下的高度。 |
| miniHeight | Length | - | 指定PanelMode.Mini状态下的高度。 |
-
PanelType枚举说明
## PanelType枚举说明
| 名称 | 描述 |
| -------- | -------- |
| 名称 | 描述 |
| Minibar | 提供minibar和类全屏展示切换效果。 |
| --------- | ------------------------------------ |
| Foldable | 内容永久展示类,提供大(类全屏)、中(类半屏)、小三种尺寸展示切换效果。 |
| Minibar | 提供minibar和类全屏展示切换效果。 |
| Temporary | 内容临时展示区,提供大(类全屏)、中(类半屏)两种尺寸展示切换效果。 |
| Foldable | 内容永久展示类,提供大(类全屏)、中(类半屏)、小三种尺寸展示切换效果。 |
| Temporary | 内容临时展示区,提供大(类全屏)、中(类半屏)两种尺寸展示切换效果。 |
-
PanelMode枚举说明
## PanelMode枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Mini | 类型为minibar和foldable时,为最小状态;类型为temporary,则不生效。 |
| Half | 类型为foldable和temporary时,为类半屏状态;类型为minibar,则不生效。 |
| Full | 类全屏状态。 |
| 名称 | 描述 |
| ---- | ---------------------------------------- |
| Mini | 类型为minibar和foldable时,为最小状态;类型为temporary,则不生效。 |
| Half | 类型为foldable和temporary时,为类半屏状态;类型为minibar,则不生效。 |
| Full | 类全屏状态。 |
## 事件
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| --------
|
-------- |
| --------
-------------------------------- | --------------------------------
-------- |
| onChange(callback:
(width:
number,
height:
number,
mode:
PanelMode)
=
>
void) | 当可滑动面板发生状态变化时触发,
返回的height值为内容区高度值,当dragbar属性为true时,panel本身的高度值为dragbar高度加上内容区高度。 |
| onChange(callback:
(width:
number,
height:
number,
mode:
PanelMode)
=
>
void) | 当可滑动面板发生状态变化时触发,
返回的height值为内容区高度值,当dragbar属性为true时,panel本身的高度值为dragbar高度加上内容区高度。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
浏览文件 @
605a6e4d
# Refresh
# Refresh
下拉刷新容器。
> **说明:**
> **说明:**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
下拉刷新容器。
## 权限列表
## 权限列表
无
无
...
@@ -17,34 +18,32 @@
...
@@ -17,34 +18,32 @@
Refresh
\(
value:
\{
refreshing: boolean, offset?: Length, friction?: number | string
\}\)
Refresh
\(
value:
\{
refreshing: boolean, offset?: Length, friction?: number | string
\}\)
-
参数
**参数:**
| 参数 | 参数名 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| refreshing | boolean | 是 | - | 当前组件是否正在刷新。 |
| offset | Length | 否 | 16 | 刷新组件静止时距离父组件顶部的距离。|
| friction | number
\|
string | 否 | 62 | 下拉摩擦系数,取值范围为0到100。
<br/>
-
0表示下拉刷新容器不跟随手势下拉而下拉。
<br/>
-
100表示下拉刷新容器紧紧跟随手势下拉而下拉。
<br/>
-
数值越大,下拉刷新容器跟随手势下拉的反应越灵敏。 |
| 参数 | 参数名 | 必填 | 默认值 | 参数描述 |
| ---------- | -------------------------- | ---- | ---- | ---------------------------------------- |
| refreshing | boolean | 是 | - | 当前组件是否正在刷新。 |
| offset | Length | 否 | 16 | 刷新组件静止时距离父组件顶部的距离。 |
| friction | number
\|
string | 否 | 62 | 下拉摩擦系数,取值范围为0到100。
<br/>
-
0表示下拉刷新容器不跟随手势下拉而下拉。
<br/>
-
100表示下拉刷新容器紧紧跟随手势下拉而下拉。
<br/>
-
数值越大,下拉刷新容器跟随手势下拉的反应越灵敏。 |
## 事件
## 事件
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| ---------------------------------------- | ------------------------------- |
| onStateChange(callback: (state: RefreshStatus) => void)| 当前刷新状态变更时,触发回调。
<br/>
state:刷新状态。 |
| onStateChange(callback: (state: RefreshStatus) => void) | 当前刷新状态变更时,触发回调。
<br/>
state:刷新状态。 |
| onRefreshing(callback: () => void)| 进入刷新状态时触发回调。 |
| onRefreshing(callback: () => void) | 进入刷新状态时触发回调。 |
-
RefreshStatus枚举说明
| 名称 | 描述 |
## RefreshStatus枚举说明
| -------- | -------- |
| Inactive | 默认未下拉状态。 |
| Drag | 下拉中,下拉距离小于刷新距离。 |
| OverDrag | 下拉中,下拉距离超过刷新距离。 |
| Refresh | 下拉结束,回弹至刷新距离,进入刷新状态。 |
| Done | 刷新结束,返回初始状态(顶部)。 |
| 名称 | 描述 |
| -------- | -------------------- |
| Inactive | 默认未下拉状态。 |
| Drag | 下拉中,下拉距离小于刷新距离。 |
| OverDrag | 下拉中,下拉距离超过刷新距离。 |
| Refresh | 下拉结束,回弹至刷新距离,进入刷新状态。 |
| Done | 刷新结束,返回初始状态(顶部)。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-row.md
浏览文件 @
605a6e4d
# Row
# Row
沿水平方向布局容器。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
沿水平方向布局容器。
## 权限列表
## 权限列表
无
无
...
@@ -21,26 +21,26 @@
...
@@ -21,26 +21,26 @@
Row(value:{space?: Length})
Row(value:{space?: Length})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| space | Length | 否 | 0 | 横向布局元素间距。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | --------- |
| space | Length | 否 | 0 | 横向布局元素间距。 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
-------- | --------------------------------- | -------------------- | ---------
-------- |
| alignItems | VerticalAlign | VerticalAlign.Center | 在垂直方向上子组件的对齐格式。 |
| alignItems | VerticalAlign | VerticalAlign.Center | 在垂直方向上子组件的对齐格式。 |
| justifyContent8+ |
[
FlexAlign
](
ts-container-flex.md
)
| FlexAlign.Start | 设置子组件在水平方向上的对齐格式。 |
| justifyContent8+ |
[
FlexAlign
](
ts-container-flex.md
)
| FlexAlign.Start | 设置子组件在水平方向上的对齐格式。 |
-
VerticalAlign枚举说明
## VerticalAlign枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Top | 顶部对齐。 |
| Center | 居中对齐,默认对齐方式。 |
| Bottom | 底部对齐。 |
| 名称 | 描述 |
| ------ | ------------ |
| Top | 顶部对齐。 |
| Center | 居中对齐,默认对齐方式。 |
| Bottom | 底部对齐。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-rowsplit.md
浏览文件 @
605a6e4d
# RowSplit
# RowSplit
将子组件横向布局,并在每个子组件之间插入一根纵向的分割线。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
将子组件横向布局,并在每个子组件之间插入一根纵向的分割线。
## 权限列表
## 权限列表
无
无
...
@@ -25,7 +25,7 @@ RowSplit()
...
@@ -25,7 +25,7 @@ RowSplit()
## 属性
## 属性
| 名称 | 参数类型 | 描述 |
| 名称 | 参数类型 | 描述 |
| --------
| -------- |
-------- |
| --------
-- | ------- | ----------
-------- |
| resizeable | boolean | 分割线是否可拖拽,默认为false。 |
| resizeable | boolean | 分割线是否可拖拽,默认为false。 |
> **说明:**
> **说明:**
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md
浏览文件 @
605a6e4d
# Scroll
# Scroll
可滚动的容器组件,当子组件的布局尺寸超过父组件的视口时,内容可以滚动。
> **说明:**
> **说明:**
>
> 该组件从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
可滚动的容器组件,当子组件的布局尺寸超过父组件的视口时,内容可以滚动。
## 权限列表
## 权限列表
无
无
...
@@ -31,12 +31,13 @@ Scroll(scroller?: Scroller)
...
@@ -31,12 +31,13 @@ Scroll(scroller?: Scroller)
| scrollBarColor | Color | - | 设置滚动条的颜色。 |
| scrollBarColor | Color | - | 设置滚动条的颜色。 |
| scrollBarWidth | Length | - | 设置滚动条的宽度。 |
| scrollBarWidth | Length | - | 设置滚动条的宽度。 |
-
ScrollDirection枚举说明
## ScrollDirection枚举说明
| 名称 | 描述 |
| ---------- | ---------- |
| 名称 | 描述 |
| Horizontal | 仅支持水平方向滚动。 |
| ---------- | ---------- |
| Vertical | 仅支持竖直方向滚动。 |
| Horizontal | 仅支持水平方向滚动。 |
| None | 不可滚动。 |
| Vertical | 仅支持竖直方向滚动。 |
| None | 不可滚动。 |
## 事件
## 事件
...
@@ -65,14 +66,13 @@ scrollTo(value: { xOffset: number | string, yOffset: number | string, animation?
...
@@ -65,14 +66,13 @@ scrollTo(value: { xOffset: number | string, yOffset: number | string, animation?
滑动到指定位置。
滑动到指定位置。
**参数:**
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| --------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| xOffset | Length | 是 | - | 水平滑动偏移。 |
| xOffset | Length | 是 | - | 水平滑动偏移。 |
| yOffset | Length | 是 | - | 竖直滑动偏移。 |
| yOffset | Length | 是 | - | 竖直滑动偏移。 |
| animation | {
<br/>
duration:
number,
<br/>
curve:
[Curve](ts-animatorproperty.md)
\|
<br/>
CubicBezier
\|
<br/>
SpringCurve
<br/>
} | 否 | | 动画配置:
<br/>
-
duration:
滚动时长设置。
<br/>
-
curve:
滚动曲线设置。 |
| animation | {
<br/>
duration:
number,
<br/>
curve:
[Curve](ts-animatorproperty.md)
\|
<br/>
CubicBezier
\|
<br/>
SpringCurve
<br/>
} | 否 | | 动画配置:
<br/>
-
duration:
滚动时长设置。
<br/>
-
curve:
滚动曲线设置。 |
### scrollEdge
### scrollEdge
...
@@ -81,12 +81,11 @@ scrollEdge(value: Edge): void
...
@@ -81,12 +81,11 @@ scrollEdge(value: Edge): void
滚动到容器边缘。
滚动到容器边缘。
**参数:**
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ---- | ---- | ---- | --------- |
| ----- | ---- | ---- | ---- | --------- |
| value | Edge | 是 | - | 滚动到的边缘位置。 |
| value | Edge | 是 | - | 滚动到的边缘位置。 |
### scrollPage
### scrollPage
...
@@ -94,12 +93,12 @@ scrollPage(value: { next: boolean, direction?: Axis }): void
...
@@ -94,12 +93,12 @@ scrollPage(value: { next: boolean, direction?: Axis }): void
滚动到下一页或者上一页。
滚动到下一页或者上一页。
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | ------- | ---- | ---- | ------------------------------ |
| next | boolean | 是 | - | 是否向下翻页。true表示向下翻页,false表示向上翻页。 |
| direction | Axis | 否 | - | 设置滚动方向为水平或竖直方向。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| --------- | ------- | ---- | ---- | ------------------------------ |
| next | boolean | 是 | - | 是否向下翻页。true表示向下翻页,false表示向上翻页。 |
| direction | Axis | 否 | - | 设置滚动方向为水平或竖直方向。 |
### currentOffset
### currentOffset
...
@@ -108,12 +107,11 @@ scroller.currentOffset(): Object
...
@@ -108,12 +107,11 @@ scroller.currentOffset(): Object
返回当前的滚动偏移量。
返回当前的滚动偏移量。
**返回值:**
-
返回值
| 类型 | 描述 |
| 类型 | 描述 |
| ---------------------------------------- | ---------------------------------------- |
| ---------------------------------------- | ---------------------------------------- |
| {
<br/>
xOffset:
number,
<br/>
yOffset:
number
<br/>
} | xOffset:
水平滑动偏移;
<br/>
yOffset:
竖直滑动偏移。 |
| {
<br/>
xOffset:
number,
<br/>
yOffset:
number
<br/>
} | xOffset:
水平滑动偏移;
<br/>
yOffset:
竖直滑动偏移。 |
### scrollToIndex
### scrollToIndex
...
@@ -126,12 +124,11 @@ scroller.scrollToIndex(value: number): void
...
@@ -126,12 +124,11 @@ scroller.scrollToIndex(value: number): void
> **说明:**
> **说明:**
> 仅支持list组件。
> 仅支持list组件。
**参数:**
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | ----------------- |
| ----- | ------ | ---- | ---- | ----------------- |
| value | number | 是 | - | 要滑动到的列表项在列表中的索引值。 |
| value | number | 是 | - | 要滑动到的列表项在列表中的索引值。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md
浏览文件 @
605a6e4d
# SideBarContainer
# SideBarContainer
提供侧边栏可以显示和隐藏的侧边栏容器,通过子组件定义侧边栏和内容区,第一个子组件表示侧边栏,第二个子组件表示内容区。
> **说明:**
> **说明:**
>
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
提供侧边栏可以显示和隐藏的侧边栏容器,通过子组件定义侧边栏和内容区,第一个子组件表示侧边栏,第二个子组件表示内容区。
## 权限列表
## 权限列表
无
无
...
@@ -21,21 +21,23 @@
...
@@ -21,21 +21,23 @@
SideBarContainer( type?: SideBarContainerType )
SideBarContainer( type?: SideBarContainerType )
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| type | SideBarContainerType | 否 | SideBarContainerType.Embed | 设置侧边栏的显示类型。 |
| ---- | -------------------- | ---- | -------------------------- | ----------- |
| type | SideBarContainerType | 否 | SideBarContainerType.Embed | 设置侧边栏的显示类型。 |
## SideBarContainerType枚举说明
-
SideBarContainerType枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| ------- | ---------------------- |
| -------- | -------- |
| Embed | 侧边栏嵌入到组件内,侧边栏和内容区并列显示。 |
| Embed | 侧边栏嵌入到组件内,侧边栏和内容区并列显示。 |
| Overlay | 侧边栏浮在内容区上面。 |
| Overlay | 侧边栏浮在内容区上面。 |
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
--------- | ----------- | ---- | -----
-------- |
| showSideBar | boolean | true | 设置是否显示侧边栏。 |
| showSideBar | boolean | true | 设置是否显示侧边栏。 |
| controlButton | ButtonStyle | - | 设置侧边栏控制按钮的属性。 |
| controlButton | ButtonStyle | - | 设置侧边栏控制按钮的属性。 |
| showControlButton | boolean | true | 设置是否显示控制按钮。 |
| showControlButton | boolean | true | 设置是否显示控制按钮。 |
...
@@ -43,23 +45,23 @@ SideBarContainer( type?: SideBarContainerType )
...
@@ -43,23 +45,23 @@ SideBarContainer( type?: SideBarContainerType )
| minSideBarWidth | number | 200 | 设置侧边栏最小宽度。 |
| minSideBarWidth | number | 200 | 设置侧边栏最小宽度。 |
| maxSideBarWidth | number | 280 | 设置侧边栏最大宽度。 |
| maxSideBarWidth | number | 280 | 设置侧边栏最大宽度。 |
-
ButtonStyle对象说明
## ButtonStyle对象说明
| 名称 | 参数类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| left | number | 否 | 16 | 设置侧边栏控制按钮距离容器左界限的间距。 |
| top | number | 否 | 48 | 设置侧边栏控制按钮距离容器上界限的间距。 |
| width | number | 否 | 32 | 设置侧边栏控制按钮的宽度。 |
| height | number | 否 | 32 | 设置侧边栏控制按钮的高度。 |
| icons | {
<br/>
shown:
string
\|
PixelMap
\|
[
Resource
](
../../ui/ts-types.md
)
,
<br/>
hidden:
string
\|
PixelMap
\|
[
Resource
](
../../ui/ts-types.md
)
,
<br/>
switching?:
string
\|
PixelMap
\|
[
Resource
](
../../ui/ts-types.md
)
<br/>
} | 否 | - | 设置侧边栏控制按钮的图标:
<br/>
</p>
- shown: 设置侧边栏显示时控制按钮的图标。
<br>
- hidden: 设置侧边栏隐藏时控制按钮的图标。
<br>
- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 |
| 名称 | 参数类型 | 必填 | 默认值 | 描述 |
| ------ | ---------------------------------------- | ---- | ---- | ---------------------------------------- |
| left | number | 否 | 16 | 设置侧边栏控制按钮距离容器左界限的间距。 |
| top | number | 否 | 48 | 设置侧边栏控制按钮距离容器上界限的间距。 |
| width | number | 否 | 32 | 设置侧边栏控制按钮的宽度。 |
| height | number | 否 | 32 | 设置侧边栏控制按钮的高度。 |
| icons | {
<br/>
shown:
string
\|
PixelMap
\|
[
Resource
](
../../ui/ts-types.md
)
,
<br/>
hidden:
string
\|
PixelMap
\|
[
Resource
](
../../ui/ts-types.md
)
,
<br/>
switching?:
string
\|
PixelMap
\|
[
Resource
](
../../ui/ts-types.md
)
<br/>
} | 否 | - | 设置侧边栏控制按钮的图标:
<br/>
</p>
- shown: 设置侧边栏显示时控制按钮的图标。
<br>
- hidden: 设置侧边栏隐藏时控制按钮的图标。
<br>
- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 |
## 事件
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| --------
|
-------- |
| --------
-------------------------------- | --------------------------------
-------- |
| onChange(callback: (value: boolen) =
>
void) | 当侧边栏的状态在显示和隐藏之间切换时触发回调。
<p>
value的true表示显示,false表示隐藏。
|
| onChange(callback: (value: boolen) =
>
void) | 当侧边栏的状态在显示和隐藏之间切换时触发回调。
<p>
value的true表示显示,false表示隐藏。
|
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-stack.md
浏览文件 @
605a6e4d
# Stack
# Stack
堆叠容器,子组件按照顺序依次入栈,后一个子组件覆盖前一个子组件。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
堆叠容器,子组件按照顺序依次入栈,后一个子组件覆盖前一个子组件。
## 权限列表
## 权限列表
无
无
...
@@ -21,11 +21,11 @@
...
@@ -21,11 +21,11 @@
Stack(value:{alignContent?: Alignment})
Stack(value:{alignContent?: Alignment})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| alignContent |
[
Alignment
](
ts-appendix-enums.md#alignment枚举说明
)
| 否 | Center | 设置子组件在容器内的对齐方式。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------ | ---------------------------------------- | ---- | ------ | --------------- |
| alignContent |
[
Alignment
](
ts-appendix-enums.md#alignment枚举说明
)
| 否 | Center | 设置子组件在容器内的对齐方式。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md
浏览文件 @
605a6e4d
...
@@ -20,11 +20,11 @@
...
@@ -20,11 +20,11 @@
Swiper(value:{controller?: SwiperController})
Swiper(value:{controller?: SwiperController})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------------------------------------- | ---- | ---- | -------------------- |
| controller |
[
SwiperController
](
#swipercontroller
)
| 否 | null | 给组件绑定一个控制器,用来控制组件翻页。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ---------- | ------------------------------------- | ---- | ---- | -------------------- |
| controller |
[
SwiperController
](
#swipercontroller
)
| 否 | null | 给组件绑定一个控制器,用来控制组件翻页。 |
## 属性
## 属性
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md
浏览文件 @
605a6e4d
# TabContent
# TabContent
仅在Tabs中使用,对应一个切换页签的内容视图。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
仅在Tabs中使用,对应一个切换页签的内容视图。
## 权限列表
## 权限列表
无
无
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md
浏览文件 @
605a6e4d
# Tabs
# Tabs
一种可以通过页签进行内容视图切换的容器组件,每个页签对应一个内容视图。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
一种可以通过页签进行内容视图切换的容器组件,每个页签对应一个内容视图。
## 权限列表
## 权限列表
无
无
...
@@ -21,26 +21,27 @@
...
@@ -21,26 +21,27 @@
Tabs(value: {barPosition?: BarPosition, index?: number, controller?:
[
TabsController
](
#tabscontroller
)
})
Tabs(value: {barPosition?: BarPosition, index?: number, controller?:
[
TabsController
](
#tabscontroller
)
})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| barPosition | BarPosition | 否 | BarPosition.Start | 指定页签位置来创建Tabs容器组件。 |
| ----------- | --------------------------------- | ---- | ----------------- | ------------------ |
| index | number | 否 | 0 | 指定初次初始页签索引。 |
| barPosition | BarPosition | 否 | BarPosition.Start | 指定页签位置来创建Tabs容器组件。 |
| controller |
[
TabsController
](
#tabscontroller
)
| 否 | - | 设置Tabs控制器。 |
| index | number | 否 | 0 | 指定初次初始页签索引。 |
| controller |
[
TabsController
](
#tabscontroller
)
| 否 | - | 设置Tabs控制器。 |
-
BarPosition枚举说明
## BarPosition枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Start | vertical属性方法设置为true时,页签位于容器左侧;vertical属性方法设置为false时,页签位于容器顶部。 |
| End | vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。 |
| 名称 | 描述 |
| ----- | ---------------------------------------- |
| Start | vertical属性方法设置为true时,页签位于容器左侧;vertical属性方法设置为false时,页签位于容器顶部。 |
| End | vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。 |
## 属性
## 属性
不支持触摸热区设置。
不支持触摸热区设置。
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
--------- | ------- | --------------------------- | -----------------------
-------- |
| vertical | boolean | 是否为纵向Tab,默认为false。 | 是否为纵向Tab,默认为false。 |
| vertical | boolean | 是否为纵向Tab,默认为false。 | 是否为纵向Tab,默认为false。 |
| scrollable | boolean | 是否可以通过左右滑动进行页面切换,默认为true。 | 是否可以通过左右滑动进行页面切换,默认为true。 |
| scrollable | boolean | 是否可以通过左右滑动进行页面切换,默认为true。 | 是否可以通过左右滑动进行页面切换,默认为true。 |
| barMode | BarMode | TabBar布局模式。 | TabBar布局模式。 |
| barMode | BarMode | TabBar布局模式。 | TabBar布局模式。 |
...
@@ -48,17 +49,17 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsContro
...
@@ -48,17 +49,17 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsContro
| barHeight | number | TabBar的高度值,不设置时使用系统主题中的默认值。 | TabBar的高度值,不设置时使用系统主题中的默认值
**。**
|
| barHeight | number | TabBar的高度值,不设置时使用系统主题中的默认值。 | TabBar的高度值,不设置时使用系统主题中的默认值
**。**
|
| animationDuration | number | 200 | TabContent滑动动画时长。 |
| animationDuration | number | 200 | TabContent滑动动画时长。 |
-
BarMode枚举说明
## BarMode枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Scrollable | TabBar使用实际布局宽度,
超过总长度后可滑动。 |
| Fixed | 所有TabBar平均分配宽度。 |
| 名称 | 描述 |
| ---------- | ------------------------------- |
| Scrollable | TabBar使用实际布局宽度,
超过总长度后可滑动。 |
| Fixed | 所有TabBar平均分配宽度。 |
## 事件
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| --------
|
-------- |
| --------
-------------------------------- | ------
-------- |
| onChange(callback:
(index:
number)
=
>
void) | Tab页签切换后触发的事件。 |
| onChange(callback:
(index:
number)
=
>
void) | Tab页签切换后触发的事件。 |
## TabsController
## TabsController
...
@@ -78,11 +79,11 @@ changeIndex(value: number): void
...
@@ -78,11 +79,11 @@ changeIndex(value: number): void
控制Tabs切换到指定页签。
控制Tabs切换到指定页签。
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | - | 页签在Tabs里的索引值,索引值从0开始。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ----- | ------ | ---- | ---- | --------------------- |
| value | number | 是 | - | 页签在Tabs里的索引值,索引值从0开始。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md
浏览文件 @
605a6e4d
# Circle
# Circle
圆形绘制组件。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
圆形绘制组件。
## 权限列表
## 权限列表
无
无
...
@@ -21,22 +21,17 @@
...
@@ -21,22 +21,17 @@
Circle(options?: {width: Length, height: Length})
Circle(options?: {width: Length, height: Length})
-
参数
**options参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| options | Object | 否 | - | 见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| ------
-- | -------- | -------- | -------- |
-------- |
| ------
| ------ | ---- | ---- | -
-------- |
| width | Length | 0 | 否 | 圆所在矩形的宽度。 |
| width | Length | 0 | 否 | 圆所在矩形的宽度。 |
| height | Length | 0 | 否 | 圆所在矩形的高度。 |
| height | Length | 0 | 否 | 圆所在矩形的高度。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md
浏览文件 @
605a6e4d
# Ellipse
# Ellipse
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -21,22 +22,17 @@
...
@@ -21,22 +22,17 @@
ellipse(options?: {width: Length, height: Length})
ellipse(options?: {width: Length, height: Length})
-
参数
**options参数说明:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| options | Object | 否 | - | 见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| ------
-- | -------- | -------- | -------- |
-------- |
| ------
| ------ | ---- | ---- | --
-------- |
| width | Length | 0 | 否 | 椭圆所在矩形的宽度。 |
| width | Length | 0 | 否 | 椭圆所在矩形的宽度。 |
| height | Length | 0 | 否 | 椭圆所在矩形的高度。 |
| height | Length | 0 | 否 | 椭圆所在矩形的高度。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md
浏览文件 @
605a6e4d
# Line
# Line
直线绘制组件。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
直线绘制组件。
## 权限列表
## 权限列表
无
无
...
@@ -21,22 +21,17 @@
...
@@ -21,22 +21,17 @@
Line(options?: {width: Length, height: Length})
Line(options?: {width: Length, height: Length})
-
参数
**options参数说明:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| options | Object | 否 | - | 见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| --------
| -------- | -------- | -------- |
-------- |
| --------
-- | ------ | ----------- | ---- | -----
-------- |
| width | Length | 0 | 否 | 直线所在矩形的宽度。 |
| width | Length | 0 | 否 | 直线所在矩形的宽度。 |
| height | Length | 0 | 否 | 直线所在矩形的高度。 |
| height | Length | 0 | 否 | 直线所在矩形的高度。 |
| startPoint | Point | [0,
0] | 是 | 直线起点坐标(相对坐标)。 |
| startPoint | Point | [0,
0] | 是 | 直线起点坐标(相对坐标)。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md
浏览文件 @
605a6e4d
...
@@ -16,14 +16,13 @@
...
@@ -16,14 +16,13 @@
Path(value?: { width?: number | string, height?: number | string, commands?: string })
Path(value?: { width?: number | string, height?: number | string, commands?: string })
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | ---------------- | ---- | ---- | ----------- |
| width | number
\|
string | 否 | 0 | 路径所在矩形的宽度。 |
| height | number
\|
string | 否 | 0 | 路径所在矩形的高度。 |
| commands | string | 否 | '' | 路径绘制的命令字符串。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | ---------------- | ---- | ---- | ----------- |
| width | number
\|
string | 否 | 0 | 路径所在矩形的宽度。 |
| height | number
\|
string | 否 | 0 | 路径所在矩形的高度。 |
| commands | string | 否 | '' | 路径绘制的命令字符串。 |
## 属性
## 属性
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polygon.md
浏览文件 @
605a6e4d
# Polygon
# Polygon
多边形绘制组件。
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
多边形绘制组件。
## 权限列表
## 权限列表
无
无
...
@@ -21,22 +21,17 @@
...
@@ -21,22 +21,17 @@
Polygon(value:{options?: {width: Length, height: Length}})
Polygon(value:{options?: {width: Length, height: Length}})
-
参数
**options参数说明:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| options | Object | 否 | - | 见见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| ------
-- | -------- | -------- | -------- |
-------- |
| ------
| ------------------ | ---- | ---- | ---
-------- |
| width | Length | 0 | 否 | 多边形所在矩形的宽度。 |
| width | Length | 0 | 否 | 多边形所在矩形的宽度。 |
| height | Length | 0 | 否 | 多边形所在矩形的高度。 |
| height | Length | 0 | 否 | 多边形所在矩形的高度。 |
| points | Array
<
Point
>
| - | 是 | 多边形的顶点坐标列表。 |
| points | Array
<
Point
>
| - | 是 | 多边形的顶点坐标列表。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polyline.md
浏览文件 @
605a6e4d
# Polyline
# Polyline
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -21,22 +22,17 @@
...
@@ -21,22 +22,17 @@
Polyline(options?: {width: Length, height: Length})
Polyline(options?: {width: Length, height: Length})
-
参数
**options参数说明:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| options | Object | 否 | - | 见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ------ | ---- | ---- | ---- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| ------
-- | -------- | -------- | -------- |
-------- |
| ------
| ------------------ | ---- | ---- | --
-------- |
| width | Length | 0 | 否 | 折线所在矩形的宽度。 |
| width | Length | 0 | 否 | 折线所在矩形的宽度。 |
| height | Length | 0 | 否 | 折线所在矩形的高度。 |
| height | Length | 0 | 否 | 折线所在矩形的高度。 |
| points | Array
<
Point
>
| - | 是 | 折线经过坐标点列表。 |
| points | Array
<
Point
>
| - | 是 | 折线经过坐标点列表。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-rect.md
浏览文件 @
605a6e4d
# Rect
# Rect
> **说明:**
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -21,25 +22,20 @@
...
@@ -21,25 +22,20 @@
Rect(value:{options?: {width: Length,height: Length,radius?: Length | Array
<
Length
>
} | {width: Length,height: Length,radiusWidth?: Length,radiusHeight?: Length}})
Rect(value:{options?: {width: Length,height: Length,radius?: Length | Array
<
Length
>
} | {width: Length,height: Length,radiusWidth?: Length,radiusHeight?: Length}})
-
参数
**options参数说明:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| options | Object | 否 | - | 见options参数说明。 |
-
options参数说明
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| radius | Length
\|
Array
<
Length
>
| 否 | 0 | 圆角半径,支持分别设置四个角的圆角度数。 |
| radiusWidth | Length | 否 | 0 | 圆角宽度。 |
| radiusHeight | Length | 否 | 0 | 圆角高度。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------------ | --------------------------------------- | ---- | ---- | -------------------- |
| width | Length | 是 | - | 宽度。 |
| height | Length | 是 | - | 高度。 |
| radius | Length
\|
Array
<
Length
>
| 否 | 0 | 圆角半径,支持分别设置四个角的圆角度数。 |
| radiusWidth | Length | 否 | 0 | 圆角宽度。 |
| radiusHeight | Length | 否 | 0 | 圆角高度。 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| --------
| -------- | -------- | -------- |
-------- |
| --------
---- | --------------------------------------- | ---- | ---- | --------
-------- |
| width | Length | 0 | 否 | 宽度。 |
| width | Length | 0 | 否 | 宽度。 |
| height | Length | 0 | 否 | 高度。 |
| height | Length | 0 | 否 | 高度。 |
| radiusWidth | Length | 0 | 否 | 圆角的宽度,仅设置宽时宽高一致。 |
| radiusWidth | Length | 0 | 否 | 圆角的宽度,仅设置宽时宽高一致。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-shape.md
浏览文件 @
605a6e4d
# Shape
# Shape
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
绘制组件的父组件,父组件中会描述所有绘制组件均支持的通用属性。
绘制组件的父组件,父组件中会描述所有绘制组件均支持的通用属性。
1、绘制组件使用Shape作为父组件,实现类似SVG的效果。
1、绘制组件使用Shape作为父组件,实现类似SVG的效果。
2、绘制组件单独使用,用于在页面上绘制指定的图形。
2、绘制组件单独使用,用于在页面上绘制指定的图形。
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
## 权限列表
...
@@ -27,16 +25,16 @@
...
@@ -27,16 +25,16 @@
Shape(value:{target?: PixelMap})
Shape(value:{target?: PixelMap})
-
参数
**参数:**
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| target | PixelMap | 否 | null | 绘制目标,可将图形绘制在指定的PixelMap对象中,若未设置,则在当前绘制目标中进行绘制。 |
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | -------- | ---- | ---- | ---------------------------------------- |
| target | PixelMap | 否 | null | 绘制目标,可将图形绘制在指定的PixelMap对象中,若未设置,则在当前绘制目标中进行绘制。 |
## 属性
## 属性
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 |
| --------
| -------- | -------- | -------- |
-------- |
| --------
-------- | ---------------------------------------- | ------------------- | ---- | ----
-------- |
| viewPort | {
<br/>
x:
Length,
<br/>
y:
Length,
<br/>
width:
Length,
<br/>
height:
Length
<br/>
} | - | 是 | 形状的视口。 |
| viewPort | {
<br/>
x:
Length,
<br/>
y:
Length,
<br/>
width:
Length,
<br/>
height:
Length
<br/>
} | - | 是 | 形状的视口。 |
| fill | Color | Black | 否 | 填充颜色。 |
| fill | Color | Black | 否 | 填充颜色。 |
| stroke | Color | - | 否 | 边框颜色。 |
| stroke | Color | - | 否 | 边框颜色。 |
...
@@ -49,13 +47,13 @@ Shape(value:{target?: PixelMap})
...
@@ -49,13 +47,13 @@ Shape(value:{target?: PixelMap})
| strokeWidth | Length | 1 | 否 | 设置边框的宽度。 |
| strokeWidth | Length | 1 | 否 | 设置边框的宽度。 |
| antiAlias | boolean | true | 否 | 是否开启抗锯齿。 |
| antiAlias | boolean | true | 否 | 是否开启抗锯齿。 |
-
LineJoinStyle枚举说明
## LineJoinStyle枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Bevel | 使用斜角连接路径段。 |
| Miter | 使用尖角连接路径段。 |
| Round | 使用圆角连接路径段。 |
| 名称 | 描述 |
| ----- | ---------- |
| Bevel | 使用斜角连接路径段。 |
| Miter | 使用尖角连接路径段。 |
| Round | 使用圆角连接路径段。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md
浏览文件 @
605a6e4d
# 显式动画
# 显式动画
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
| 接口名称 | 功能描述 |
| 接口名称 | 功能描述 |
| ----------------------------------------
-------------------- | --------------------
---------------------------------------- |
| ----------------------------------------
|
---------------------------------------- |
| animateTo(value:
[AnimationOptions](#animationoptions对象说明),
event:
()=
>
void)
:
void | 提供全局animateTo显式动画接口来指定由于闭包代码导致的状态变化插入过渡动效。
<br/>
event指定显示动效的闭包函数,在闭包函数中导致的状态变化系统会自动插入过渡动画。 |
| animateTo(value:
[AnimationOptions](#animationoptions对象说明),
event:
()=
>
void)
:
void | 提供全局animateTo显式动画接口来指定由于闭包代码导致的状态变化插入过渡动效。
<br/>
event指定显示动效的闭包函数,在闭包函数中导致的状态变化系统会自动插入过渡动画。 |
## AnimationOptions对象说明
## AnimationOptions对象说明
-
属性
### 属性
| 属性名称 | 属性类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| duration | number | 1000 | 动画持续时间,单位为毫秒。 |
| tempo | number | 1.0 | 动画的播放速度,值越大动画播放越快,值越小播放越慢,为0时无动画效果。 |
| curve | Curve
\|
Curves | Linear | 动画曲线。 |
| delay | number | 0 | 单位为ms(毫秒),默认不延时播放。 |
| iterations | number | 1 | 默认播放一次,设置为-1时表示无限次播放。 |
| playMode | PlayMode | Normal | 设置动画播放模式,默认播放完成后重头开始播放。 |
| 属性名称 | 属性类型 | 默认值 | 描述 |
| ---------- | ------------------------- | ------ | ----------------------------------- |
| duration | number | 1000 | 动画持续时间,单位为毫秒。 |
| tempo | number | 1.0 | 动画的播放速度,值越大动画播放越快,值越小播放越慢,为0时无动画效果。 |
| curve | Curve
\|
Curves | Linear | 动画曲线。 |
| delay | number | 0 | 单位为ms(毫秒),默认不延时播放。 |
| iterations | number | 1 | 默认播放一次,设置为-1时表示无限次播放。 |
| playMode | PlayMode | Normal | 设置动画播放模式,默认播放完成后重头开始播放。 |
-
接口
### 接口
| 名称 | 功能描述 |
| -------- | -------- |
| onFinish()
=
>
void | 动效播放完成回调。 |
| 名称 | 功能描述 |
| ------------------------------- | --------- |
| onFinish()
=
>
void | 动效播放完成回调。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md
浏览文件 @
605a6e4d
# 菜单
# 菜单
> **说明:**
> **说明:**
>
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## ContextMenu.close
## ContextMenu.close
...
@@ -9,11 +10,12 @@ close(): void
...
@@ -9,11 +10,12 @@ close(): void
可以通过该方法在页面范围内关闭通过
[
bindContextMenu
](
./ts-universal-attributes-menu.md#属性
)
给组件绑定的菜单。
可以通过该方法在页面范围内关闭通过
[
bindContextMenu
](
./ts-universal-attributes-menu.md#属性
)
给组件绑定的菜单。
-
示例
**示例:**
```
@Entry
```
@Component
@Entry
struct Index {
@Component
struct Index {
@Builder MenuBuilder(){
@Builder MenuBuilder(){
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
Text('close')
Text('close')
...
@@ -35,5 +37,5 @@ close(): void
...
@@ -35,5 +37,5 @@ close(): void
.width('100%')
.width('100%')
.height('100%')
.height('100%')
}
}
}
}
```
```
\ No newline at end of file
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md
浏览文件 @
605a6e4d
# 位置设置
# 位置设置
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,21 +14,20 @@
...
@@ -13,21 +14,20 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
-- | ---------------------------------------- | ------------------------------------ | --------------------------------
-------- |
| align |
[
Alignment
](
ts-appendix-enums.md#alignment枚举说明
)
| Center | 设置元素内容的对齐方式,只有当设置的width和height大小超过元素本身内容大小时生效。 |
| align |
[
Alignment
](
ts-appendix-enums.md#alignment枚举说明
)
| Center | 设置元素内容的对齐方式,只有当设置的width和height大小超过元素本身内容大小时生效。 |
| direction | Direction | Auto | 设置元素水平方向的布局,可选值参照Direction枚举说明。 |
| direction | Direction | Auto | 设置元素水平方向的布局,可选值参照Direction枚举说明。 |
| position | {
<br/>
x:
Length,
<br/>
y:
Length
<br/>
} | - | 使用绝对定位,设置元素锚点相对于父容器顶部起点偏移位置。在布局容器中,设置该属性不影响父容器布局,仅在绘制时进行位置调整。 |
| position | {
<br/>
x:
Length,
<br/>
y:
Length
<br/>
} | - | 使用绝对定位,设置元素锚点相对于父容器顶部起点偏移位置。在布局容器中,设置该属性不影响父容器布局,仅在绘制时进行位置调整。 |
| markAnchor | {
<br/>
x:
Length,
<br/>
y:
Length
<br/>
} | {
<br/>
x:
0,
<br/>
y:
0
<br/>
} | 设置元素在位置定位时的锚点,以元素顶部起点作为基准点进行偏移。 |
| markAnchor | {
<br/>
x:
Length,
<br/>
y:
Length
<br/>
} | {
<br/>
x:
0,
<br/>
y:
0
<br/>
} | 设置元素在位置定位时的锚点,以元素顶部起点作为基准点进行偏移。 |
| offset | {
<br/>
x:
Length,
<br/>
y:
Length
<br/>
} | {
<br/>
x:
0,
<br/>
y:
0
<br/>
} | 相对布局完成位置坐标偏移量,设置该属性,不影响父容器布局,仅在绘制时进行位置调整。 |
| offset | {
<br/>
x:
Length,
<br/>
y:
Length
<br/>
} | {
<br/>
x:
0,
<br/>
y:
0
<br/>
} | 相对布局完成位置坐标偏移量,设置该属性,不影响父容器布局,仅在绘制时进行位置调整。 |
## Direction枚举说明
-
Direction枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| ---- | ----------- |
| -------- | -------- |
| Ltr | 元素从左到右布局。 |
| Ltr | 元素从左到右布局。 |
| Rtl | 元素从右到左布局。 |
| Rtl | 元素从右到左布局。 |
| Auto | 使用系统默认布局方向。 |
| Auto | 使用系统默认布局方向。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md
浏览文件 @
605a6e4d
# Menu控制
# Menu控制
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,22 +14,23 @@
...
@@ -13,22 +14,23 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
-------------------- | ---------------------------------------- | ---- | --------------------------
-------- |
| bindMenu | Array
<MenuItem
&
gt
;&
nbsp
;\|&
nbsp
;[
CustomBuilder
](../../
ui
/
ts-types.md
)<
sup
>
8+
</sup>
| - | 给组件绑定菜单,点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 |
| bindMenu | Array
<MenuItem
&
gt
;&
nbsp
;\|&
nbsp
;[
CustomBuilder
](../../
ui
/
ts-types.md
)<
sup
>
8+
</sup>
| - | 给组件绑定菜单,点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 |
| bindContextMenu
<sup>
8+
</sup>
| content:
[CustomBuilder](../../ui/ts-types.md)
<br>
responseType:
ResponseType | - | 给组件绑定菜单,触发方式为长按或者右键点击,弹出菜单项需要自定义。 |
| bindContextMenu
<sup>
8+
</sup>
| content:
[CustomBuilder](../../ui/ts-types.md)
<br>
responseType:
ResponseType | - | 给组件绑定菜单,触发方式为长按或者右键点击,弹出菜单项需要自定义。 |
## MenuItem
-
MenuItem
| 名称 | 类型 | 描述 |
| 名称 | 类型 | 描述 |
| ------ | ----------------------- | ----------- |
| -------- | -------- | -------- |
| value | string | 菜单项文本。 |
| value | string | 菜单项文本。 |
| action | ()
=
>
void | 点击菜单项的事件回调。 |
| action | ()
=
>
void | 点击菜单项的事件回调。 |
-
ResponseType
<sup>
8+
</sup>
## ResponseType<sup>8+</sup>
| 参数值 | 描述 |
| -------- | -------- |
| 参数值 | 描述 |
| LongPress | 通过长按触发菜单弹出。 |
| ---------- | ------------- |
| RightClick | 通过鼠标右键触发菜单弹出。 |
| LongPress | 通过长按触发菜单弹出。 |
| RightClick | 通过鼠标右键触发菜单弹出。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md
浏览文件 @
605a6e4d
# 透明度设置
# 透明度设置
设置组件的透明度。
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
设置组件的透明度。
## 权限列表
## 权限列表
无
无
...
@@ -16,7 +16,7 @@
...
@@ -16,7 +16,7 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------
- | -------- | -------- |
-------- |
| -------
| ------ | ---- | --------------------------
-------- |
| opacity | number | 1 | 元素的不透明度,取值范围为0到1,1表示为不透明,0表示为完全透明。 |
| opacity | number | 1 | 元素的不透明度,取值范围为0到1,1表示为不透明,0表示为完全透明。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md
浏览文件 @
605a6e4d
# 浮层
# 浮层
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,7 +14,7 @@
...
@@ -13,7 +14,7 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------
- | -------- | -------- |
-------- |
| -------
| ---------------------------------------- | ---------------------------------------- | ----------------
-------- |
| overlay | title:
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 | title:
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/>
} | 在当前组件上,增加遮罩文本,布局与当前组件相同。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md
浏览文件 @
605a6e4d
...
@@ -15,16 +15,16 @@
...
@@ -15,16 +15,16 @@
## 属性
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
--- | ----------- | ---- | ----
-------- |
| stateStyles | StateStyles | - | 设置组件不同状态的样式。 |
| stateStyles | StateStyles | - | 设置组件不同状态的样式。 |
-
StateStyles接口说明
## StateStyles接口说明
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| normal | ()=
>
void | 否 | - | 组件无状态时的样式。 |
| pressed | ()=
>
void | 否 | - | 组件按下状态的样式。 |
| disabled | ()=
>
void | 否 | - | 组件禁用状态的样式。 |
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| -------- | ----------- | ---- | ---- | ---------- |
| normal | ()=
>
void | 否 | - | 组件无状态时的样式。 |
| pressed | ()=
>
void | 否 | - | 组件按下状态的样式。 |
| disabled | ()=
>
void | 否 | - | 组件禁用状态的样式。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md
浏览文件 @
605a6e4d
# Popup控制
# Popup控制
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,42 +14,43 @@
...
@@ -13,42 +14,43 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
- | ---------------------------------------- | ---- | --------------------------------
-------- |
| bindPopup | show:
boolean,
<br/>
popup:
PopupOptions\|
CustomPopupOptions | - | 给组件绑定Popup,点击弹出弹窗。
<br/>
show:
创建页面弹窗提示是否默认显示,默认值为false。
<br/>
popup:
配置当前弹窗提示的参数。 |
| bindPopup | show:
boolean,
<br/>
popup:
PopupOptions\|
CustomPopupOptions | - | 给组件绑定Popup,点击弹出弹窗。
<br/>
show:
创建页面弹窗提示是否默认显示,默认值为false。
<br/>
popup:
配置当前弹窗提示的参数。 |
## PopupOptions类型接口说明
-
PopupOptions类型接口说明
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| --------------- | ---------------------------------------- | ---- | ----- | ---------------------------------------- |
| message | string | 是 | - | 弹窗信息内容。 |
| message | string | 是 | - | 弹窗信息内容。 |
| placementOnTop | boolean | 否 | false | 是否在组件上方显示,默认值为false。 |
| placementOnTop | boolean | 否 | false | 是否在组件上方显示,默认值为false。 |
| primaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第一个按钮。
<br/>
value:
弹窗里主按钮的文本。
<br/>
action:
点击主按钮的回调函数。 |
| primaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第一个按钮。
<br/>
value:
弹窗里主按钮的文本。
<br/>
action:
点击主按钮的回调函数。 |
| secondaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第二个按钮。
<br/>
value:
弹窗里辅助按钮的文本。
<br/>
action:
点击辅助按钮的回调函数。 |
| secondaryButton | {
<br/>
value:
string,
<br/>
action:
()
=
>
void
<br/>
} | 否 | - | 第二个按钮。
<br/>
value:
弹窗里辅助按钮的文本。
<br/>
action:
点击辅助按钮的回调函数。 |
| onStateChange | (isVisible:
boolean)
=
>
void | 否 | - | 弹窗状态变化事件回调,参数isVisible为弹窗当前的显示状态。 |
| onStateChange | (isVisible:
boolean)
=
>
void | 否 | - | 弹窗状态变化事件回调,参数isVisible为弹窗当前的显示状态。 |
-
CustomPopupOptions
<sup>
8+
</sup>
类型接口说明
## CustomPopupOptions<sup>8+</sup>类型接口说明
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| builder | ()
=
>
any | 是 | - | 提示气泡内容的构造器。 |
| ------------- | ---------------------------------------- | ---- | ---------------- | ------------------------------ |
| placement | Placement | 否 | Placement.Bottom | 气泡组件优先显示的位置,当前位置显示不下时,会自动调整位置。 |
| builder | ()
=
>
any | 是 | - | 提示气泡内容的构造器。 |
| maskColor |
[
Color
](
../../ui/ts-types.md#颜色类型
)
| 否 | - | 提示气泡遮障层的颜色。 |
| placement | Placement | 否 | Placement.Bottom | 气泡组件优先显示的位置,当前位置显示不下时,会自动调整位置。 |
| popupColor |
[
Color
](
../../ui/ts-types.md#颜色类型
)
| 否 | - | 提示气泡的颜色。 |
| maskColor |
[
Color
](
../../ui/ts-types.md#颜色类型
)
| 否 | - | 提示气泡遮障层的颜色。 |
| enableArrow | boolean | 否 | true | 是否显示箭头,只有上、下方向的气泡会显示箭头。 |
| popupColor |
[
Color
](
../../ui/ts-types.md#颜色类型
)
| 否 | - | 提示气泡的颜色。 |
| autoCancel | boolean | 否 | true | 页面有操作时,是否自动关闭气泡 |
| enableArrow | boolean | 否 | true | 是否显示箭头,只有上、下方向的气泡会显示箭头。 |
| onStateChange | (isVisible:
boolean)
=
>
void | 否 | - | 弹窗状态变化事件回调,参数为弹窗当前的显示状态。 |
| autoCancel | boolean | 否 | true | 页面有操作时,是否自动关闭气泡 |
| onStateChange | (isVisible:
boolean)
=
>
void | 否 | - | 弹窗状态变化事件回调,参数为弹窗当前的显示状态。 |
-
Placement
<sup>
8+
</sup>
枚举说明
| 名称 | 描述 |
## Placement<sup>8+</sup>枚举说明
| -------- | -------- |
| Left | 气泡提示位于组件左侧。 |
| 名称 | 描述 |
| Right | 气泡提示位于组件右侧。 |
| ----------- | ------------ |
| Top | 气泡提示位于组件上侧。 |
| Left | 气泡提示位于组件左侧。 |
| Bottom | 气泡提示位于组件下侧。 |
| Right | 气泡提示位于组件右侧。 |
| TopLeft | 气泡提示位于组件左上角。 |
| Top | 气泡提示位于组件上侧。 |
| TopRight | 气泡提示位于组件右上角。 |
| Bottom | 气泡提示位于组件下侧。 |
| BottomLeft | 气泡提示位于组件左下角。 |
| TopLeft | 气泡提示位于组件左上角。 |
| BottomRight | 气泡提示位于组件右下角。 |
| TopRight | 气泡提示位于组件右上角。 |
| BottomLeft | 气泡提示位于组件左下角。 |
| BottomRight | 气泡提示位于组件右下角。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md
浏览文件 @
605a6e4d
# 尺寸设置
# 尺寸设置
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,7 +14,7 @@
...
@@ -13,7 +14,7 @@
| 名称 | 参数说明 | 默认值 | 描述 |
| 名称 | 参数说明 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
------ | ---------------------------------------- | ---------------------------------------- | --------------------------------
-------- |
| width | Length | - | 设置组件自身的宽度,缺省时使用元素自身内容需要的宽度。 |
| width | Length | - | 设置组件自身的宽度,缺省时使用元素自身内容需要的宽度。 |
| height | Length | - | 设置组件自身的高度,缺省时使用元素自身内容需要的高度。 |
| height | Length | - | 设置组件自身的高度,缺省时使用元素自身内容需要的高度。 |
| size | {
<br/>
width?:
Length,
<br/>
height?:
Length
<br/>
} | - | 设置高宽尺寸。 |
| size | {
<br/>
width?:
Length,
<br/>
height?:
Length
<br/>
} | - | 设置高宽尺寸。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md
浏览文件 @
605a6e4d
# 文本样式设置
# 文本样式设置
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -16,31 +17,30 @@
...
@@ -16,31 +17,30 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
-- | ------------------------ | --------------------------- | --------------------------------
-------- |
| fontColor | Color | - | 设置文本颜色。 |
| fontColor | Color | - | 设置文本颜色。 |
| fontSize | Length | - | 设置文本尺寸,Length为number类型时,使用fp单位。 |
| fontSize | Length | - | 设置文本尺寸,Length为number类型时,使用fp单位。 |
| fontStyle | FontStyle | FontStyle.Normal | 设置文本的字体样式。 |
| fontStyle | FontStyle | FontStyle.Normal | 设置文本的字体样式。 |
| fontWeight | number
\|
FontWeight | FontWeight.FontWeightNormal | 设置文本的字体粗细,number类型取值[100,
900],取值间隔为100,默认为400,取值越大,字体越粗。
<br/>
提供常用枚举值,参考:FontWeight枚举说明。 |
| fontWeight | number
\|
FontWeight | FontWeight.FontWeightNormal | 设置文本的字体粗细,number类型取值[100,
900],取值间隔为100,默认为400,取值越大,字体越粗。
<br/>
提供常用枚举值,参考:FontWeight枚举说明。 |
| fontFamily | string | - | 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial,
sans-serif'。 |
| fontFamily | string | - | 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial,
sans-serif'。 |
## FontStyle枚举说明
-
FontStyle枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| ------ | -------- |
| -------- | -------- |
| Normal | 标准的字体样式。 |
| Normal | 标准的字体样式。 |
| Italic | 斜体的字体样式。 |
| Italic | 斜体的字体样式。 |
## FontWeight枚举说明
-
FontWeight枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| ------- | ------- |
| -------- | -------- |
| Lighter | 字体较细。 |
| Lighter | 字体较细。 |
| Normal | 字体粗细正常。 |
| Normal | 字体粗细正常。 |
| Regular | 字体粗细正常。 |
| Regular | 字体粗细正常。 |
| Medium | 字体粗细适中。 |
| Medium | 字体粗细适中。 |
| Bold | 字体较粗。 |
| Bold | 字体较粗。 |
| Bolder | 字体非常粗。 |
| Bolder | 字体非常粗。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md
浏览文件 @
605a6e4d
# 触摸热区设置
# 触摸热区设置
> **说明:**
> **说明:**
>
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -16,19 +17,20 @@
...
@@ -16,19 +17,20 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
------ | ---------------------------------------- | ---------------------------------------- | --------------------------------
-------- |
| responseRegion | Array
<
Rectangle
>
\|
Rectangle | {
<br/>
x:0,
<br/>
y:0,
<br/>
width:'100%',
<br/>
height:'100%'
<br/>
} | 设置一个或多个触摸热区,包括位置和大小。
<br/>
>
**说明:**
<br/>
>
-百分比是相对于组件本身来度量的。
<br/>
>
-x和y可以设置正负值百分比。当x设置为'100%'时表示热区往右偏移组件本身宽度大小,当x设置为'-100%'时表示热区往左偏移组件本身宽度大小。当y设置为'100%'时表示热区往下偏移组件本身高度大小,当y设置为'-100%'时表示热区往上偏移组件本身高度大小。
<br/>
>
-width和height只能设置正值百分比。width:'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp,那么'100%'表示热区宽度也为100vp。height:'100%'表示热区高度设置为该组件本身的高度。 |
| responseRegion | Array
<
Rectangle
>
\|
Rectangle | {
<br/>
x:0,
<br/>
y:0,
<br/>
width:'100%',
<br/>
height:'100%'
<br/>
} | 设置一个或多个触摸热区,包括位置和大小。
<br/>
>
**说明:**
<br/>
>
-百分比是相对于组件本身来度量的。
<br/>
>
-x和y可以设置正负值百分比。当x设置为'100%'时表示热区往右偏移组件本身宽度大小,当x设置为'-100%'时表示热区往左偏移组件本身宽度大小。当y设置为'100%'时表示热区往下偏移组件本身高度大小,当y设置为'-100%'时表示热区往上偏移组件本身高度大小。
<br/>
>
-width和height只能设置正值百分比。width:'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp,那么'100%'表示热区宽度也为100vp。height:'100%'表示热区高度设置为该组件本身的高度。 |
### Rectangle对象说明
### Rectangle对象说明
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| 名称 | 类型 | 必填 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
-------- |
| ------ | ------ | ---- | ---- | ----------
-------- |
| x | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。 |
| x | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。 |
| y | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。 |
| y | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。 |
| width | Length | 否 | 100% | 触摸热区范围的宽度。 |
| width | Length | 否 | 100% | 触摸热区范围的宽度。 |
| height | Length | 否 | 100% | 触摸热区范围的高度。 |
| height | Length | 否 | 100% | 触摸热区范围的高度。 |
> **说明:**
> **说明:**
>
> 当x和y都设置为正值时,表示组件的触摸热区的范围整体往组件本身右下角偏移,偏移的大小可通过数值来设置。
> 当x和y都设置为正值时,表示组件的触摸热区的范围整体往组件本身右下角偏移,偏移的大小可通过数值来设置。
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md
浏览文件 @
605a6e4d
# 图形变换
# 图形变换
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,7 +14,7 @@
...
@@ -13,7 +14,7 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
- | ---------------------------------------- | ---------------------------------------- | --------------------------------
-------- |
| rotate | {
<br/>
x?:
number,
<br/>
y?:
number,
<br/>
z?:
number,
<br/>
angle?:
Angle,
<br/>
centerX?:
Length,
<br/>
centerY?:
Length
<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设置旋转的中心点。 |
| rotate | {
<br/>
x?:
number,
<br/>
y?:
number,
<br/>
z?:
number,
<br/>
angle?:
Angle,
<br/>
centerX?:
Length,
<br/>
centerY?:
Length
<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?:
Length,
<br/>
y?:
Length,
<br/>
z?
:
Length
<br/>
} | {
<br/>
x:
0,
<br/>
y:
0,
<br/>
z:
0
<br/>
} | 可以分别设置X轴、Y轴、Z轴的平移距离,距离的正负控制平移的方向,默认值为0。 |
| translate | {
<br/>
x?:
Length,
<br/>
y?:
Length,
<br/>
z?
:
Length
<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?:
Length,
<br/>
centerY?:
Length
<br/>
} | {
<br/>
x:
1,
<br/>
y:
1,
<br/>
z:
1,
<br/>
centerX:'50%',
<br/>
centerY:'50%'
<br/>
} | 可以分别设置X轴、Y轴、Z轴的缩放比例,默认值为1,同时可以通过centerX和centerY设置缩放的中心点。 |
| scale | {
<br/>
x?:
number,
<br/>
y?:
number,
<br/>
z?:
number,
<br/>
centerX?:
Length,
<br/>
centerY?:
Length
<br/>
} | {
<br/>
x:
1,
<br/>
y:
1,
<br/>
z:
1,
<br/>
centerX:'50%',
<br/>
centerY:'50%'
<br/>
} | 可以分别设置X轴、Y轴、Z轴的缩放比例,默认值为1,同时可以通过centerX和centerY设置缩放的中心点。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md
浏览文件 @
605a6e4d
# 显隐控制
# 显隐控制
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,17 +14,16 @@
...
@@ -13,17 +14,16 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| --------
| -------- | -------- |
-------- |
| --------
-- | ---------- | ------------------ | ----
-------- |
| visibility | Visibility | Visibility.Visible | 控制当前组件显示或隐藏。 |
| visibility | Visibility | Visibility.Visible | 控制当前组件显示或隐藏。 |
## Visibility枚举说明
-
Visibility枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
| ------- | ---------------- |
| -------- | -------- |
| Hidden | 隐藏,但参与布局进行占位。 |
| Hidden | 隐藏,但参与布局进行占位。 |
| Visible | 显示。 |
| Visible | 显示。 |
| None | 隐藏,但不参与布局,不进行占位。 |
| None | 隐藏,但不参与布局,不进行占位。 |
## 示例
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md
浏览文件 @
605a6e4d
# Z序控制
# Z序控制
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -13,7 +14,7 @@
...
@@ -13,7 +14,7 @@
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| ------
-- | -------- | -------- |
-------- |
| ------
| ------ | ---- | --------------------
-------- |
| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系,z值越大,显示层级越高。 |
| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系,z值越大,显示层级越高。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md
浏览文件 @
605a6e4d
# 组件区域变化事件
# 组件区域变化事件
> **说明:**
> **说明:**
>
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -12,7 +13,7 @@
...
@@ -12,7 +13,7 @@
## 事件
## 事件
| 名称 | 支持冒泡 | 功能描述 |
| 名称 | 支持冒泡 | 功能描述 |
| --------
| -------- |
-------- |
| --------
-------------------------------- | ---- | --------------------------------
-------- |
| onAreaChange(event:
(oldValue:
Area,
newValue:
Area)
=
>
void) | 否 | 组件区域变化时触发该回调,Area类型说明见
[
Area对象
](
ts-universal-events-click.md
)
介绍。 |
| onAreaChange(event:
(oldValue:
Area,
newValue:
Area)
=
>
void) | 否 | 组件区域变化时触发该回调,Area类型说明见
[
Area对象
](
ts-universal-events-click.md
)
介绍。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md
浏览文件 @
605a6e4d
# 点击事件
# 点击事件
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -27,7 +28,7 @@
...
@@ -27,7 +28,7 @@
## EventTarget<sup>8+</sup>对象说明
## EventTarget<sup>8+</sup>对象说明
| 名称 | 参数类型 | 描述 |
| 名称 | 参数类型 | 描述 |
| ---- | ----------------- | ---------- |
| ---- | -----------------
-
| ---------- |
| area |
[
Area
](
#area8对象说明
)
| 目标元素的区域信息。 |
| area |
[
Area
](
#area8对象说明
)
| 目标元素的区域信息。 |
## Area<sup>8+</sup>对象说明
## Area<sup>8+</sup>对象说明
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md
浏览文件 @
605a6e4d
# 拖拽事件
# 拖拽事件
> **说明:**
> **说明:**
>
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 事件
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md
浏览文件 @
605a6e4d
...
@@ -3,6 +3,7 @@
...
@@ -3,6 +3,7 @@
按键事件指组件与键盘、遥控器等按键设备交互时触发的事件。
按键事件指组件与键盘、遥控器等按键设备交互时触发的事件。
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -20,22 +21,23 @@
...
@@ -20,22 +21,23 @@
## KeyEvent对象说明
## KeyEvent对象说明
-
属性
### 属性
| 属性名称 | 类型 | 描述 |
| ------------------------------------- | --------------------------- | -------------------------- |
| 属性名称 | 类型 | 描述 |
| type |
[
KeyType
](
#keytype枚举说明
)
| 按键的类型。 |
| ------------------------------------- | --------------------------- | -------------------------- |
|
[
keyCode
](
../apis/js-apis-keycode.md
)
| number | 按键的键码。 |
| type |
[
KeyType
](
#keytype枚举说明
)
| 按键的类型。 |
| keyText | string | 按键的键值。 |
|
[
keyCode
](
../apis/js-apis-keycode.md
)
| number | 按键的键码。 |
| keySource |
[
KeySource
](
#keysource枚举说明
)
| 触发当前按键的输入设备类型。 |
| keyText | string | 按键的键值。 |
| deviceId | number | 触发当前按键的输入设备ID。 |
| keySource |
[
KeySource
](
#keysource枚举说明
)
| 触发当前按键的输入设备类型。 |
| metaKey | number | 按键发生时元键的状态,1表示按压态,0表示未按压态。 |
| deviceId | number | 触发当前按键的输入设备ID。 |
| timestamp | number | 按键发生时的时间戳。 |
| metaKey | number | 按键发生时元键的状态,1表示按压态,0表示未按压态。 |
| timestamp | number | 按键发生时的时间戳。 |
-
接口
### 接口
| 接口名称 | 功能描述 |
| ---------------------------- | --------- |
| 接口名称 | 功能描述 |
| stopPropagation():
void | 阻塞事件冒泡传递。 |
| ---------------------------- | --------- |
| stopPropagation():
void | 阻塞事件冒泡传递。 |
## KeyType枚举说明
## KeyType枚举说明
| 名称 | 描述 |
| 名称 | 描述 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md
浏览文件 @
605a6e4d
# 挂载卸载事件
# 挂载卸载事件
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -12,7 +13,7 @@
...
@@ -12,7 +13,7 @@
## 事件
## 事件
| 名称 | 支持冒泡 | 功能描述 |
| 名称 | 支持冒泡 | 功能描述 |
| --------
| -------- | -------- |
| --------
-------------------------------- | ---- | ------------- |
| onAppear(callback:
()
=
>
void) | 否 | 组件挂载显示时触发此回调。 |
| onAppear(callback:
()
=
>
void) | 否 | 组件挂载显示时触发此回调。 |
| onDisappear(callback:
()
=
>
void) | 否 | 组件卸载消失时触发此回调。 |
| onDisappear(callback:
()
=
>
void) | 否 | 组件卸载消失时触发此回调。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md
浏览文件 @
605a6e4d
# 触摸事件
# 触摸事件
> **说明:**
> **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -18,21 +19,21 @@
...
@@ -18,21 +19,21 @@
## TouchEvent对象说明
## TouchEvent对象说明
-
属性
### 属性
| 属性名称 | 类型 | 描述 |
| ------------------- | ---------------------------------------- | ------------ |
| type | TouchType | 触摸事件的类型。 |
| touches | Array
<
[TouchObject](#touchobject对象说明)
>
| 全部手指信息。 |
| changedTouches | Array
<
[TouchObject](#touchobject对象说明)
>
| 当前发生变化的手指信息。 |
| timestamp | number | 事件时间戳。 |
| target
<sup>
8+
</sup>
|
[
EventTarget
](
ts-universal-events-click.md#eventtarget8对象说明
)
| 被触摸元素对象。 |
-
接口
| 接口名称 | 功能描述 |
| ---------------------- | ------- |
| stopPropagation():void | 阻塞事件冒泡。 |
| 属性名称 | 类型 | 描述 |
| ------------------- | ---------------------------------------- | ------------ |
| type | TouchType | 触摸事件的类型。 |
| touches | Array
<
[TouchObject](#touchobject对象说明)
>
| 全部手指信息。 |
| changedTouches | Array
<
[TouchObject](#touchobject对象说明)
>
| 当前发生变化的手指信息。 |
| timestamp | number | 事件时间戳。 |
| target
<sup>
8+
</sup>
|
[
EventTarget
](
ts-universal-events-click.md#eventtarget8对象说明
)
| 被触摸元素对象。 |
### 接口
| 接口名称 | 功能描述 |
| ---------------------- | ------- |
| stopPropagation():void | 阻塞事件冒泡。 |
## TouchObject对象说明
## TouchObject对象说明
| 属性名称 | 类型 | 描述 |
| 属性名称 | 类型 | 描述 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md
浏览文件 @
605a6e4d
# 焦点事件
# 焦点事件
> **说明:**
> **说明:**
>
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
@@ -12,7 +13,7 @@
...
@@ -12,7 +13,7 @@
## 事件
## 事件
|
**名称**
|
**支持冒泡**
|
**功能描述**
|
|
**名称**
|
**支持冒泡**
|
**功能描述**
|
| --------
| -------- |
-------- |
| --------
-------------------------------- | -------- | -------
-------- |
| onFocus(callback:
()
=
>
void) | 否 | 当前组件获取焦点时触发的回调。 |
| onFocus(callback:
()
=
>
void) | 否 | 当前组件获取焦点时触发的回调。 |
| onBlur(callback:()
=
>
void) | 否 | 当前组件失去焦点时触发的回调。 |
| onBlur(callback:()
=
>
void) | 否 | 当前组件失去焦点时触发的回调。 |
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md
浏览文件 @
605a6e4d
# 鼠标事件
# 鼠标事件
> **说明:**
> **说明:**
>
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录