未验证 提交 7aea4206 编写于 作者: O openharmony_ci 提交者: Gitee

!17240 规范格式

Merge pull request !17240 from LiAn/master
...@@ -157,6 +157,7 @@ struct Parent { ...@@ -157,6 +157,7 @@ struct Parent {
在自定义组件中使用\@BuilderParam装饰的属性时也可通过尾随闭包进行初始化。在初始化自定义组件时,组件后紧跟一个大括号“{}”形成尾随闭包场景。 在自定义组件中使用\@BuilderParam装饰的属性时也可通过尾随闭包进行初始化。在初始化自定义组件时,组件后紧跟一个大括号“{}”形成尾随闭包场景。
> **说明:** > **说明:**
>
> 此场景下自定义组件内有且仅有一个使用\@BuilderParam装饰的属性。 > 此场景下自定义组件内有且仅有一个使用\@BuilderParam装饰的属性。
开发者可以将尾随闭包内的内容看做\@Builder装饰的函数传给\@BuilderParam。示例如下: 开发者可以将尾随闭包内的内容看做\@Builder装饰的函数传给\@BuilderParam。示例如下:
......
...@@ -29,6 +29,7 @@ Environment是ArkUI框架在应用程序启动时创建的单例对象。它为A ...@@ -29,6 +29,7 @@ Environment是ArkUI框架在应用程序启动时创建的单例对象。它为A
设备环境到Component的更新链:Environment --> AppStorage -->Component。 设备环境到Component的更新链:Environment --> AppStorage -->Component。
> **说明:** > **说明:**
>
> \@StorageProp关联的环境参数可以在本地更改,但不能同步回AppStorage中,因为应用对环境变量参数是不可写的,只能在Environment中查询。 > \@StorageProp关联的环境参数可以在本地更改,但不能同步回AppStorage中,因为应用对环境变量参数是不可写的,只能在Environment中查询。
......
...@@ -77,7 +77,7 @@ struct Index { ...@@ -77,7 +77,7 @@ struct Index {
``` ```
- 新应用安装后首次启动运行: - 新应用安装后首次启动运行:
1. 调用PersistProp初始化PersistentStorage,首先查询在PersistentStorage本地文件中是否存在“aProp”,查询结果为不存在,因为应用是第一次安装 1. 调用PersistProp初始化PersistentStorage,首先查询在PersistentStorage本地文件中是否存在“aProp”,查询结果为不存在,因为应用是第一次安装;
2. 接着查询属性“aProp”在AppStorage中是否存在,依旧不存在; 2. 接着查询属性“aProp”在AppStorage中是否存在,依旧不存在;
3. 在AppStorge中创建名为“aProp”的number类型属性,属性初始值是定义的默认值47; 3. 在AppStorge中创建名为“aProp”的number类型属性,属性初始值是定义的默认值47;
4. PersistentStorage将属性“aProp”和值47写入磁盘,AppStorage中“aProp”对应的值和其后续的更改将被持久化; 4. PersistentStorage将属性“aProp”和值47写入磁盘,AppStorage中“aProp”对应的值和其后续的更改将被持久化;
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
提供Lottie动画。 提供Lottie动画。
> **说明:** > **说明:**
> >
> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 > 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...@@ -16,9 +16,7 @@ import lottie from '@ohos/lottieETS' ...@@ -16,9 +16,7 @@ import lottie from '@ohos/lottieETS'
> **说明:** > **说明:**
> >
> 在Terminal窗口使用 `npm install @ohos/lottieETS` 命令下载Lottie,下载之前需要配置权限。 > 在第一次使用Lottie之前,需要在Terminal窗口运行 `ohpm install @ohos/lottieETS` 命令下载Lottie。
>
> 安装ohos npm 三方包时,需要先执行`npm config set @ohos:registry=https://repo.harmonyos.com/npm/`设置仓库地址。
## lottie.loadAnimation ## lottie.loadAnimation
...@@ -31,15 +29,15 @@ path: string, container: object, render: string, loop: boolean, autoplay: boolea ...@@ -31,15 +29,15 @@ path: string, container: object, render: string, loop: boolean, autoplay: boolea
**参数:** **参数:**
| 参数 | 类型 | 必填 | 描述 | | 参数 | 类型 | 必填 | 描述 |
| -------------- | --------------------------- | ---- | ------------------------------------------------------------ | | -------------- | --------------------------- | ---- | ---------------------------------------- |
| path | string | 是 | HAP内动画资源文件路径,仅支持json格式。示例:path: "common/lottie/data.json" | | path | string | 是 | HAP内动画资源文件路径,仅支持json格式。示例:path: "common/lottie/data.json" |
| container | object | 是 | canvas绘图上下文,声明范式需提前声明CanvasRenderingContext2D。 | | container | object | 是 | canvas绘图上下文,声明范式需提前声明CanvasRenderingContext2D。 |
| render | string | 是 | 渲染类型,仅支持“canvas”。 | | render | string | 是 | 渲染类型,仅支持“canvas”。 |
| loop | boolean \| number | 否 | 动画播放结束后,是否循环播放,默认值true。值类型为number,且大于等于1时为设置的重复播放的次数。 | | loop | boolean \| number | 否 | 动画播放结束后,是否循环播放,默认值true。值类型为number,且大于等于1时为设置的重复播放的次数。 |
| autoplay | boolean | 否 | 是否自动播放动画,默认值true。 | | autoplay | boolean | 否 | 是否自动播放动画,默认值true。 |
| name | string | 否 | 开发者自定义的动画名称,后续支持通过该名称引用控制动画,默认为空。 | | name | string | 否 | 开发者自定义的动画名称,后续支持通过该名称引用控制动画,默认为空。 |
| initialSegment | [number, number] | 否 | 指定动画播放的起始帧号,指定动画播放的结束帧号。 | | initialSegment | [number, number] | 否 | 指定动画播放的起始帧号,指定动画播放的结束帧号。 |
## lottie.destroy ## lottie.destroy
......
...@@ -24,6 +24,7 @@ Video组件支持加载本地视频和网络视频。 ...@@ -24,6 +24,7 @@ Video组件支持加载本地视频和网络视频。
### 加载本地视频 ### 加载本地视频
- 普通本地视频。 - 普通本地视频。
加载本地视频时,首先在本地rawfile目录指定对应的文件,如下图所示。 加载本地视频时,首先在本地rawfile目录指定对应的文件,如下图所示。
![zh-cn_image_0000001562700409](figures/zh-cn_image_0000001562700409.png) ![zh-cn_image_0000001562700409](figures/zh-cn_image_0000001562700409.png)
...@@ -158,6 +159,7 @@ struct VideoPlayer{ ...@@ -158,6 +159,7 @@ struct VideoPlayer{
Video控制器主要用于控制视频的状态,包括播放、暂停、停止以及设置进度等,详细的使用请参考[VideoController使用说明](../reference/arkui-ts/ts-media-components-video.md#videocontroller) Video控制器主要用于控制视频的状态,包括播放、暂停、停止以及设置进度等,详细的使用请参考[VideoController使用说明](../reference/arkui-ts/ts-media-components-video.md#videocontroller)
- 默认控制器 - 默认控制器
默认的控制器支持视频的开始、暂停、进度调整、全屏显示四项基本功能。 默认的控制器支持视频的开始、暂停、进度调整、全屏显示四项基本功能。
```ts ```ts
...@@ -184,6 +186,7 @@ Video控制器主要用于控制视频的状态,包括播放、暂停、停止 ...@@ -184,6 +186,7 @@ Video控制器主要用于控制视频的状态,包括播放、暂停、停止
``` ```
- 自定义控制器 - 自定义控制器
使用自定义的控制器,先将默认控制器关闭掉,之后可以使用button以及slider等组件进行自定义的控制与显示,适合自定义较强的场景下使用。 使用自定义的控制器,先将默认控制器关闭掉,之后可以使用button以及slider等组件进行自定义的控制与显示,适合自定义较强的场景下使用。
```ts ```ts
......
...@@ -189,6 +189,7 @@ XComponent({ id: 'xcomponentId1', type: 'surface', libraryname: 'nativerender' } ...@@ -189,6 +189,7 @@ XComponent({ id: 'xcomponentId1', type: 'surface', libraryname: 'nativerender' }
- id : 与XComponent组件为一一对应关系,不可重复。通常开发者可以在native侧通过OH_NativeXComponent_GetXComponentId接口来获取对应的id从而绑定对应的XComponent。 - id : 与XComponent组件为一一对应关系,不可重复。通常开发者可以在native侧通过OH_NativeXComponent_GetXComponentId接口来获取对应的id从而绑定对应的XComponent。
- libraryname:加载模块的名称,必须与在native侧Napi模块注册时nm_modname的名字一致。 - libraryname:加载模块的名称,必须与在native侧Napi模块注册时nm_modname的名字一致。
>**说明:** >**说明:**
> >
> 应用加载模块实现跨语言调用有两种方式: > 应用加载模块实现跨语言调用有两种方式:
...@@ -210,6 +211,7 @@ XComponent({ id: 'xcomponentId1', type: 'surface', libraryname: 'nativerender' } ...@@ -210,6 +211,7 @@ XComponent({ id: 'xcomponentId1', type: 'surface', libraryname: 'nativerender' }
![图片2](figures/图片2.png) ![图片2](figures/图片2.png)
- onDestroy事件 - onDestroy事件
触发时刻:XComponent组件被销毁时触发与一般ArkUI的组件销毁时机一致,其和native侧的OnSurfaceDestroyed的时序如下图: 触发时刻:XComponent组件被销毁时触发与一般ArkUI的组件销毁时机一致,其和native侧的OnSurfaceDestroyed的时序如下图:
![图片3](figures/图片3.png) ![图片3](figures/图片3.png)
......
...@@ -37,19 +37,20 @@ ...@@ -37,19 +37,20 @@
- 线性走焦:常见的容器有Flex、Row、Column、List,这些都是典型的单方向容器,组件在这些容器内的排列都是线性的,那么走焦规则也是线性的。走焦的方向和方向键的方向一致。 - 线性走焦:常见的容器有Flex、Row、Column、List,这些都是典型的单方向容器,组件在这些容器内的排列都是线性的,那么走焦规则也是线性的。走焦的方向和方向键的方向一致。
**图1** 线性走焦示意图   **图1** 线性走焦示意图  
![zh-cn_image_0000001562700537](figures/zh-cn_image_0000001562700537.png) ![zh-cn_image_0000001562700537](figures/zh-cn_image_0000001562700537.png)
例如Row容器,使用方向键左右(←/→)即可将焦点在相邻的2个可获焦组件之间来回切换。 例如Row容器,使用方向键左右(←/→)即可将焦点在相邻的2个可获焦组件之间来回切换。
- 十字走焦:使用方向键上(↑)下(↓)左(←)右(→)可以使焦点在相邻的组件上切换。典型的是Grid容器,如下图: - 十字走焦:使用方向键上(↑)下(↓)左(←)右(→)可以使焦点在相邻的组件上切换。典型的是Grid容器,如下图:
**图2** Grid组件十字走焦示意图   **图2** Grid组件十字走焦示意图  
![zh-cn_image_0000001511740580](figures/zh-cn_image_0000001511740580.png) ![zh-cn_image_0000001511740580](figures/zh-cn_image_0000001511740580.png)
>**说明:** >**说明:**
>
> - TAB/SHIFT+TAB键在以上两种走焦规则上的功能和方向键一致。TAB键等同于“先执行方向键右,若无法走焦,再执行方向键下”,SHIFT+TAB键等同于“先执行方向键左,若无法走焦,再执行方向键上”。 > - TAB/SHIFT+TAB键在以上两种走焦规则上的功能和方向键一致。TAB键等同于“先执行方向键右,若无法走焦,再执行方向键下”,SHIFT+TAB键等同于“先执行方向键左,若无法走焦,再执行方向键上”。
> >
> - 触发走焦的按键是按下的事件(DOWN事件)。 > - 触发走焦的按键是按下的事件(DOWN事件)。
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
触屏事件指当手指/手写笔在组件上按下、滑动、抬起时触发的回调事件。包括[点击事件](#点击事件)[拖拽事件](#拖拽事件)[触摸事件](#触摸事件) 触屏事件指当手指/手写笔在组件上按下、滑动、抬起时触发的回调事件。包括[点击事件](#点击事件)[拖拽事件](#拖拽事件)[触摸事件](#触摸事件)
**图1 ** 触摸事件原理 **图1** 触摸事件原理
![zh-cn_image_0000001562700461](figures/zh-cn_image_0000001562700461.png) ![zh-cn_image_0000001562700461](figures/zh-cn_image_0000001562700461.png)
......
...@@ -245,6 +245,7 @@ OffscreenCanvasRenderingContext2D对象和CanvasRenderingContext2D对象提供 ...@@ -245,6 +245,7 @@ OffscreenCanvasRenderingContext2D对象和CanvasRenderingContext2D对象提供
![drawimage](figures/drawimage.PNG) ![drawimage](figures/drawimage.PNG)
- 其他方法。 - 其他方法。
Canvas中还提供其他类型的方法。渐变([CanvasGradient对象](../reference/arkui-ts/ts-components-canvas-canvasgradient.md))相关的方法:[createLinearGradient](../reference/arkui-ts/ts-canvasrenderingcontext2d.md#createlineargradient)(创建一个线性渐变色)、[createRadialGradient](../reference/arkui-ts/ts-canvasrenderingcontext2d.md#createradialgradient)(创建一个径向渐变色)等。 Canvas中还提供其他类型的方法。渐变([CanvasGradient对象](../reference/arkui-ts/ts-components-canvas-canvasgradient.md))相关的方法:[createLinearGradient](../reference/arkui-ts/ts-canvasrenderingcontext2d.md#createlineargradient)(创建一个线性渐变色)、[createRadialGradient](../reference/arkui-ts/ts-canvasrenderingcontext2d.md#createradialgradient)(创建一个径向渐变色)等。
```ts ```ts
...@@ -270,7 +271,7 @@ OffscreenCanvasRenderingContext2D对象和CanvasRenderingContext2D对象提供 ...@@ -270,7 +271,7 @@ OffscreenCanvasRenderingContext2D对象和CanvasRenderingContext2D对象提供
## 场景示例 ## 场景示例
- 规则基础形状绘制 - 规则基础形状绘制
```ts ```ts
@Entry @Entry
......
...@@ -123,6 +123,7 @@ Image支持加载存档图、多媒体像素图两种类型。 ...@@ -123,6 +123,7 @@ Image支持加载存档图、多媒体像素图两种类型。
``` ```
- base64 - base64
路径格式为data:image/[png|jpeg|bmp|webp];base64,[base64 data],其中[base64 data]为Base64字符串数据。 路径格式为data:image/[png|jpeg|bmp|webp];base64,[base64 data],其中[base64 data]为Base64字符串数据。
Base64格式字符串可用于存储图片的像素数据,在网页上使用较为广泛。 Base64格式字符串可用于存储图片的像素数据,在网页上使用较为广泛。
...@@ -130,7 +131,7 @@ Image支持加载存档图、多媒体像素图两种类型。 ...@@ -130,7 +131,7 @@ Image支持加载存档图、多媒体像素图两种类型。
### 多媒体像素图 ### 多媒体像素图
PixelMap是图片解码后的像素图,具体用法请参考[图片开发指导](../media/image.md)。以下示例将加载的网络图片返回的数据解码成PixelMap格式,再显示在Image组件上, PixelMap是图片解码后的像素图,具体用法请参考[图片开发指导](../media/image-overview.md)。以下示例将加载的网络图片返回的数据解码成PixelMap格式,再显示在Image组件上,
1. 创建PixelMap状态变量。 1. 创建PixelMap状态变量。
...@@ -201,9 +202,11 @@ Image($r('app.media.cloud')).width(50) ...@@ -201,9 +202,11 @@ Image($r('app.media.cloud')).width(50)
``` ```
**图3** 原始图片   **图3** 原始图片  
![屏幕截图_20230223_141141](figures/屏幕截图_20230223_141141.png) ![屏幕截图_20230223_141141](figures/屏幕截图_20230223_141141.png)
**图4** 设置绘制颜色后的svg图片   **图4** 设置绘制颜色后的svg图片  
![屏幕截图_20230223_141404](figures/屏幕截图_20230223_141404.png) ![屏幕截图_20230223_141404](figures/屏幕截图_20230223_141404.png)
......
...@@ -15,6 +15,7 @@ NavRouter是和Navigation搭配使用的特殊子组件,默认提供点击响 ...@@ -15,6 +15,7 @@ NavRouter是和Navigation搭配使用的特殊子组件,默认提供点击响
Navigation组件通过mode属性设置页面的显示模式。 Navigation组件通过mode属性设置页面的显示模式。
- 自适应模式 - 自适应模式
Navigation组件默认为自适应模式,此时mode属性为NavigationMode.Auto。自适应模式下,当设备宽度大于520vp时,Navigation组件采用分栏模式,反之采用单页面模式。 Navigation组件默认为自适应模式,此时mode属性为NavigationMode.Auto。自适应模式下,当设备宽度大于520vp时,Navigation组件采用分栏模式,反之采用单页面模式。
...@@ -152,7 +153,7 @@ Navigation组件通过mode属性设置页面的显示模式。 ...@@ -152,7 +153,7 @@ Navigation组件通过mode属性设置页面的显示模式。
## 设置菜单栏 ## 设置菜单栏
菜单栏位于Navigation组件的右上角,开发者可以通过menus属性进行设置。menus支持Array<[NavigationMenuItem](../reference/arkui-ts/ts-basic-components-navigation.md#navigationmenuitem%E7%B1%BB%E5%9E%8B%E8%AF%B4%E6%98%8E)>和CustomBuilder两种参数类型。使用Array<NavigationMenuItem>类型时,竖屏最多支持显示3个图标,横屏最多支持显示5个图标,多余的图标会被放入自动生成的更多图标。 菜单栏位于Navigation组件的右上角,开发者可以通过menus属性进行设置。menus支持Array<[NavigationMenuItem](../reference/arkui-ts/ts-basic-components-navigation.md#navigationmenuitem)>和CustomBuilder两种参数类型。使用Array<NavigationMenuItem>类型时,竖屏最多支持显示3个图标,横屏最多支持显示5个图标,多余的图标会被放入自动生成的更多图标。
**图5** 设置了3个图标的菜单栏   **图5** 设置了3个图标的菜单栏  
......
...@@ -272,11 +272,10 @@ function onBackClick(): void { ...@@ -272,11 +272,10 @@ function onBackClick(): void {
其中,router.showAlertBeforeBackPage()方法接收一个对象作为参数,该对象包含以下属性: 其中,router.showAlertBeforeBackPage()方法接收一个对象作为参数,该对象包含以下属性:
- message:string类型,表示询问框的内容。 message:string类型,表示询问框的内容。
如果调用成功,则会在目标界面开启页面返回询问框;如果调用失败,则会抛出异常,并通过err.code和err.message获取错误码和错误信息。 如果调用成功,则会在目标界面开启页面返回询问框;如果调用失败,则会抛出异常,并通过err.code和err.message获取错误码和错误信息。
当用户点击“返回”按钮时,会弹出确认对话框,询问用户是否确认返回。选择“取消”将停留在当前页目标页;选择“确认”将触发router.back()方法,并根据参数决定如何执行跳转。
当用户点击“返回”按钮时,会弹出确认对话框,询问用户是否确认返回。选择“取消”将停留在当前页目标页;选择“确认”将触发router.back()方法,并根据参数决定如何执行跳转。
### 自定义询问框 ### 自定义询问框
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册