diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md b/zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md index 2d4e1ad5f0fe45b8108b69a306d96e666f9414b7..354b8ab55c077224f97c03fc867c376a2ab36c81 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-animatorproperty.md @@ -1,42 +1,42 @@ # 属性动画 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 组件的通用属性发生变化时,可以创建属性动画进行渐变,提升用户体验。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| duration | number | 1000 | 单位为毫秒,默认动画时长为1000毫秒。 | -| curve | Curve | Curve.Linear | 默认曲线为线性。 | -| delay | number | 0 | 单位为毫秒,默认不延时播放。 | -| iterations | number | 1 | 默认播放一次,设置为-1时表示无限次播放。 | -| playMode | [PlayMode](ts-appendix-enums.md#playmode枚举值说明) | PlayMode.Normal | 设置动画播放模式,默认播放完成后重头开始播放。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------- | ---------------------------------------- | --------------- | ----------------------- | +| duration | number | 1000 | 单位为毫秒,默认动画时长为1000毫秒。 | +| curve | Curve | Curve.Linear | 默认曲线为线性。 | +| delay | number | 0 | 单位为毫秒,默认不延时播放。 | +| iterations | number | 1 | 默认播放一次,设置为-1时表示无限次播放。 | +| playMode | [PlayMode](ts-appendix-enums.md#playmode枚举值说明) | PlayMode.Normal | 设置动画播放模式,默认播放完成后重头开始播放。 | -- Curve枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Linear | 表示动画从头到尾的速度都是相同的。 | - | Ease | 表示动画以低速开始,然后加快,在结束前变慢,CubicBezier(0.25, 0.1, 0.25, 1.0)。 | - | EaseIn | 表示动画以低速开始,CubicBezier(0.42, 0.0, 1.0, 1.0)。 | - | EaseOut | 表示动画以低速结束,CubicBezier(0.0, 0.0, 0.58, 1.0)。 | - | EaseInOut | 表示动画以低速开始和结束,CubicBezier(0.42, 0.0, 0.58, 1.0)。 | - | FastOutSlowIn | 标准曲线,cubic-bezier(0.4, 0.0, 0.2, 1.0)。 | - | LinearOutSlowIn | 减速曲线,cubic-bezier(0.0, 0.0, 0.2, 1.0)。 | - | FastOutLinearIn | 加速曲线,cubic-bezier(0.4, 0.0, 1.0, 1.0)。 | - | ExtremeDeceleration | 急缓曲线,cubic-bezier(0.0, 0.0, 0.0, 1.0)。 | - | Sharp | 锐利曲线,cubic-bezier(0.33, 0.0, 0.67, 1.0)。 | - | Rhythm | 节奏曲线,cubic-bezier(0.7, 0.0, 0.2, 1.0)。 | - | Smooth | 平滑曲线,cubic-bezier(0.4, 0.0, 0.4, 1.0)。 | - | Friction | 阻尼曲线,CubicBezier(0.2, 0.0, 0.2, 1.0)。 | +## Curve枚举说明 +| 名称 | 描述 | +| ------------------- | ---------------------------------------- | +| Linear | 表示动画从头到尾的速度都是相同的。 | +| Ease | 表示动画以低速开始,然后加快,在结束前变慢,CubicBezier(0.25, 0.1, 0.25, 1.0)。 | +| EaseIn | 表示动画以低速开始,CubicBezier(0.42, 0.0, 1.0, 1.0)。 | +| EaseOut | 表示动画以低速结束,CubicBezier(0.0, 0.0, 0.58, 1.0)。 | +| EaseInOut | 表示动画以低速开始和结束,CubicBezier(0.42, 0.0, 0.58, 1.0)。 | +| FastOutSlowIn | 标准曲线,cubic-bezier(0.4, 0.0, 0.2, 1.0)。 | +| LinearOutSlowIn | 减速曲线,cubic-bezier(0.0, 0.0, 0.2, 1.0)。 | +| FastOutLinearIn | 加速曲线,cubic-bezier(0.4, 0.0, 1.0, 1.0)。 | +| ExtremeDeceleration | 急缓曲线,cubic-bezier(0.0, 0.0, 0.0, 1.0)。 | +| Sharp | 锐利曲线,cubic-bezier(0.33, 0.0, 0.67, 1.0)。 | +| Rhythm | 节奏曲线,cubic-bezier(0.7, 0.0, 0.2, 1.0)。 | +| Smooth | 平滑曲线,cubic-bezier(0.4, 0.0, 0.4, 1.0)。 | +| Friction | 阻尼曲线,CubicBezier(0.2, 0.0, 0.2, 1.0)。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct AttrAnimationExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md index bb429a7b1797e981bb4b83b0afe0afcc18635bfb..b2fd017eed5e130444cec940e7b8f7c525060784 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md @@ -1,11 +1,11 @@ # Blank -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 空白填充组件,在容器主轴方向上,空白填充组件具有自动填充容器空余部分的能力。仅当父组件为Row/Column时生效。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,25 +21,27 @@ Blank(min?: Length) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | min | Length | 否 | 0 | 空白填充组件在容器主轴上的最小大小。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---- | ------ | ---- | ---- | ------------------ | +| min | Length | 否 | 0 | 空白填充组件在容器主轴上的最小大小。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| color | Color | 0x00000000 | 设置空白填充的填充颜色。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----- | ----- | ---------- | ------------ | +| color | Color | 0x00000000 | 设置空白填充的填充颜色。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> - 不支持通用属性方法。 +> **说明:** +> +> 不支持通用属性方法。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct BlankExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md index 9f6284b8a15d7ee563da28acda54e6433ab6ab3e..53541e4fb3ff29fca93adefceed3fe92c7ef5bb8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md @@ -1,11 +1,10 @@ # Button -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供按钮组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -19,52 +18,52 @@ ## 接口 -- Button(options?: {type?: ButtonType, stateEffect?: boolean}) +**方法1:** Button(options?: {type?: ButtonType, stateEffect?: boolean}) - **表1** options参数说明 - - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | type | ButtonType | 否 | Capsule | 描述按钮风格。 | - | stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果,当状态置为false时,点击效果关闭。 | +表1 options参数说明 +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----------- | ---------- | ---- | ------- | --------------------------------- | +| type | ButtonType | 否 | Capsule | 描述按钮风格。 | +| stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果,当状态置为false时,点击效果关闭。 | -- Button(label?: string, options?: { type?: ButtonType, stateEffect?: boolean }) +**方法2:** Button(label?: string, options?: { type?: ButtonType, stateEffect?: boolean }) - 使用文本内容创建相应的按钮组件,此时Button无法包含子组件。 +使用文本内容创建相应的按钮组件,此时Button无法包含子组件。 - **表2** value参数说明 - - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | label | string | 否 | - | 按钮文本内容。 | - | options | Object | 否 | - | 见options参数说明。 | +表2 value参数说明 +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ------ | ---- | ---- | ------------- | +| label | string | 否 | - | 按钮文本内容。 | +| options | Object | 否 | - | 见options参数说明。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| type | ButtonType | Capsule | 设置Button样式。 | -| stateEffect | boolean | true | 状态切换时是否开启切换效果,当状态置为false时,点击效果关闭。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------- | ---------- | ------- | --------------------------------- | +| type | ButtonType | Capsule | 设置Button样式。 | +| stateEffect | boolean | true | 状态切换时是否开启切换效果,当状态置为false时,点击效果关闭。 | -- ButtonType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Capsule | 胶囊型按钮(圆角默认为高度的一半)。 | - | Circle | 圆形按钮。 | - | Normal | 普通按钮(默认不带圆角)。 | +## ButtonType枚举说明 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> - 按钮圆角通过[通用属性borderRadius设置](ts-universal-attributes-border.md)(不支持通过border接口设置圆角)。 -> - 当按钮类型为Capsule时,borderRadius设置不生效,按钮圆角始终为高度的一半。 -> - 当按钮类型为Circle时,borderRadius即为按钮半径,若未设置borderRadius按钮半径则为宽、高中较小值的一半。 -> - 按钮文本通过[通用文本样式](ts-universal-attributes-text-style.md)进行设置。 +| 名称 | 描述 | +| ------- | ------------------ | +| Capsule | 胶囊型按钮(圆角默认为高度的一半)。 | +| Circle | 圆形按钮。 | +| Normal | 普通按钮(默认不带圆角)。 | + +> **说明:** +> - 按钮圆角通过[通用属性borderRadius设置](ts-universal-attributes-border.md)(不支持通过border接口设置圆角)。 +> - 当按钮类型为Capsule时,borderRadius设置不生效,按钮圆角始终为高度的一半。 +> - 当按钮类型为Circle时,borderRadius即为按钮半径,若未设置borderRadius按钮半径则为宽、高中较小值的一半。 +> - 按钮文本通过[通用文本样式](ts-universal-attributes-text-style.md)进行设置。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ButtonExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md index b11da741ede1d037d42efc989116c3e6140ade49..da728cd6f2392befb46e3fc939b82c757da81357 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md @@ -1,11 +1,11 @@ # Checkbox -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供多选框组件,通常用于某选项的打开或关闭。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 无 @@ -18,30 +18,30 @@ Checkbox( name?: string, group?: string ) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------| --------| ------ | -------- | -------- | - | name | string | 否 | - | 多选框名称。 | - | group | string | 否 | - | 多选框的群组名称。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | --------- | +| name | string | 否 | - | 多选框名称。 | +| group | string | 否 | - | 多选框的群组名称。 | ## 属性 - -| 名称 | 参数类型 | 默认值 | 描述 | -| ------------- | ------- | ------ | -------- | -| select | bool | false | 设置多选框是否选中。 | -| selectedColor | Color | - | 设置多选框选中状态颜色。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------------- | ----- | ----- | ------------ | +| select | bool | false | 设置多选框是否选中。 | +| selectedColor | Color | - | 设置多选框选中状态颜色。 | ## 事件 -| 名称 | 功能描述 | -| ----------| -------- | -|onChange(callback: (value: boolean) => void) | 当选中状态发生变化时,触发该回调。
- value为true时,表示已选中。
- value为false时,表示未选中。 | - +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onChange(callback: (value: boolean) => void) | 当选中状态发生变化时,触发该回调。
- value为true时,表示已选中。
- value为false时,表示未选中。 | + ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct CheckboxExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md index f372d73e39685d228562ec83478c189119f5a123..5c63cf463447595749e1b34d5cc9de15749e00b8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md @@ -1,10 +1,11 @@ # CheckboxGroup -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 多选框群组,用于控制多选框全选或者不全选状态。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 无 @@ -19,36 +20,37 @@ CheckboxGroup( group?: string ) 创建多选框群组,可以控制群组内的Checkbox全选或者不全选,相同group的Checkbox和CheckboxGroup为同一群组。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | group | string | 否 | - | 群组名称。| +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | ----- | +| group | string | 否 | - | 群组名称。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| selectAll | bool | false | 设置是否全选。 | -| selectedColor | Color | - | 设置被选中或部分选中状态的颜色。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------------- | ----- | ----- | ---------------- | +| selectAll | bool | false | 设置是否全选。 | +| selectedColor | Color | - | 设置被选中或部分选中状态的颜色。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange (callback: (names: Array<string>, status: SelectStatus) => void ) |CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时,触发回调。
- names:群组内所有被选中的多选框名称。
- status:选中状态。| +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onChange (callback: (names: Array<string>, status: SelectStatus) => void ) | CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时,触发回调。
- names:群组内所有被选中的多选框名称。
- status:选中状态。 | -- SelectStatus枚举说明 - | 名称 | 描述 | - | ----- | -------------------- | - | All | 群组多选择框全部选择。 | - | Part | 群组多选择框部分选择。 | - | None | 群组多选择框全部没有选择。 | +## SelectStatus枚举说明 +| 名称 | 描述 | +| ---- | ------------- | +| All | 群组多选择框全部选择。 | +| Part | 群组多选择框部分选择。 | +| None | 群组多选择框全部没有选择。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct CheckboxExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md index 4493797aed695da02300d185ed71aded7b337b95..c92d223978c7aa888390a370b57746250d7ce563 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md @@ -2,39 +2,37 @@ 数据面板组件,用于将多个数据占比情况使用占比图进行展示。 - ## 权限列表 无 - ## 子组件 无 - ## 接口 DataPanel(value:{values: number[], max?: number, type?: DataPanelType}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | values | number[] | 是 | - | 数据值列表,最大支持9个数据。 | - | max | number | 否 | 100 | - max大于0,表示数据的最大值。
- max小于等于0,max等于value数组各项的和,按比例显示。 | - | type8+ | DataPanelType | 否 | DataPanelType.Circle | 数据面板的类型。 | +**参数**: +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----------------- | ------------- | ---- | -------------------- | ---------------------------------------- | +| values | number[] | 是 | - | 数据值列表,最大支持9个数据。 | +| max | number | 否 | 100 | - max大于0,表示数据的最大值。
- max小于等于0,max等于value数组各项的和,按比例显示。 | +| type8+ | DataPanelType | 否 | DataPanelType.Circle | 数据面板的类型。 | -- DataPanelType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Line | 线型数据面板。 | - | Circle | 环形数据面板。 | +## DataPanelType枚举说明 +| 名称 | 描述 | +| ------ | ------- | +| Line | 线型数据面板。 | +| Circle | 环形数据面板。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct DataPanelExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md index ea467bc9bebefeb6c93353492e8774428e2369a5..b924ecf382677766765bd4485c553954f8f15273 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md @@ -1,55 +1,51 @@ # DatePicker -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 选择日期的滑动选择器组件。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 无 - ## 子组件 无 - ## 接口 DatePicker(options?: DatePickerOptions) 根据指定范围的Date创建可以选择日期的滑动选择器。 -- options参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | start | Date | 否 | Date('1970-1-1') | 指定选择器的起始日期。 | - | end | Date | 否 | Date('2100-12-31') | 指定选择器的结束日期。 | - | selected | Date | 否 | 当前系统日期 | 设置选中项的日期。 | +**options参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------- | ---- | ---- | ------------------ | ----------- | +| start | Date | 否 | Date('1970-1-1') | 指定选择器的起始日期。 | +| end | Date | 否 | Date('2100-12-31') | 指定选择器的结束日期。 | +| selected | Date | 否 | 当前系统日期 | 设置选中项的日期。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| lunar | boolean | false | 日期是否显示农历。
- true:展示农历。
- false:不展示农历。 | - +| 名称 | 参数类型 | 默认值 | 描述 | +| ----- | ------- | ----- | ---------------------------------------- | +| lunar | boolean | false | 日期是否显示农历。
- true:展示农历。
- false:不展示农历。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange(callback: (value: DatePickerResult) => void) | 选择日期时触发该事件。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ----------- | +| onChange(callback: (value: DatePickerResult) => void) | 选择日期时触发该事件。 | ### DatePickerResult对象说明 - | 名称 | 参数类型 | 描述 | - | -------- | -------- | -------- | - | year | number | 选中日期的年。 | - | month | number | 选中日期的月(0~11),0表示1月,11表示12月。 | - | day | number | 选中日期的日。 | +| 名称 | 参数类型 | 描述 | +| ----- | ------ | --------------------------- | +| year | number | 选中日期的年。 | +| month | number | 选中日期的月(0~11),0表示1月,11表示12月。 | +| day | number | 选中日期的日。 | ## 示例 @@ -57,7 +53,8 @@ DatePicker(options?: DatePickerOptions) ### 日期选择器(显示农历) -``` +```ts +// xxx.ets @Entry @Component struct DatePickerExample01 { @@ -84,7 +81,8 @@ struct DatePickerExample01 { ### 日期选择器(不显示农历) -``` +```ts +// xxx.ets @Entry @Component struct DatePickerExample02 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md index 6dd00b38d01bb96374e23c3767fda593735e54ee..b0db203ee2ad20a2575263340d39793174913671 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md @@ -1,45 +1,41 @@ # Divider -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供分隔器组件,分隔不同内容块/内容元素。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 无 - ## 子组件 无 - ## 接口 Divider() - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| vertical | boolean | false | 使用水平分割线还是垂直分割线,false: 水平分割线, true:垂直分割线。 | -| color | Color | - | 设置分割线颜色。 | -| strokeWidth | Length | 1 | 设置分割线宽度。 | -| lineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle枚举说明) | LineCapStyle.Butt | 设置分割线条的端点样式。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------- | ---------------------------------------- | ----------------- | ---------------------------------------- | +| vertical | boolean | false | 使用水平分割线还是垂直分割线,false: 水平分割线, true:垂直分割线。 | +| color | Color | - | 设置分割线颜色。 | +| strokeWidth | Length | 1 | 设置分割线宽度。 | +| lineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle枚举说明) | LineCapStyle.Butt | 设置分割线条的端点样式。 | ## 事件 不支持通用事件。 - ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct DividerExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md index aa5ea7c36ac30a12089ed39f237887c94fbb5f51..6c5cc216c0b2824344248feed4a3fb67193a195a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md @@ -1,50 +1,47 @@ # Gauge - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 数据量规图表组件,用于将数据展示为环形图表。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 无 - ## 子组件 无 - ## 接口 Gauge(value:{value: number, min?: number, max?: number}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | number | 是 | - | 当前数据值。 | - | min | number | 否 | 0 | 当前数据段最小值。 | - | max | number | 否 | 100 | 当前数据段最大值。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | --------- | +| value | number | 是 | - | 当前数据值。 | +| min | number | 否 | 0 | 当前数据段最小值。 | +| max | number | 否 | 100 | 当前数据段最大值。 | ## 属性 - | 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| value | number | 0 | 设置当前数据图表的值。 | -| startAngle | Angle | -150 | 设置起始角度位置,时钟0点为0度,顺时针方向为正角度。 | -| endAngle | Angle | 150 | 设置终止角度位置,时钟0点为0度,顺时针方向为正角度。 | -| colors | Color \| Array<ColorStop> | - | 设置图表的颜色,支持纯色和分段渐变色设置。 | -| strokeWidth | Length | - | 设置环形图表的环形厚度。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------- | ---------------------------------------- | ---- | --------------------------- | +| value | number | 0 | 设置当前数据图表的值。 | +| startAngle | Angle | -150 | 设置起始角度位置,时钟0点为0度,顺时针方向为正角度。 | +| endAngle | Angle | 150 | 设置终止角度位置,时钟0点为0度,顺时针方向为正角度。 | +| colors | Color \| Array<ColorStop> | - | 设置图表的颜色,支持纯色和分段渐变色设置。 | +| strokeWidth | Length | - | 设置环形图表的环形厚度。 | ## 示例 - -``` + +```ts +// xxx.ets @Entry @Component struct GaugeExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md index e0e7f9dd04f9f8bcf0e53422a13e644fb2af529b..29dfeb51fad9bed75a8fb34c33ed47a62e3ad166 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md @@ -1,13 +1,12 @@ # Image +图片组件,用来渲染展示图片。 + > **说明:** > > 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -图片组件,用来渲染展示图片。 - - ## 权限说明 使用网络图片时,需要在config.json文件对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。 @@ -32,11 +31,11 @@ Image(src: string | PixelMap | Resource) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | src | string\| [PixelMap](../apis/js-apis-image.md#pixelmap7)\| [Resource](../../ui/ts-types.md#resource类型) | 是 | - | 图片的数据源,支持本地图片和网络图片。
当使用相对路径引用图片资源时,例如`Image("common/test.jpg")`,不支持该Image组件被跨包/跨模块调用,建议使用`$r`方式来管理需全局使用的图片资源。
\- 支持的图片格式包括png、jpg、bmp、svg和gif。
\- 支持`Base64`字符串。格式`data:image/[png\|jpeg\|bmp\|webp];base64,[base64 data]`, 其中`[base64 data]`为`Base64`字符串数据。
\- 支持`dataability://`路径前缀的字符串,用于访问通过data ability提供的图片路径。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| src | string\| [PixelMap](../apis/js-apis-image.md#pixelmap7)\| [Resource](../../ui/ts-types.md#resource类型) | 是 | - | 图片的数据源,支持本地图片和网络图片。
当使用相对路径引用图片资源时,例如`Image("common/test.jpg")`,不支持该Image组件被跨包/跨模块调用,建议使用`$r`方式来管理需全局使用的图片资源。
\- 支持的图片格式包括png、jpg、bmp、svg和gif。
\- 支持`Base64`字符串。格式`data:image/[png\|jpeg\|bmp\|webp];base64,[base64 data]`, 其中`[base64 data]`为`Base64`字符串数据。
\- 支持`dataability://`路径前缀的字符串,用于访问通过data ability提供的图片路径。 | ## 属性 @@ -44,35 +43,37 @@ Image(src: string | PixelMap | Resource) | --------------------- | ---------------------------------------- | -------- | ---------------------------------------- | | alt | string \| [Resource](../../ui/ts-types.md#resource类型) | - | 加载时显示的占位图。支持本地图片和网络路径。 | | objectFit | ImageFit | Cover | 设置图片的缩放类型。 | -| objectRepeat | [ImageRepeat](ts-appendix-enums.md#imagerepeat枚举说明) | NoRepeat | 设置图片的重复样式。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - svg类型图源不支持该属性。 | -| interpolation | ImageInterpolation | None | 设置图片的插值效果,仅针对图片放大插值。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - svg类型图源不支持该属性。
> - PixelMap资源不支持该属性。 | -| renderMode | ImageRenderMode | Original | 设置图片渲染的模式。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - svg类型图源不支持该属性。 | -| sourceSize | {
width: number,
height: number
} | - | 设置图片解码尺寸,将原始图片解码成指定尺寸的图片,number类型单位为px。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> - PixelMap资源不支持该属性。 | +| objectRepeat | [ImageRepeat](ts-appendix-enums.md#imagerepeat枚举说明) | NoRepeat | 设置图片的重复样式。
>  **说明:**
> - svg类型图源不支持该属性。 | +| interpolation | ImageInterpolation | None | 设置图片的插值效果,仅针对图片放大插值。
>  **说明:**
> - svg类型图源不支持该属性。
> - PixelMap资源不支持该属性。 | +| renderMode | ImageRenderMode | Original | 设置图片渲染的模式。
>  **说明:**
> - svg类型图源不支持该属性。 | +| sourceSize | {
width: number,
height: number
} | - | 设置图片解码尺寸,将原始图片解码成指定尺寸的图片,number类型单位为px。
>  **说明:**
> - PixelMap资源不支持该属性。 | | syncLoad8+ | boolean | false | 设置是否同步加载图片,默认是异步加载。同步加载时阻塞UI线程,不会显示占位图。 | -- ImageFit枚举说明 - | 名称 | 描述 | - | --------- | ------------------------------------------------------------ | - | Cover | 保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。 | - | Contain | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。 | - | Fill | 不保持宽高比进行放大缩小,使得图片填充满显示边界。 | - | None | 保持原有尺寸显示。 | - | ScaleDown | 保持宽高比显示,图片缩小或者保持不变。 | - -- ImageInterpolation枚举说明 - | 名称 | 描述 | - | ------ | ------------------------ | - | None | 不使用插值图片数据。 | - | High | 高度使用插值图片数据,可能会影响图片渲染的速度。 | - | Medium | 中度使用插值图片数据。 | - | Low | 低度使用插值图片数据。 | - -- ImageRenderMode枚举说明 - | 名称 | 描述 | - | -------- | --------------------- | - | Original | 按照原图进行渲染,包括颜色。 | - | Template | 将图像渲染为模板图像,忽略图片的颜色信息。 | +## ImageFit枚举说明 + +| 名称 | 描述 | +| --------- | -------------------------------- | +| Cover | 保持宽高比进行缩小或者放大,使得图片两边都大于或等于显示边界。 | +| Contain | 保持宽高比进行缩小或者放大,使得图片完全显示在显示边界内。 | +| Fill | 不保持宽高比进行放大缩小,使得图片填充满显示边界。 | +| None | 保持原有尺寸显示。通常配合objectRepeat属性一起使用。 | +| ScaleDown | 保持宽高比显示,图片缩小或者保持不变。 | +## ImageInterpolation枚举说明 + +| 名称 | 描述 | +| ------ | ------------------------ | +| None | 不使用插值图片数据。 | +| High | 高度使用插值图片数据,可能会影响图片渲染的速度。 | +| Medium | 中度使用插值图片数据。 | +| Low | 低度使用插值图片数据。 | + +## ImageRenderMode枚举说明 + +| 名称 | 描述 | +| -------- | --------------------- | +| Original | 按照原图进行渲染,包括颜色。 | +| Template | 将图像渲染为模板图像,忽略图片的颜色信息。 | ## 事件 @@ -85,7 +86,7 @@ Image(src: string | PixelMap | Resource) ## 示例 -``` +```ts // Image1 @Entry @Component @@ -152,7 +153,7 @@ struct ImageExample1 { ![zh-cn_image_0000001250492613](figures/zh-cn_image_0000001250492613.gif) -``` +```ts // Image2 @Entry @Component @@ -221,7 +222,7 @@ struct ImageExample2 { ![zh-cn_image_0000001205812616](figures/zh-cn_image_0000001205812616.png) -``` +```ts // Image3 @Entry @Component diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md index 97f4c507e36d54fabc533fcabc2c905428d87064..13fb64f8858c854472706e0f8a16e59a025573a0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md @@ -1,11 +1,11 @@ # ImageAnimator -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供帧动画组件来实现逐帧播放图片的能力,可以配置需要播放的图片列表,每张图片可以配置时长。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -24,38 +24,39 @@ ImageAnimator() ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| images | Array<{
src:string,
width?:Length,
height?:Length,
top?:Length,
left?:Length,
duration?:number
}> | [] | 是 | 设置图片帧信息集合。每一帧的帧信息包含图片路径、图片大小、图片位置和图片播放时长信息。详细说明如下:
src:图片路径,图片格式为svg,png和jpg。
width:图片宽度。
height:图片高度。
top:图片相对于组件左上角的纵向坐标。
left:图片相对于组件左上角的横向坐标。
duration:每一帧图片的播放时长,单位毫秒。 | -| state | 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 | Forwards | 否 | 设置动画开始前和结束后的状态,可选值参见FillMode说明。 | -| iterations | number | 1 | 否 | 默认播放一次,设置为-1时表示无限次播放。 | - -- AnimationStatus枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Initial | 动画初始状态。 | - | Running | 动画处于播放状态。 | - | Paused | 动画处于暂停状态。 | - | Stopped | 动画处于停止状态。 | - -- FillMode枚举值说明 - | 名称 | 描述 | - | -------- | -------- | - | None | 播放完成后恢复初始状态。 | - | Forwards | 播放完成后保持动画结束时的状态。 | - +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ---------- | ---------------------------------------- | -------- | ---- | ---------------------------------------- | +| images | Array<{
src:string,
width?:Length,
height?:Length,
top?:Length,
left?:Length,
duration?:number
}> | [] | 是 | 设置图片帧信息集合。每一帧的帧信息包含图片路径、图片大小、图片位置和图片播放时长信息。详细说明如下:
src:图片路径,图片格式为svg,png和jpg。
width:图片宽度。
height:图片高度。
top:图片相对于组件左上角的纵向坐标。
left:图片相对于组件左上角的横向坐标。
duration:每一帧图片的播放时长,单位毫秒。 | +| state | 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 | Forwards | 否 | 设置动画开始前和结束后的状态,可选值参见FillMode说明。 | +| iterations | number | 1 | 否 | 默认播放一次,设置为-1时表示无限次播放。 | + +## AnimationStatus枚举说明 + +| 名称 | 描述 | +| ------- | --------- | +| Initial | 动画初始状态。 | +| Running | 动画处于播放状态。 | +| Paused | 动画处于暂停状态。 | +| Stopped | 动画处于停止状态。 | + +## FillMode枚举值说明 + +| 名称 | 描述 | +| -------- | ---------------- | +| None | 播放完成后恢复初始状态。 | +| Forwards | 播放完成后保持动画结束时的状态。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onStart() => void | 状态回调,动画开始播放时触发。 | -| onPause() => void | 状态回调,动画暂停播放时触发。 | +| 名称 | 功能描述 | +| ------------------------------- | --------------- | +| onStart() => void | 状态回调,动画开始播放时触发。 | +| onPause() => void | 状态回调,动画暂停播放时触发。 | | onRepeat() => void | 状态回调,动画重新播放时触发。 | | onCancel() => void | 状态回调,动画取消播放时触发。 | | onFinish() => void | 状态回调,动画播放完成时触发。 | @@ -63,7 +64,8 @@ ImageAnimator() ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ImageAnimatorExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md index a35332113e193f112b7caf3d1e500e31089786fe..3e8e70b1caad58f05fd12d719abda3c36cf0ce91 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md @@ -1,10 +1,11 @@ # LoadingProgress -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 用于显示加载进展。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -22,19 +23,17 @@ LoadingProgress() 创建加载进展组件。 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| color | Color | - | 设置加载进度条前景色。 | - +| 名称 | 参数类型 | 默认值 | 描述 | +| ----- | ----- | ---- | ----------- | +| color | Color | - | 设置加载进度条前景色。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct LoadingProgressExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md index 58b8028ca43048e4c2c9959c17607bf48154295a..144fb4fd695f8b3bcb672944aed86fbf6d42d4d3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md @@ -1,11 +1,11 @@ # Marquee - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +跑马灯组件,用于滚动展示一段单行文本,仅当文本内容宽度超过跑马灯组件宽度时滚动。 -跑马灯组件,用于滚动展示一段单行文本,仅当文本内容宽度超过跑马灯组件宽度时滚动。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -22,29 +22,30 @@ Marquee(value: { start: boolean, step?: number, loop?: number, fromStart?: boolean, src: string }) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | start | boolean | 是 | - | 控制是否进入播放状态。 | - | step | number | 否 | 6 | 滚动动画文本滚动步长。 | - | loop | number | 否 | -1 | 设置重复滚动的次数,小于等于零时无限循环。 | - | fromStart | boolean | 否 | true | 设置文本从头开始滚动或反向滚动。 | - | src | string | 是 | - | 需要滚动的文本。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ------- | ---- | ---- | --------------------- | +| start | boolean | 是 | - | 控制是否进入播放状态。 | +| step | number | 否 | 6 | 滚动动画文本滚动步长。 | +| loop | number | 否 | -1 | 设置重复滚动的次数,小于等于零时无限循环。 | +| fromStart | boolean | 否 | true | 设置文本从头开始滚动或反向滚动。 | +| src | string | 是 | - | 需要滚动的文本。 | ## 事件 - | 名称 | 功能描述 | -| -------- | -------- | -| onStart(callback: () => void) | 开始滚动时触发回调。 | -| onBounce(callback: () => void) | 滚动到底时触发回调。 | -| onFinish(callback: () => void) | 滚动完成时触发回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------- | +| onStart(callback: () => void) | 开始滚动时触发回调。 | +| onBounce(callback: () => void) | 滚动到底时触发回调。 | +| onFinish(callback: () => void) | 滚动完成时触发回调。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct MarqueeExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md index 60597c1d0da8a4c7f693aedbdde43dce537acbde..2e3d048fec8818c5e6d9f00f805f3ea794822858 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md @@ -1,11 +1,11 @@ # Navigation -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - Navigation组件一般作为Page页面的根容器,通过属性设置来展示页面的标题、工具栏、菜单。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -26,52 +26,55 @@ Navigation() ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| title | string \| [CustomBuilder](../../ui/ts-types.md)8+ | - | 页面标题。 | -| subtitle | string | - | 页面副标题。 | -| menus | Array8+ | - | 页面右上角菜单。 | -| titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 | -| toolBar | {
items:[
Object
] }
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | -| hideToolBar | boolean | false | 设置隐藏/显示工具栏:
true: 隐藏工具栏。
false: 显示工具栏。 | -| hideTitleBar | boolean | false | 隐藏标题栏。 | -| hideBackButton | boolean | false | 隐藏返回键。 | - -- NavigationMenuItem类型接口说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | string | 是 | - | 菜单栏单个选项的显示文本。 | - | icon | string | 否 | - | 菜单栏单个选项的图标资源路径。 | - | action | () => void | 否 | - | 当前选项被选中的事件回调。 | - -- Object类型接口说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | string | 是 | - | 工具栏单个选项的显示文本。 | - | icon | string | 否 | - | 工具栏单个选项的图标资源路径。 | - | action | () => void | 否 | - | 当前选项被选中的事件回调。 | - -- NavigationTitleMode枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Free | 当内容为可滚动组件时,标题随着内容向上滚动而缩小(子标题的大小不变、淡出)。向下滚动内容到顶时则恢复原样。 | - | Mini | 固定为小标题模式(图标+主副标题)。 | - | Full | 固定为大标题模式(主副标题)。 | - - > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** - > 目前可滚动组件只支持List。 - +| 名称 | 参数类型 | 默认值 | 描述 | +| -------------- | ---------------------------------------- | ------------------------ | ---------------------------------------- | +| title | string \| [CustomBuilder](../../ui/ts-types.md)8+ | - | 页面标题。 | +| subtitle | string | - | 页面副标题。 | +| menus | Array8+ | - | 页面右上角菜单。 | +| titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 | +| toolBar | {
items:[
Object
] }
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | +| hideToolBar | boolean | false | 设置隐藏/显示工具栏:
true: 隐藏工具栏。
false: 显示工具栏。 | +| hideTitleBar | boolean | false | 隐藏标题栏。 | +| hideBackButton | boolean | false | 隐藏返回键。 | + +## NavigationMenuItem类型说明 + +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ----------------------- | ---- | ---- | --------------- | +| value | string | 是 | - | 菜单栏单个选项的显示文本。 | +| icon | string | 否 | - | 菜单栏单个选项的图标资源路径。 | +| action | () => void | 否 | - | 当前选项被选中的事件回调。 | + +## Object类型接口说明 + +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ----------------------- | ---- | ---- | --------------- | +| value | string | 是 | - | 工具栏单个选项的显示文本。 | +| icon | string | 否 | - | 工具栏单个选项的图标资源路径。 | +| action | () => void | 否 | - | 当前选项被选中的事件回调。 | + +## NavigationTitleMode枚举说明 + +| 名称 | 描述 | +| ---- | ---------------------------------------- | +| Free | 当内容为可滚动组件时,标题随着内容向上滚动而缩小(子标题的大小不变、淡出)。向下滚动内容到顶时则恢复原样。 | +| Mini | 固定为小标题模式(图标+主副标题)。 | +| Full | 固定为大标题模式(主副标题)。 | + +> **说明:** +> +> 目前可滚动组件只支持List。 ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onTitleModeChange(callback: (titleMode: NavigationTitleMode) => void) | 当titleMode为NavigationTitleMode.Free时,随着可滚动组件的滑动标题栏模式发生变化时触发此回调。 | ## 示例 -``` +```ts // Example 01 @Entry @Component @@ -159,7 +162,7 @@ struct NavigationExample { ![zh-cn_image_0000001237616085](figures/zh-cn_image_0000001237616085.gif) -``` +```ts // Example 02 @Entry @Component diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md index df9c2087abf294646e0a884c6f24e395d7c9da71..a59d012b9064ab6bdd31e36b707118369a303103 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md @@ -1,11 +1,11 @@ # Progress -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 进度条,用于显示内容加载或操作处理进度。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -17,42 +17,43 @@ 无 -## 接口说明 +## 接口 Progress(value: {value: number, total?: number, type?: ProgressType}) 创建进度组件,用于显示内容加载或操作处理进度。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | number | 是 | - | 指定当前进度值。 | - | total | number | 否 | 100 | 指定进度总长。 | - | type | ProgressType | 否 | ProgressType.Linear | 指定进度条样式。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------------ | ---- | ------------------- | -------- | +| value | number | 是 | - | 指定当前进度值。 | +| total | number | 否 | 100 | 指定进度总长。 | +| type | ProgressType | 否 | ProgressType.Linear | 指定进度条样式。 | -- ProgressType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Linear | 线性样式。 | - | Ring8+ | 环形无刻度样式,环形圆环逐渐填充完成过程。 | - | Eclipse | 圆形样式,展现类似月圆月缺的进度展示效果,从月牙逐渐到满月的这个过程代表了下载的进度。 | - | ScaleRing8+ | 环形有刻度样式,类似时钟刻度形式加载进度。 | - | Capsule8+ | 胶囊样式,头尾两端处,进度条由弧形变成直线和直线变成弧形的过程;中段处,进度条正常往右走的过程。 | +## ProgressType枚举说明 +| 名称 | 描述 | +| ---------------------- | ---------------------------------------- | +| Linear | 线性样式。 | +| Ring8+ | 环形无刻度样式,环形圆环逐渐填充完成过程。 | +| Eclipse | 圆形样式,展现类似月圆月缺的进度展示效果,从月牙逐渐到满月的这个过程代表了下载的进度。 | +| ScaleRing8+ | 环形有刻度样式,类似时钟刻度形式加载进度。 | +| Capsule8+ | 胶囊样式,头尾两端处,进度条由弧形变成直线和直线变成弧形的过程;中段处,进度条正常往右走的过程。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| value | number | - | 设置当前进度值。 | -| color | Color | - | 设置进度条前景色。 | -| style8+ | {
strokeWidth?: Length,
scaleCount?: number,
scaleWidth?: Length
} | - | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时,刻度粗细为系统默认粗细。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------------------ | ---------------------------------------- | ---- | ---------------------------------------- | +| value | number | - | 设置当前进度值。 | +| color | Color | - | 设置进度条前景色。 | +| style8+ | {
strokeWidth?: Length,
scaleCount?: number,
scaleWidth?: Length
} | - | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时,刻度粗细为系统默认粗细。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ProgressExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md index 12c56374fd3726415f7d99046bdd74f2bd931b17..e09b973bdb962fcfc1c8076c7e7f4072f4959b1a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md @@ -1,11 +1,11 @@ # QRCode -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 显示二维码信息。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,27 +21,28 @@ QRCode(value: string) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | string | 是 | - | 二维码内容字符串。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | --------- | +| value | string | 是 | - | 二维码内容字符串。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| color | Color | Black | 设置二维码颜色。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----- | ----- | ----- | -------- | +| color | Color | Black | 设置二维码颜色。 | ## 事件 -通用事件仅支持点击事件。 +通用事件仅支持[点击事件](ts-universal-events-click.md)。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct QRCodeExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md index a7a5f71f2122905ec95d5b8b0b8e0f80fa82bbb3..bfc9e434f0e63eab55c932677a7f138e0b2415bf 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md @@ -1,11 +1,11 @@ # Radio -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 单选框,提供相应的用户交互选择项。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,30 +21,31 @@ Radio(options: {value: string, group: string}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | string | 是 | - | 当前单选框的值。| - | group | string | 是 | - | 当前单选框的所属群组名称,相同group的Radio只能有一个被选中。| +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | ----------------------------------- | +| value | string | 是 | - | 当前单选框的值。 | +| group | string | 是 | - | 当前单选框的所属群组名称,相同group的Radio只能有一个被选中。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| checked | boolean | false | 设置单选框的选中状态。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------- | ------- | ----- | ----------- | +| checked | boolean | false | 设置单选框的选中状态。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange(callback: (value: boolean) => void) | 单选框选中状态改变时触发回调。
-value为true时,代表选中。
-value为false时,代表未选中。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onChange(callback: (value: boolean) => void) | 单选框选中状态改变时触发回调。
-value为true时,代表选中。
-value为false时,代表未选中。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct RadioExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md index 11bda78b91d1791aa5d2f5eecc444b0c837c723a..b0d8a27c651f520a252315d9edcf5df63e4b472a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-rating.md @@ -1,11 +1,11 @@ # Rating -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 评分条组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -17,36 +17,37 @@ 无 -## 接口说明 +## 接口 Rating(options?: { rating: number, indicator?: boolean }) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | rating | number | 是 | 0 | 设置并接收评分值。 | - | indicator | boolean | 否 | false | 仅作为指示器使用,不可操作。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ------- | ---- | ----- | -------------- | +| rating | number | 是 | 0 | 设置并接收评分值。 | +| indicator | boolean | 否 | false | 仅作为指示器使用,不可操作。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| stars | number | 5 | 设置评星总数。 | -| stepSize | number | 0.5 | 操作评级的步长。 | -| starStyle | {
backgroundUri: string,
foregroundUri: string,
secondaryUri?: string
} | - | backgroundSrc:未选中的星级的图片链接,可由用户自定义或使用系统默认图片,仅支持本地。
foregroundSrc:选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。
secondarySrc:部分选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| --------- | ---------------------------------------- | ---- | ---------------------------------------- | +| stars | number | 5 | 设置评星总数。 | +| stepSize | number | 0.5 | 操作评级的步长。 | +| starStyle | {
backgroundUri: string,
foregroundUri: string,
secondaryUri?: string
} | - | backgroundSrc:未选中的星级的图片链接,可由用户自定义或使用系统默认图片,仅支持本地。
foregroundSrc:选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。
secondarySrc:部分选中的星级的图片路径,可由用户自定义或使用系统默认图片,仅支持本地。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange(callback:(value: number) => void) | 操作评分条的评星发生改变时触发该回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ------------------- | +| onChange(callback:(value: number) => void) | 操作评分条的评星发生改变时触发该回调。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct RatingExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md index 8665726da62968a9a44e71b1ba6b4f76781e52b6..2df3918ecbe9a621c98a58525b18643e7789c947 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md @@ -1,10 +1,11 @@ # RichText -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 富文本组件,解析并显示HTML格式文本。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 无 @@ -15,41 +16,40 @@ ## 接口 -RichText\(content:string\) +RichText\(content: string\) -- 参数 +**参数:** - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | content | string | 是 | - | 表示HTML格式的字符串。 | - +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ------ | ---- | ---- | ------------- | +| content | string | 是 | - | 表示HTML格式的字符串。 | ## 事件 - -| 名称 | 描述 | -| -------- | -------- | -| onStart() => void | 加载网页时触发。 | +| 名称 | 描述 | +| -------------------- | ---------- | +| onStart() => void | 加载网页时触发。 | | onComplete() => void | 网页加载结束时触发。 | ## 支持标签 -| 名称 | 描述 | 示例 | -| -------- | -------- | -------- | -| \

--\

| 被用来定义HTML,\

定义重要等级最高的标题,\

定义重要等级最低的标题。 | \

这是一个标题\

\

这是h2标题\

| -| \

\

| 定义段落。 | \

这是一个段落\

| -| \
| 插入一个简单的换行符。 | \

这是一个段落\
这是换行段落\

| -| \
| 定义HTML页面中的主题变化(比如话题的转移),并显示为一条水平线。 | \

这个一个段落\

\
\

这是一个段落\

| -| \
\
| 常用于组合块级元素,以便通过CSS来对这些元素进行格式化。 | \
\

这是一个在div元素中的标题。\

\
| -| \\ | 定义与文本中其余部分不同的部分,并把这部分文本呈现为斜体文本。 | \这是一个斜体\ | -| \\ | 定义与常规文本风格不同的文本,像拼写错误的单词或者汉语中的专有名词,应尽量避免使用\为文本加下划线,用户会把它混淆为一个超链接。 | \

\这是带有下划线的段落\\

| -| \ | 定义HTML文档的样式信息。 | \ | -| style | 属性规定元素的行内样式,写在标签内部,在使用的时候需用引号来进行区分,并以; 间隔样式,style='width: 500px;height: 500px;border: 1px soild;margin: 0 auto;'。 | \

这是一个标题\

\

这是一个段落。\

| -| \ | 用于定义客户端文本,比如JavaScript。 | \ | +| 名称 | 描述 | 示例 | +| ------------------- | ---------------------------------------- | ---------------------------------------- | +| \

--\

| 被用来定义HTML,\

定义重要等级最高的标题,\

定义重要等级最低的标题。 | \

这是一个标题\

\

这是h2标题\

| +| \

\

| 定义段落。 | \

这是一个段落\

| +| \
| 插入一个简单的换行符。 | \

这是一个段落\
这是换行段落\

| +| \
| 定义HTML页面中的主题变化(比如话题的转移),并显示为一条水平线。 | \

这个一个段落\

\
\

这是一个段落\

| +| \
\
| 常用于组合块级元素,以便通过CSS来对这些元素进行格式化。 | \
\

这是一个在div元素中的标题。\

\
| +| \\ | 定义与文本中其余部分不同的部分,并把这部分文本呈现为斜体文本。 | \这是一个斜体\ | +| \\ | 定义与常规文本风格不同的文本,像拼写错误的单词或者汉语中的专有名词,应尽量避免使用\为文本加下划线,用户会把它混淆为一个超链接。 | \

\这是带有下划线的段落\\

| +| \ | 定义HTML文档的样式信息。 | \ | +| style | 属性规定元素的行内样式,写在标签内部,在使用的时候需用引号来进行区分,并以; 间隔样式,style='width: 500px;height: 500px;border: 1px soild;margin: 0 auto;'。 | \

这是一个标题\

\

这是一个段落。\

| +| \ | 用于定义客户端文本,比如JavaScript。 | \ | ## 示例 示例效果请以真机运行为准,当前IDE预览器不支持。 -``` +```ts +// xxx.ets @Entry @Component struct RichTextExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md index fb2139c20442965793177da3f7d258ae979bf22e..13438fb94402aae10fc7d76c9eae897ca78526be 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md @@ -1,11 +1,11 @@ # ScrollBar -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 滚动条组件ScrollBar,用于配合可滚动组件使用,如List、Grid、Scroll。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,35 +21,38 @@ ScrollBar(value: ScrollBarOptions) -- ScrollBarOptions的参数描述 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | scroller | [Scroller](ts-container-scroll.md#scroller) | 是 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | - | direction | ScrollBarDirection | 否 | ScrollBarDirection.Vertical | 滚动条的方向,控制可滚动组件对应方向的滚动。 | - | state | BarState | 否 | BarState.Auto | 滚动条状态。 | +**参数:** - > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** - > ScrollBar组件负责定义可滚动区域的行为样式,ScrollBar的子节点负责定义滚动条的行为样式。 - > - > 滚动条组件与可滚动组件通过Scroller进行绑定,且只有当两者方向相同时,才能联动,ScrollBar与可滚动组件仅支持一对一绑定。 +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ---------------------------------------- | ---- | --------------------------- | ----------------------- | +| scroller | [Scroller](ts-container-scroll.md#scroller) | 是 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | +| direction | ScrollBarDirection | 否 | ScrollBarDirection.Vertical | 滚动条的方向,控制可滚动组件对应方向的滚动。 | +| state | BarState | 否 | BarState.Auto | 滚动条状态。 | -- ScrollBarDirection枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Vertical | 纵向滚动条。 | - | Horizontal | 横向滚动条。 | +> **说明:** +> ScrollBar组件负责定义可滚动区域的行为样式,ScrollBar的子节点负责定义滚动条的行为样式。 +> +> 滚动条组件与可滚动组件通过Scroller进行绑定,且只有当两者方向相同时,才能联动,ScrollBar与可滚动组件仅支持一对一绑定。 -- BarState枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | On | 常驻显示。 | - | Off | 不显示。 | - | Auto | 按需显示(触摸时显示,无操作2s后消失)。 | +## ScrollBarDirection枚举说明 +| 名称 | 描述 | +| ---------- | ------ | +| Vertical | 纵向滚动条。 | +| Horizontal | 横向滚动条。 | + +## BarState枚举说明 + +| 名称 | 描述 | +| ---- | --------------------- | +| On | 常驻显示。 | +| Off | 不显示。 | +| Auto | 按需显示(触摸时显示,无操作2s后消失)。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ScrollBarExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md index 4213712676b501c3fcb3090ce10dd7b0c96d0664..a7fd51486f1c17214da1f8bbef33f5720cf87f90 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md @@ -1,11 +1,11 @@ # Search -> ![](public_sys-resources/icon-note.gif) **说明:** +提供搜索框组件,用于提供用户搜索内容的输入区域。 + +> **说明:** > > 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -提供搜索框组件,用于提供用户搜索内容的输入区域。 - ## 权限列表 无 @@ -18,15 +18,14 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controller?: SearchController }) -- 参数 - - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----------- | ---------------- | ---- | ---- | ---------------------------------------- | - | value | string | 否 | - | 搜索文本值。 | - | placeholder | string | 否 | - | 无输入时的提示文本。 | - | icon | string | 否 | - | 搜索图标路径,默认使用系统搜索图标,支持的图标格式: svg, jpg和png。 | - | controller | SearchController | 否 | - | 控制器。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----------- | ---------------- | ---- | ---- | ---------------------------------------- | +| value | string | 否 | - | 搜索文本值。 | +| placeholder | string | 否 | - | 无输入时的提示文本。 | +| icon | string | 否 | - | 搜索图标路径,默认使用系统搜索图标,支持的图标格式: svg, jpg和png。 | +| controller | SearchController | 否 | - | 控制器。 | ## 属性 @@ -61,17 +60,17 @@ caretPosition(value: number): viod 设置输入光标的位置。 -- 参数 - - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ------ | ---- | ---- | ----------------- | - | value | number | 是 | - | 从字符串开始到光标所在位置的长度。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | ----------------- | +| value | number | 是 | - | 从字符串开始到光标所在位置的长度。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct SearchExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md index a1f366c42fe071b4bda667e12765f8b468355090..967f5005cdd6894909939e4b03e110cfe5a38467 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md @@ -1,9 +1,11 @@ # Select -> ![](public_sys-resources/icon-note.gif) **说明:** 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 提供下拉选择菜单,可以让用户在多个选项之间选择。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 无 @@ -16,37 +18,38 @@ Select(options: Array\) -- SelectOption参数 +**参数:** - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ------ | ----------------------------------------------- | ---- | ------ | -------------- | - | value | [ResourceStr](../../ui/ts-types.md) | 是 | - | 下拉选项内容。 | - | icon | [ResourceStr](../../ui/ts-types.md) | 否 | - | 下拉选项图片。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ----------------------------------- | ---- | ---- | ------- | +| value | [ResourceStr](../../ui/ts-types.md) | 是 | - | 下拉选项内容。 | +| icon | [ResourceStr](../../ui/ts-types.md) | 否 | - | 下拉选项图片。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------------- | --------------------------------------------------- | ------ | ----------------------------------------------- | -| selected | number | - | 设置下拉菜单初始选择项的索引,第一项的索引为0。 | -| value | string | - | 设置下拉按钮本身的文本显示。 | -| font | [Font](../../ui/ts-types.md) | - | 设置下拉按钮本身的文本样式: | -| fontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉按钮本身的文本颜色。 | -| selectedOptionBgColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单选中项的背景色。 | -| selectedOptionFont | [Font](../../ui/ts-types.md) | - | 设置下拉菜单选中项的文本样式: | -| selectedOptionFontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单选中项的文本颜色。 | -| optionBgColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单项的背景色。 | -| optionFont | [Font](../../ui/ts-types.md) | - | 设置下拉菜单项的文本样式: | -| optionFontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单项的文本颜色。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------------- | ------------------------------------- | ---- | ------------------------ | +| selected | number | - | 设置下拉菜单初始选择项的索引,第一项的索引为0。 | +| value | string | - | 设置下拉按钮本身的文本显示。 | +| font | [Font](../../ui/ts-types.md) | - | 设置下拉按钮本身的文本样式: | +| fontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉按钮本身的文本颜色。 | +| selectedOptionBgColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单选中项的背景色。 | +| selectedOptionFont | [Font](../../ui/ts-types.md) | - | 设置下拉菜单选中项的文本样式: | +| selectedOptionFontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单选中项的文本颜色。 | +| optionBgColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单项的背景色。 | +| optionFont | [Font](../../ui/ts-types.md) | - | 设置下拉菜单项的文本样式: | +| optionFontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单项的文本颜色。 | ## 事件 -| 名称 | 功能描述 | -| ----------------------------------------------------------- | ------------------------------------------------------------ | +| 名称 | 功能描述 | +| ---------------------------------------- | -------------------------------------- | | onSelect(callback: (index: number, value?:string) => void) | 下拉菜单选中某一项的回调。index:选中项的索引。value:选中项的值。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct SelectExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md index da380038151e1f42799664637556ddf2c1d2e62e..e52fc7d9753a4203ccdf32a939e01f696e0f6786 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md @@ -1,11 +1,11 @@ # Slider -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 滑动条组件,用来快速调节设置值,如音量、亮度等。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,56 +21,58 @@ Slider(value:{value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | number | 否 | 0 | 当前进度值。 | - | min | number | 否 | 0 | 设置最小值。 | - | max | number | 否 | 100 | 设置最大值。 | - | step | number | 否 | 1 | 设置Slider滑动跳动值,当设置相应的step时,Slider为间歇滑动。 | - | style | SliderStyle | 否 | SliderStyle.OutSet | 设置Slider的滑块样式。 | - | direction8+ | [Axis](ts-appendix-enums.md#axis枚举说明) | 否 | Axis.Horizontal | 设置滑动条滑动方向为水平或竖直方向。 | - | reverse8+ | boolean | 否 | false | 设置滑动条取值范围是否反向。 | +**参数:** -- SliderStyle枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | OutSet | 滑块在滑轨上。 | - | InSet | 滑块在滑轨内。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---------------------- | ------------------------------------- | ---- | ------------------ | -------------------------------------- | +| value | number | 否 | 0 | 当前进度值。 | +| min | number | 否 | 0 | 设置最小值。 | +| max | number | 否 | 100 | 设置最大值。 | +| step | number | 否 | 1 | 设置Slider滑动跳动值,当设置相应的step时,Slider为间歇滑动。 | +| style | SliderStyle | 否 | SliderStyle.OutSet | 设置Slider的滑块样式。 | +| direction8+ | [Axis](ts-appendix-enums.md#axis枚举说明) | 否 | Axis.Horizontal | 设置滑动条滑动方向为水平或竖直方向。 | +| reverse8+ | boolean | 否 | false | 设置滑动条取值范围是否反向。 | +## SliderStyle枚举说明 + +| 名称 | 描述 | +| ------ | ------- | +| OutSet | 滑块在滑轨上。 | +| InSet | 滑块在滑轨内。 | ## 属性 不支持触摸热区设置。 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| blockColor | Color | - | 设置滑块的颜色。 | -| trackColor | Color | - | 设置滑轨的背景颜色。 | -| selectedColor | Color | - | 设置滑轨的已滑动颜色。 | -| showSteps | boolean | false | 设置当前是否显示步长刻度值。 | -| showTips | boolean | false | 设置滑动时是否显示气泡提示百分比。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------------- | ------- | ----- | ----------------- | +| blockColor | Color | - | 设置滑块的颜色。 | +| trackColor | Color | - | 设置滑轨的背景颜色。 | +| selectedColor | Color | - | 设置滑轨的已滑动颜色。 | +| showSteps | boolean | false | 设置当前是否显示步长刻度值。 | +| showTips | boolean | false | 设置滑动时是否显示气泡提示百分比。 | ## 事件 通用事件仅支持:OnAppear,OnDisAppear。 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onChange(callback: (value: number, mode: SliderChangeMode) => void) | Slider滑动时触发事件回调。
value:当前进度值。
mode:拖动状态。 | -- SliderChangeMode枚举说明 - | 名称 | 值 | 描述 | - | -------- | -------- | -------- | - | Begin | 0 | 用户开始拖动滑块。 | - | Moving | 1 | 用户拖动滑块中。 | - | End | 2 | 用户结束拖动滑块。 | +## SliderChangeMode枚举说明 +| 名称 | 值 | 描述 | +| ------ | ---- | --------- | +| Begin | 0 | 用户开始拖动滑块。 | +| Moving | 1 | 用户拖动滑块中。 | +| End | 2 | 用户结束拖动滑块。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct SliderExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md index ca29204c7a19c79ff353057ed7a45b3a7bbef05e..4e2b4d72755d45bd7251e56cf3f42ef684bb370f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md @@ -1,11 +1,11 @@ # Span -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 文本段落,只能作为Text子组件,呈现一段文本信息。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,33 +21,34 @@ Span(content: string) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | content | string | 是 | - | 文本内容。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ------ | ---- | ---- | ----- | +| content | string | 是 | - | 文本内容。 | ## 属性 通用属性方法仅支持通用文本样式,不支持触摸热区设置。 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------- | ---------------------------------------- | ---------------------------------------- | -------------- | | decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: Color
} | {
type: TextDecorationType.None
color:Color.Black
} | 设置文本装饰线样式及其颜色。 | -| textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | Normal | 设置文本大小写。 | +| textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | Normal | 设置文本大小写。 | ## 事件 通用事件仅支持点击事件。 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 由于Span组件无尺寸信息,因此点击事件返回的ClickEvent对象的target属性无效。 +> **说明:** +> 由于Span组件无尺寸信息,因此点击事件返回的ClickEvent对象的target属性无效。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct SpanExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md index 9899f76f8d5abdaed32be48cc45a80bed4e3c2c3..5a6114086383a19ed245c9baab871b2691f30bf5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md @@ -1,11 +1,11 @@ # Stepper - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +步骤导航器。 -步骤导航器。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -22,12 +22,11 @@ Stepper(value?: { index?: number }) +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | index | number | 否 | 0 | 设置步骤导航器显示第几个StepperItem。 | - +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | ------------------------ | +| index | number | 否 | 0 | 设置步骤导航器显示第几个StepperItem。 | ## 属性 @@ -36,16 +35,17 @@ Stepper(value?: { index?: number }) ## 事件 - | 名称 | 描述 | -| -------- | -------- | -| onFinish(callback: () => void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调 。 | -| onSkip(callback: () => void) | 当前显示的StepperItem状态为ItemState.Skip时,nextLabel被点击时触发该回调。 | -| onChange(callback: (prevIndex?: number, index?: number) => void) | 点击左边或者右边文本按钮进行步骤切换时触发该事件。
- prevIndex:切换前的步骤页索引值。
- index:切换后的步骤页(前一页或者下一页)索引值。 | +| 名称 | 描述 | +| ---------------------------------------- | ---------------------------------------- | +| onFinish(callback: () => void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调 。 | +| onSkip(callback: () => void) | 当前显示的StepperItem状态为ItemState.Skip时,nextLabel被点击时触发该回调。 | +| onChange(callback: (prevIndex?: number, index?: number) => void) | 点击左边或者右边文本按钮进行步骤切换时触发该事件。
- prevIndex:切换前的步骤页索引值。
- index:切换后的步骤页(前一页或者下一页)索引值。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct StepperExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md index 223996522947d688231c451884b81f258f80d0b8..3489c498f04106e62f7f06b2e2eb6759d2f73551 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepperitem.md @@ -1,11 +1,11 @@ # StepperItem - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +步骤导航器元素。 -步骤导航器元素。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -25,20 +25,20 @@ StepperItem() ## 属性 -| 参数名 | 参数类型 | 默认值 | 参数描述 | -| -------- | -------- | -------- | -------- | -| prevLabel | string | - | 当步骤导航器大于一页,除第一页默认值都为"返回"。 | -| nextLabel | string | - | 步骤导航器大于一页时,最后一页默认值为"开始",其余页默认值为"下一步"。 | -| status | ItemState | ItemState.Normal | 步骤导航器元素的状态。 | +| 参数名 | 参数类型 | 默认值 | 参数描述 | +| --------- | --------- | ---------------- | ------------------------------------- | +| prevLabel | string | - | 当步骤导航器大于一页,除第一页默认值都为"返回"。 | +| nextLabel | string | - | 步骤导航器大于一页时,最后一页默认值为"开始",其余页默认值为"下一步"。 | +| status | ItemState | ItemState.Normal | 步骤导航器元素的状态。 | -- ItemState枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Normal | 正常状态,右侧文本按钮正常显示,可点击进入下一个StepperItem。 | - | Disabled | 不可用状态,右侧文本按钮灰度显示,不可点击进入下一个StepperItem。 | - | Waiting | 等待状态,右侧文本按钮不显示,使用等待进度条,不可点击进入下一个StepperItem。 | - | Skip | 跳过状态,表示跳过当前步骤, 进入下一个StepperItem。 | +## ItemState枚举说明 +| 名称 | 描述 | +| -------- | ---------------------------------------- | +| Normal | 正常状态,右侧文本按钮正常显示,可点击进入下一个StepperItem。 | +| Disabled | 不可用状态,右侧文本按钮灰度显示,不可点击进入下一个StepperItem。 | +| Waiting | 等待状态,右侧文本按钮不显示,使用等待进度条,不可点击进入下一个StepperItem。 | +| Skip | 跳过状态,表示跳过当前步骤, 进入下一个StepperItem。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md index d5e17b66960f05e500ccd08dfe5722000e3863d3..67b5cd2d81a9773e9627257c0861a4d9055e4d86 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md @@ -1,11 +1,11 @@ # Text -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 文本,用于呈现一段信息。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,60 +21,66 @@ Text(content?: string) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | content | string | 否 | '' | 文本内容。包含子组件Span时不生效,显示Span内容,并且此时text组件的样式不生效。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ------ | ---- | ---- | ---------------------------------------- | +| content | string | 否 | '' | 文本内容。包含子组件Span时不生效,显示Span内容,并且此时text组件的样式不生效。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| textAlign | TextAlign | TextAlign.Start | 设置多行文本的文本对齐方式。 | -| textOverflow | {overflow: TextOverflow} | {overflow: TextOverflow.Clip} | 设置文本超长时的显示方式。
**说明:**
文本截断是按字截断。例如,英文以单词为最小单位进行截断,若需要以字母为单位进行截断,可在字母间添加零宽空格:\u200B。 | -| maxLines | number | Infinity | 设置文本的最大行数。 | -| lineHeight | Length | - | 设置文本的文本行高,设置值不大于0时,不限制文本行高,自适应字体大小,Length为number类型时单位为fp。 | -| decoration | {
type: TextDecorationType,
color?: Color
} | {
type: TextDecorationType.None,
color:Color.Black
} | 设置文本装饰线样式及其颜色。 | -| baselineOffset | Length | - | 设置文本基线的偏移量。 | -| textCase | TextCase | TextCase.Normal | 设置文本大小写。 | - -- TextAlign枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Center | 文本居中对齐。 | - | Start | 根据文字书写相同的方向对齐。 | - | End | 根据文字书写相反的方向对齐。 | - -- TextOverflow枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Clip | 文本超长时进行裁剪显示。 | - | Ellipsis | 文本超长时显示不下的文本用省略号代替。 | - | None | 文本超长时不进行裁剪。 | - -- TextDecorationType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Underline | 文字下划线修饰。 | - | LineThrough | 穿过文本的修饰线。 | - | Overline | 文字上划线修饰。 | - | None | 不使用文本装饰线。 | - -- TextCase枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Normal | 保持文本原有大小写。 | - | LowerCase | 文本采用全小写。 | - | UpperCase | 文本采用全大写。 | - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 不支持Text内同时存在文本内容和Span子组件。(如果同时存在,只显示Span内的内容)。 +| 名称 | 参数类型 | 默认值 | 描述 | +| -------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| textAlign | TextAlign | TextAlign.Start | 设置多行文本的文本对齐方式。 | +| textOverflow | {overflow: TextOverflow} | {overflow: TextOverflow.Clip} | 设置文本超长时的显示方式。
**说明:**
文本截断是按字截断。例如,英文以单词为最小单位进行截断,若需要以字母为单位进行截断,可在字母间添加零宽空格:\u200B。 | +| maxLines | number | Infinity | 设置文本的最大行数。 | +| lineHeight | Length | - | 设置文本的文本行高,设置值不大于0时,不限制文本行高,自适应字体大小,Length为number类型时单位为fp。 | +| decoration | {
type: TextDecorationType,
color?: Color
} | {
type: TextDecorationType.None,
color:Color.Black
} | 设置文本装饰线样式及其颜色。 | +| baselineOffset | Length | - | 设置文本基线的偏移量。 | +| textCase | TextCase | TextCase.Normal | 设置文本大小写。 | + +## TextAlign枚举说明 + +| 名称 | 描述 | +| ------ | -------------- | +| Center | 文本居中对齐。 | +| Start | 根据文字书写相同的方向对齐。 | +| End | 根据文字书写相反的方向对齐。 | + +## TextOverflow枚举说明 + +| 名称 | 描述 | +| -------- | ------------------- | +| Clip | 文本超长时进行裁剪显示。 | +| Ellipsis | 文本超长时显示不下的文本用省略号代替。 | +| None | 文本超长时不进行裁剪。 | + +## TextDecorationType枚举说明 + +| 名称 | 描述 | +| ----------- | --------- | +| Underline | 文字下划线修饰。 | +| LineThrough | 穿过文本的修饰线。 | +| Overline | 文字上划线修饰。 | +| None | 不使用文本装饰线。 | + +## TextCase枚举说明 + +| 名称 | 描述 | +| --------- | ---------- | +| Normal | 保持文本原有大小写。 | +| LowerCase | 文本采用全小写。 | +| UpperCase | 文本采用全大写。 | + +> **说明:** +> +> 不支持Text内同时存在文本内容和Span子组件。(如果同时存在,只显示Span内的内容)。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TextExample1 { @@ -112,7 +118,8 @@ struct TextExample1 { ![zh-cn_image_0000001219864155](figures/zh-cn_image_0000001219864155.gif) -``` +```ts +// xxx.ets @Entry @Component struct TextExample2 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md index 4198db7e5be91587fb5a41102494ed813eb3c43f..29e933a4abd389b274782c150737d6763005550e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md @@ -1,11 +1,11 @@ # TextArea -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供多行文本输入组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,12 +21,12 @@ TextArea(value?:{placeholder?: string, controller?: TextAreaController}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----------------------- | ---------------------------------------- | ---- | ---- | -------------- | - | placeholder | string | 否 | - | 无输入时的提示文本。 | - | controller8+ | [TextAreaController](#textareacontroller8) | 否 | - | 设置TextArea控制器。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----------------------- | ---------------------------------------- | ---- | ---- | -------------- | +| placeholder | string | 否 | - | 无输入时的提示文本。 | +| controller8+ | [TextAreaController](#textareacontroller8) | 否 | - | 设置TextArea控制器。 | ## 属性 @@ -40,13 +40,13 @@ TextArea(value?:{placeholder?: string, controller?: TextAreaController}) | caretColor | Color | - | 设置输入框光标颜色。 | | inputFilter8+ | {
value: [ResourceStr](../../ui/ts-types.md)8+,
error?: (value: string)
} | - | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示,不满足的输入被忽略。仅支持单个字符匹配,不支持字符串匹配。例如:^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$,不支持过滤8到10位的强密码。
- value:设置正则表达式。
- error:正则匹配失败时,返回被忽略的内容。 | -- TextAlign枚举说明 - | 名称 | 描述 | - | ------ | ------- | - | Start | 水平对齐首部。 | - | Center | 水平居中对齐。 | - | End | 水平对齐尾部。 | +## TextAlign枚举说明 +| 名称 | 描述 | +| ------ | ------- | +| Start | 水平对齐首部。 | +| Center | 水平居中对齐。 | +| End | 水平对齐尾部。 | ## 事件 @@ -74,18 +74,19 @@ caretPosition(value: number): void 设置输入光标的位置。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ------ | ---- | ---- | ------------------- | - | value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | ------------------- | +| value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 | ## 示例 ### 多行文本输入 -``` +```ts +// xxx.ets @Entry @Component struct TextAreaExample1 { @@ -122,7 +123,8 @@ struct TextAreaExample1 { ### 设置光标 -``` +```ts +// xxx.ets @Entry @Component struct TextAreaExample2 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md index bc07a54dc0468749fceea7586b6ad2bd02c4e264..c6d2e4543a5572a8c64cbbb5f91e579cd330767d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md @@ -1,9 +1,11 @@ # TextClock -> ![](public_sys-resources/icon-note.gif) **说明:** 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - TextClock通过文本显示当前系统时间,支持不同时区的时间显示,时间显示最高精度到秒级。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 无 @@ -16,23 +18,23 @@ TextClock通过文本显示当前系统时间,支持不同时区的时间显 TextClock(options?: {timeZoneOffset?: number, contorller?: TextClockController}) -- 参数 +**参数:** - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | ---- | ------------------ | ------------------------------------------------------------ | - | timeZoneOffset | number | 否 | 时区偏移量 | 设置时区偏移量。取值范围为[-14, 12],表示东十二区到西十二区,其中负值表示东时区,正值表示西时区,比如东八区为-8;对横跨国际日界线的国家或地区,用-13(UTC+13)和-14(UTC+14)来保证整个国家或者区域处在相同的时间。 | - | contorller | [TextClockContorller](#TextClockController) | 否 | null | 绑定一个控制器,用来控制文本时钟的状态。| +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------------- | ---------------------------------------- | ---- | ----- | ---------------------------------------- | +| timeZoneOffset | number | 否 | 时区偏移量 | 设置时区偏移量。取值范围为[-14, 12],表示东十二区到西十二区,其中负值表示东时区,正值表示西时区,比如东八区为-8;对横跨国际日界线的国家或地区,用-13(UTC+13)和-14(UTC+14)来保证整个国家或者区域处在相同的时间。 | +| contorller | [TextClockContorller](#TextClockController) | 否 | null | 绑定一个控制器,用来控制文本时钟的状态。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ------ | -------- | -------- | ------------------------------------------------------------ | -| format | string | 'hhmmss' | 设置显示时间格式,如“yyyy/mm/dd”、“yyyy-mm-dd”等。支持的时间格式化字符串:
  • yyyy(年份)
  • mm(英文月份简写)
  • mmm(英文月份简写)
  • mmmm(英文月份全称)
  • dd(英文星期简写)
  • ddd(英文星期简写)
  • dddd(英文星期全称)
  • HH(24小时制)
  • hh(12小时制)
  • MM/mm(分钟)
  • SS/ss(秒)
| +| 名称 | 参数类型 | 默认值 | 描述 | +| ------ | ------ | -------- | ---------------------------------------- | +| format | string | 'hhmmss' | 设置显示时间格式,如“yyyy/mm/dd”、“yyyy-mm-dd”等。支持的时间格式化字符串:
  • yyyy(年份)
  • mm(英文月份简写)
  • mmm(英文月份简写)
  • mmmm(英文月份全称)
  • dd(英文星期简写)
  • ddd(英文星期简写)
  • dddd(英文星期全称)
  • HH(24小时制)
  • hh(12小时制)
  • MM/mm(分钟)
  • SS/ss(秒)
| ## 事件 -| 名称 | 功能描述 | -| -------------------------------------------- | ------------------------------------------------------------ | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onDateChange(event: (value: number) => void) | 提供时间变化回调,该事件最小回调间隔为秒。
value: Unix Time Stamp,即自1970年1月1日(UTC)起经过的毫秒数。 | ## TextClockController @@ -61,7 +63,8 @@ stop() ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct Second { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md index fbcf06c14522788f37289633f844ef4f5de7429c..1c3c5f252beb866fc0d6485a2344aae1d39e2119 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md @@ -1,11 +1,11 @@ # TextInput -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供单行文本输入组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,12 +21,12 @@ TextInput(value?:{placeholder?: string controller?: TextInputController}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----------------------- | ---------------------------------------- | ---- | ---- | --------------- | - | placeholder | string | 否 | - | 无输入时的提示文本。 | - | controller8+ | [TextInputController](#textinputcontroller8) | 否 | - | 设置TextInput控制器。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----------------------- | ---------------------------------------- | ---- | ---- | --------------- | +| placeholder | string | 否 | - | 无输入时的提示文本。 | +| controller8+ | [TextInputController](#textinputcontroller8) | 否 | - | 设置TextInput控制器。 | ## 属性 @@ -42,23 +42,24 @@ TextInput(value?:{placeholder?: string controller?: TextInputController}) | maxLength | number | - | 设置文本的最大输入字符数。 | | inputFilter8+ | {
value: [ResourceStr](../../ui/ts-types.md)8+,
error?: (value: string)
} | - | 正则表达式,满足表达式的输入允许显示,不满足正则表达式的输入被忽略。仅支持单个字符匹配,不支持字符串匹配。例如:^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$,8到10位的强密码不支持过滤。
- value:设置正则表达式。
- error:正则匹配失败时,返回被忽略的内容。 | -- EnterKeyType枚举说明 - | 名称 | 描述 | - | ------------------- | --------- | - | EnterKeyType.Go | 显示Go文本。 | - | EnterKeyType.Search | 显示为搜索样式。 | - | EnterKeyType.Send | 显示为发送样式。 | - | EnterKeyType.Next | 显示为下一个样式。 | - | EnterKeyType.Done | 标准样式。 | +## EnterKeyType枚举说明 -- InputType枚举说明 - | 名称 | 描述 | - | ------------------ | ------------- | - | InputType.Normal | 基本输入模式。 | - | InputType.Password | 密码输入模式。 | - | InputType.Email | e-mail地址输入模式。 | - | InputType.Number | 纯数字输入模式。 | +| 名称 | 描述 | +| ------------------- | --------- | +| EnterKeyType.Go | 显示Go文本。 | +| EnterKeyType.Search | 显示为搜索样式。 | +| EnterKeyType.Send | 显示为发送样式。 | +| EnterKeyType.Next | 显示为下一个样式。 | +| EnterKeyType.Done | 标准样式。 | +## InputType枚举说明 + +| 名称 | 描述 | +| ------------------ | ------------- | +| InputType.Normal | 基本输入模式。 | +| InputType.Password | 密码输入模式。 | +| InputType.Email | e-mail地址输入模式。 | +| InputType.Number | 纯数字输入模式。 | ## 事件 @@ -85,19 +86,20 @@ controller: TextInputController = new TextInputController() caretPosition(value: number): void 设置光标移动到指定位置。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ------ | ---- | ---- | ---------------------------------------- | - | value | number | 是 | - | 设置输入光标的位置。
value:从字符串开始到光标所在位置的字符长度。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | ---------------------------------------- | +| value | number | 是 | - | 设置输入光标的位置。
value:从字符串开始到光标所在位置的字符长度。 | ## 示例 ### 单行文本输入 -``` +```ts +// xxx.ets @Entry @Component struct TextInputExample1 { @@ -130,7 +132,8 @@ struct TextInputExample1 { ### 设置光标 -``` +```ts +// xxx.ets @Entry @Component struct TextInputExample2 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md index 3c1a868244f59512e552153a34f4eebe6eef509f..feecd13e4e65edca5b624212ad9453c3a5d1c00c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md @@ -1,11 +1,11 @@ # TextPicker -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 文本类滑动选择器组件。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -23,30 +23,31 @@ TextPicker(value: {range: string[], selected?: number}) 根据range指定的选择范围创建文本选择器。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | range | string[] | 是 | - | 选择器的数据选择范围。 | - | selected | number | 否 | 第一个元素 | 选中项在数组中的index值。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------- | -------- | ---- | ----- | --------------- | +| range | string[] | 是 | - | 选择器的数据选择范围。 | +| selected | number | 否 | 第一个元素 | 选中项在数组中的index值。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------------- | ------ | ---- | ---------------- | +| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 | ## 事件 -| 名称 | 描述 | -| -------- | -------- | -| onChange(callback: (value: string, index: number) => void) | 滑动选中TextPicker文本内容后,触发该回调。
- value: 当前选中项的文本。
- index: 当前选中项的下标。 | +| 名称 | 描述 | +| ---------------------------------------- | ---------------------------------------- | +| onChange(callback: (value: string, index: number) => void) | 滑动选中TextPicker文本内容后,触发该回调。
- value: 当前选中项的文本。
- index: 当前选中项的下标。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TextPickerExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md index 5d9ff611b08a83c496de270ca38ec0786dbb41bd..9e2faddbd24705c60ccf568719d96269f3344f05 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md @@ -1,11 +1,11 @@ # TextTimer -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 文本计时器组件,支持自定义时间格式。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -17,29 +17,30 @@ 无 -## 接口说明 +## 接口 TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTimerController }) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | isCountDown | boolean | 否 | false | 是否倒计时。 | - | count | number | 否 | 60000 | 倒计时时间(isCountDown为true时生效),单位为毫秒。
- count<=0时,使用默认值为倒计时初始值。
- count>0时,count值为倒计时初始值。 | - | controller | [TextTimerController](#texttimercontroller) | 否 | null | TextTimer控制器。 | +**参数:** + +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----------- | ---------------------------------------- | ---- | ----- | ---------------------------------------- | +| isCountDown | boolean | 否 | false | 是否倒计时。 | +| count | number | 否 | 60000 | 倒计时时间(isCountDown为true时生效),单位为毫秒。
- count<=0时,使用默认值为倒计时初始值。
- count>0时,count值为倒计时初始值。 | +| controller | [TextTimerController](#texttimercontroller) | 否 | null | TextTimer控制器。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| format | string | 'hh:mm:ss.ms' | 自定义格式,需至少包含一个hh、mm、ss、ms中的关键字。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------ | ------ | ------------- | ------------------------------ | +| format | string | 'hh:mm:ss.ms' | 自定义格式,需至少包含一个hh、mm、ss、ms中的关键字。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onTimer(callback: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc:当前显示的时间,单位为毫秒。
elapsedTime:计时器经过的时间,单位为毫秒。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onTimer(callback: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc:当前显示的时间,单位为毫秒。
elapsedTime:计时器经过的时间,单位为毫秒。 | ## TextTimerController @@ -74,7 +75,8 @@ reset() ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TextTimerExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md index 95bb12e9b7c5025dc53e542b0ef2d5e0960de428..634a563c092694e480cf5fe2cbd1bbe2ff391e8d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-timepicker.md @@ -1,12 +1,12 @@ # TimePicker +选择时间的滑动选择器组件。 + > **说明:** +> > 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -选择时间的滑动选择器组件。 - - ## 权限列表 无 @@ -23,30 +23,30 @@ TimePicker(options?: TimePickerOptions) 默认以00:00至23:59的时间区间创建滑动选择器。 -- options参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | selected | Date | 否 | 当前系统时间 | 设置选中项的时间。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------- | ---- | ---- | ------ | --------- | +| selected | Date | 否 | 当前系统时间 | 设置选中项的时间。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| useMilitaryTime | boolean | false | 展示时间是否为24小时制,不支持动态修改。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| --------------- | ------- | ----- | --------------------- | +| useMilitaryTime | boolean | false | 展示时间是否为24小时制,不支持动态修改。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange(callback: (value: TimePickerResult ) => void) | 选择时间时触发该事件。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ----------- | +| onChange(callback: (value: TimePickerResult ) => void) | 选择时间时触发该事件。 | -### TimePickerResult对象说明 - | 名称 | 参数类型 | 描述 | - | -------- | -------- | -------- | - | hour | number | 选中时间的时。 | - | minute | number | 选中时间的分。 | +## TimePickerResult对象说明 +| 名称 | 参数类型 | 描述 | +| ------ | ------ | ------- | +| hour | number | 选中时间的时。 | +| minute | number | 选中时间的分。 | ## 示例 @@ -54,7 +54,8 @@ TimePicker(options?: TimePickerOptions) ### 时间选择器 -``` +```ts +// xxx.ets @Entry @Component struct TimePickerExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md index 0c75f100531d0f7192a5efe3552340f490cf310e..067af04129a0bf7595e1c398adcc6c0bcb93cac9 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md @@ -1,7 +1,8 @@ # Toggle -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -18,39 +19,40 @@ Toggle(options: { type: ToggleType, isOn?: boolean }) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | type | ToggleType | 是 | - | 开关类型。 | - | isOn | boolean | 否 | false | 开关是否打开,true:打开,false:关闭。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---- | ---------- | ---- | ----- | ------------------------ | +| type | ToggleType | 是 | - | 开关类型。 | +| isOn | boolean | 否 | false | 开关是否打开,true:打开,false:关闭。 | -- ToggleType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Checkbox | 提供单选框样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
> **说明:**
> [通用属性padding](ts-universal-attributes-size.md)的默认值为:
{
 top: 14 vp,
 right: 6 vp,
 bottom: 14 vp,
 left: 6 vp
} | - | Button | 提供状态按钮样式,如果有文本设置,则相应的文本内容会显示在按钮内部。 | - | Switch | 提供开关样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
> **说明:**
> [通用属性padding](ts-universal-attributes-size.md)默认值为:
{
 top: 12 vp,
 right: 12 vp,
 bottom: 12 vp,
 left: 12 vp
} | +## ToggleType枚举说明 +| 名称 | 描述 | +| -------- | ---------------------------------------- | +| Checkbox | 提供单选框样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
> **说明:**
> [通用属性padding](ts-universal-attributes-size.md)的默认值为:
{
 top: 14 vp,
 right: 6 vp,
 bottom: 14 vp,
 left: 6 vp
} | +| Button | 提供状态按钮样式,如果有文本设置,则相应的文本内容会显示在按钮内部。 | +| Switch | 提供开关样式,子组件设置文本不生效,如需文本设置,可将Text和当前组件放入布局组件中。
> **说明:**
> [通用属性padding](ts-universal-attributes-size.md)默认值为:
{
 top: 12 vp,
 right: 12 vp,
 bottom: 12 vp,
 left: 12 vp
} | ## 属性 -| 名称 | 参数 | 默认值 | 参数描述 | -| -------- | -------- | -------- | -------- | -| selectedColor | Color | - | 设置组件打开状态的背景颜色。 | -| switchPointColor | Color | - | 设置Switch类型的圆形滑块颜色。
> **说明:**
> 仅对type为ToggleType.Switch生效。 | +| 名称 | 参数 | 默认值 | 参数描述 | +| ---------------- | ----- | ---- | ---------------------------------------- | +| selectedColor | Color | - | 设置组件打开状态的背景颜色。 | +| switchPointColor | Color | - | 设置Switch类型的圆形滑块颜色。
> **说明:**
> 仅对type为ToggleType.Switch生效。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ------------- | | onChange(callback: (isOn: boolean) => void) | 开关状态切换时触发该事件。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ToggleExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md index 5c0806157fa638d53124a6b49ead13f7fb1d07f6..f5e20aa89de9eae59df83aa64b1acac97e42eda5 100755 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md @@ -1,10 +1,11 @@ # Web ->![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** ->该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 提供具有网页显示能力的Web组件。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 访问在线网页时需添加网络权限:ohos.permission.INTERNET @@ -14,50 +15,50 @@ ## 接口 -- Web\(options: { src: string, controller?: WebController }\) +Web\(options: { src: string, controller?: WebController }\) - 表1 options参数说明 +表1 options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | ------------------------------- | ---- | ---- | ------- | - | src | string | 是 | - | 网页资源地址。 | - | controller | [WebController](#webcontroller) | 否 | - | 控制器。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---------- | ------------------------------- | ---- | ---- | ------- | +| src | string | 是 | - | 网页资源地址。 | +| controller | [WebController](#webcontroller) | 否 | - | 控制器。 | - -> ![icon-note.gif](public_sys-resources/icon-note.gif)**说明:** +> **说明:** > > - 不支持转场动画; > - 不支持多实例; > - 仅支持本地音视频播放。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------- | ---------------------------------------- | -------------- | ---------------------------------------- | -| domStorageAccess | boolean | false | 设置是否开启文档对象模型存储接口(DOM Storage API)权限,默认未开启。 | -| fileAccess | boolean | false | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)访问应用中rawfile路径的文件, 默认启用。 | -| fileFromUrlAccess | boolean | true | 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)的内容,默认未启用。 | -| imageAccess | boolean | true | 设置是否允许自动加载图片资源,默认允许。 | -| javaScriptProxy | {
object: object,
name: string,
methodList: Array\,
controller: WebController
} | - | 注入JavaScript对象到window对象中,并在window对象中调用该对象的方法。所有参数不支持更新。
- object: 参与注册的对象。只能声明方法,不能声明属性 。其中方法的参数和返回类型只能为string,number,boolean。
- name: 注册对象的名称,与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。
- methodList: 参与注册的应用侧JavaScript对象的方法。
- controller: 控制器。 | -| javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本,默认允许执行。 | -| mixedMode | [MixedMode](#mixedmode枚举说明) | MixedMode.None | 设置是否允许加载超文本传输协议(HTTP)和超文本传输安全协议(HTTPS)混合内容,默认不允许加载HTTP和HTTPS混合内容。 | -| onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源(通过HTTP和HTTPS访问的资源),默认允许访问。 | -| zoomAccess | boolean | true | 设置是否支持手势进行缩放,默认允许执行缩放。| -| overviewModeAccess | boolean | true | 设置是否使用概览模式加载网页,默认使用该方式。| -| databaseAccess| boolean | false | 设置是否开启数据库存储API权限,默认不开启。| -| cacheMode | [CacheMode](#cachemode枚举说明) | CacheMode.Default| 设置缓存模式。| -| textZoomAtio | number | 100 | 设置页面的文本缩放百分比,默认为100%。 | -| userAgent | string | - | 设置用户代理。 | - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** + +| 名称 | 参数类型 | 默认值 | 描述 | +| ------------------ | ---------------------------------------- | ----------------- | ---------------------------------------- | +| domStorageAccess | boolean | false | 设置是否开启文档对象模型存储接口(DOM Storage API)权限,默认未开启。 | +| fileAccess | boolean | false | 设置是否开启通过[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)访问应用中rawfile路径的文件, 默认启用。 | +| fileFromUrlAccess | boolean | true | 设置是否允许通过网页中的JavaScript脚本访问[$rawfile(filepath/filename)](../../ui/ts-application-resource-access.md#资源引用)的内容,默认未启用。 | +| imageAccess | boolean | true | 设置是否允许自动加载图片资源,默认允许。 | +| javaScriptProxy | {
object: object,
name: string,
methodList: Array\,
controller: WebController
} | - | 注入JavaScript对象到window对象中,并在window对象中调用该对象的方法。所有参数不支持更新。
- object: 参与注册的对象。只能声明方法,不能声明属性 。其中方法的参数和返回类型只能为string,number,boolean。
- name: 注册对象的名称,与window中调用的对象名一致。注册后window对象可以通过此名字访问应用侧JavaScript对象。
- methodList: 参与注册的应用侧JavaScript对象的方法。
- controller: 控制器。 | +| javaScriptAccess | boolean | true | 设置是否允许执行JavaScript脚本,默认允许执行。 | +| mixedMode | [MixedMode](#mixedmode枚举说明) | MixedMode.None | 设置是否允许加载超文本传输协议(HTTP)和超文本传输安全协议(HTTPS)混合内容,默认不允许加载HTTP和HTTPS混合内容。 | +| onlineImageAccess | boolean | true | 设置是否允许从网络加载图片资源(通过HTTP和HTTPS访问的资源),默认允许访问。 | +| zoomAccess | boolean | true | 设置是否支持手势进行缩放,默认允许执行缩放。 | +| overviewModeAccess | boolean | true | 设置是否使用概览模式加载网页,默认使用该方式。 | +| databaseAccess | boolean | false | 设置是否开启数据库存储API权限,默认不开启。 | +| cacheMode | [CacheMode](#cachemode枚举说明) | CacheMode.Default | 设置缓存模式。 | +| textZoomAtio | number | 100 | 设置页面的文本缩放百分比,默认为100%。 | +| userAgent | string | - | 设置用户代理。 | + +> **说明:** > -> 通用属性仅支持[width](ts-universal-attributes-size.md#属性)、[height](ts-universal-attributes-size.md#属性)、[padding](ts-universal-attributes-size.md#属性)、[margin](ts-universal-attributes-size.md#属性)、[border](ts-universal-attributes-border.md#属性)。 +> 通用属性仅支持[width](ts-universal-attributes-size.md#属性)、[height](ts-universal-attributes-size.md#属性)、[padding](ts-universal-attributes-size.md#属性)、[margin](ts-universal-attributes-size.md#属性)、[border](ts-universal-attributes-border.md#属性)。 ## 事件 不支持通用事件。 -| 名称 | 功能描述 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onAlert(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

网页触发alert()告警弹窗时触发回调。
当回调返回false时,触发默认弹窗。当回调返回true时,系统应用可以调用系统弹窗能力(只有确认场景),并且根据用户的确认操作调用JsResult通知Web组件。
- url:当前显示弹窗所在网页的URL。
- message:弹窗中显示的信息。
- result:通知Web组件用户操作行为。

| | onBeforeUnload(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

刷新或关闭场景下,在即将离开当前页面时触发此回调。
当回调返回false时,触发默认弹窗。当回调返回true时,系统应用可以调用系统弹窗能力(包括确认和取消),并且需要根据用户的确认或取消操作调用JsResult通知Web组件最终是否离开当前页面。
- url:当前显示弹窗所在网页的URL。
- message:弹窗中显示的信息。
- result:通知Web组件用户操作行为。

| | onConfirm(callback: (event?: { url: string; message: string; result: [JsResult](#jsresult对象说明) }) => boolean) |

网页调用confirm()告警时触发此回调。
当回调返回false时,触发默认弹窗。当回调返回true时,系统应用可以调用系统弹窗能力(包括确认和取消),并且需要根据用户的确认或取消操作调用JsResult通知Web组件。
- url:当前显示弹窗所在网页的URL。
- message:弹窗中显示的信息。
- result:通知Web组件用户操作行为。

| @@ -65,8 +66,8 @@ | onDownloadStart(callback: (event?: { url: string, userAgent: string, contentDisposition: string, mimetype: string, contentLength: number }) => void) |

网页的下载任务开始时触发该回调。
- url:文件下载的URL。
- userAgent:下载的用户代理(UA)名称。
- contentDisposition:服务器返回的 Content-Disposition响应头,可能为空。
- mimetype:服务器返回内容媒体类型(MIME)信息。
- contentLength:服务器返回文件的长度。

| | onErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror对象说明), error: [WebResourceError](#webresourceerror对象说明) }) => void) |

网页加载遇到错误时触发该回调。
出于性能考虑,建议此回调中尽量执行简单逻辑。
- request:网页请求的封装信息。
- error:网页加载资源错误的封装信息 。

| | onHttpErrorReceive(callback: (event?: { request: [WebResourceRequest](#webresourceerror对象说明), response: [WebResourceResponse](#webresourceresponse对象说明) }) => void) |

网页加载资源遇到的HTTP错误(响应码>=400)时触发该回调。
- request:网页请求的封装信息。
- response:网页响应的封装信息

| -| onPageBegin(callback: (event?: { url: string }) => void) |

网页开始加载时触发该回调,且只在主frame触发,iframe或者frameset的内容加载时不会触发此回调。
- url:页面的URL地址。

| -| onPageEnd(callback: (event?: { url: string }) => void) |

网页加载完成时触发该回调,且只在主frame触发。
- url:页面的URL地址。

| +| onPageBegin(callback: (event?: { url: string }) => void) |

网页开始加载时触发该回调,且只在主frame触发,iframe或者frameset的内容加载时不会触发此回调。
- url:页面的URL地址。

| +| onPageEnd(callback: (event?: { url: string }) => void) |

网页加载完成时触发该回调,且只在主frame触发。
- url:页面的URL地址。

| | onProgressChange(callback: (event?: { newProgress: number }) => void) |

网页加载进度变化时触发该回调。
- newProgress:新的加载进度,取值范围为0到100的整数。

| | onTitleReceive(callback: (event?: { title: string }) => void) |

网页document标题更改时触发该回调。
- title:document标题内容。

| | onRefreshAccessedHistory(callback: (event?: { url: string, isRefreshed: boolean }) => void) |

加载网页页面完成时触发该回调,用于应用更新其访问的历史链接。
- url:访问的url。
- isRefreshed:true表示该页面是被重新加载的,false表示该页面是新加载的。

| @@ -76,12 +77,12 @@ ## ConsoleMessage对象说明 -| 接口名称 | 功能描述 | -| ------------------------------- | ---------------------- | -| getLineNumber(): number | 获取ConsoleMessage的行数。 | -| getMessage(): string | 获取ConsoleMessage的日志信息。 | +| 接口名称 | 功能描述 | +| ---------------------------------------- | ---------------------- | +| getLineNumber(): number | 获取ConsoleMessage的行数。 | +| getMessage(): string | 获取ConsoleMessage的日志信息。 | | getMessageLevel(): [MessageLevel](#messagelevel枚举说明) | 获取ConsoleMessage的信息级别。 | -| getSourceId(): string | 获取网页源文件路径和名字。 | +| getSourceId(): string | 获取网页源文件路径和名字。 | ## MessageLevel枚举说明 @@ -144,13 +145,13 @@ Web组件返回的请求/响应头对象。 onRenderExited接口返回的渲染进程退出的具体原因。 -| 名称 | 描述 | -| ---------------------------- | ------------------------------ | -| PROCESS_ABNORMAL_TERMINATION | 渲染进程异常退出。 | -| PROCESS_WAS_KILLED | 收到SIGKILL,或被手动终止。 | -| PROCESS_CRASHED | 渲染进程崩溃退出,如段错误。 | -| PROCESS_OOM | 程序内存不足。 | -| PROCESS_EXIT_UNKNOWN | 其他原因。 | +| 名称 | 描述 | +| ---------------------------- | ----------------- | +| PROCESS_ABNORMAL_TERMINATION | 渲染进程异常退出。 | +| PROCESS_WAS_KILLED | 收到SIGKILL,或被手动终止。 | +| PROCESS_CRASHED | 渲染进程崩溃退出,如段错误。 | +| PROCESS_OOM | 程序内存不足。 | +| PROCESS_EXIT_UNKNOWN | 其他原因。 | ## MixedMode枚举说明 @@ -161,35 +162,35 @@ onRenderExited接口返回的渲染进程退出的具体原因。 | None | 不允许加载HTTP和HTTPS混合内容。 | ## CacheMode枚举说明 -| 名称 | 描述 | -| ---------- | ---------------------------------- | -| Default | 使用未过期的cache加载资源,如果cache中无该资源则从网络中获取。 | -| None | 加载资源使用cache,如果cache中无该资源则从网络中获取。 | -| Online | 加载资源不使用cache,全部从网络中获取。 | -| Only | 只从cache中加载资源。 | +| 名称 | 描述 | +| ------- | ------------------------------------ | +| Default | 使用未过期的cache加载资源,如果cache中无该资源则从网络中获取。 | +| None | 加载资源使用cache,如果cache中无该资源则从网络中获取。 | +| Online | 加载资源不使用cache,全部从网络中获取。 | +| Only | 只从cache中加载资源。 | ## FileSelectorResult对象说明 通知Web组件的文件选择结果。 -| 接口名称 | 功能描述 | -| ---------------------------------------------- | ------------------------------------------------------------ | +| 接口名称 | 功能描述 | +| ---------------------------------------- | -------------------------------------- | | handleFileList(fileList: Array\): void | 通知Web组件进行文件选择操作。fileList: 需要进行操作的文件列表。 | ## FileSelectorParam对象说明 -| 接口名称 | 功能描述 | -| ---------------------------------------- | ------------------ | -| title(): string | 获取文件选择器标题。 | -| mode(): FileSelectorMode | 获取文件选择器的模式。 | -| accpetType(): Array\ | 获取文件过滤类型。 | -| isCapture(): boolean | 获取是否调用多媒体能力。 | +| 接口名称 | 功能描述 | +| ----------------------------- | ------------ | +| title(): string | 获取文件选择器标题。 | +| mode(): FileSelectorMode | 获取文件选择器的模式。 | +| accpetType(): Array\ | 获取文件过滤类型。 | +| isCapture(): boolean | 获取是否调用多媒体能力。 | ## FileSelectorMode枚举说明 -| 名称 | 描述 | -| ---------------------------- | ------------------------------ | -| FILE_OPEN_MODE | 打开上传单个文件。 | -| FILE_OPEN_MULTIPLE_MODE | 打开上传多个文件。 | -| FILE_OPEN_FOLDER_MODE | 打开上传文件夹模式。 | -| FILE_SAVE_MODE | 文件保存模式。 | +| 名称 | 描述 | +| ----------------------- | ---------- | +| FILE_OPEN_MODE | 打开上传单个文件。 | +| FILE_OPEN_MULTIPLE_MODE | 打开上传多个文件。 | +| FILE_OPEN_FOLDER_MODE | 打开上传文件夹模式。 | +| FILE_SAVE_MODE | 文件保存模式。 | ## WebController @@ -373,8 +374,8 @@ getCookieManager(): WebCookie 获取web组件cookie管理对象。 - 返回值 - | 参数类型 | 说明 | - | ------- | --------- | + | 参数类型 | 说明 | + | --------- | ---------------------------------------- | | WebCookie | web组件cookie管理对象,参考[WebCookie](#webcookie)定义。 | ## WebCookie 通过WebCookie可以控制Web组件中的cookie的各种行为,其中每个应用中的所有web组件共享一个WebCookie。通过controller方法中的getCookieManager方法可以获取WebCookie对象,进行后续的cookie管理操作。 @@ -385,13 +386,13 @@ setCookie(url: string, value: string): boolean - 参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | ------------------------ | ---- | ---- | ---------------------------------------- | - | url | string | 是 | - | 要设置的cookie所属的url。 | - | value | string | 是 | - | cookie的值。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ----- | ------ | ---- | ---- | ----------------- | + | url | string | 是 | - | 要设置的cookie所属的url。 | + | value | string | 是 | - | cookie的值。 | - 返回值 - | 参数类型 | 说明 | - | ------- | --------- | + | 参数类型 | 说明 | + | ------- | ------------- | | boolean | 设置cookie是否成功。 | ### saveCookieSync @@ -399,8 +400,8 @@ saveCookieSync(): boolean 将当前存在内存中的cookie同步到磁盘中,该方法为同步方法。 - 返回值 - | 参数类型 | 说明 | - | ------- | --------- | + | 参数类型 | 说明 | + | ------- | -------------------- | | boolean | 同步内存cookie到磁盘操作是否成功。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md index adb4d20481d19aa1a59c82b5e88792242a780e04..dbd5d7fc0de9e232e4b05fac3b0a80d7c9e1bf41 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md @@ -1,9 +1,10 @@ # XComponent - > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** - > 该组件从API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + 可用于EGL/OpenGLES和媒体数据写入,并显示在XComponent组件。 - 可用于EGL/OpenGLES和媒体数据写入,并显示在XComponent组件。 + > **说明:** + > + > 该组件从API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -15,24 +16,23 @@ ## 接口 - XComponent\(value: {id: string, type: string, libraryname?: string, controller?: XComponentController}\) + XComponent\(value: {id: string, type: string, libraryname?: string, controller?: XComponentController}\) - - 参数 - - | 名称 | 参数类型 | 必填 | 描述 | - | ----------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | - | id | string | 是 | 组件的唯一标识,支持最大的字符串长度128。 | - | type | string | 是 | 用于指定XComponent组件类型,可选值为:
-surface:组件内容单独送显,直接合成到屏幕。
-component:组件内容与其他组件合成后统一送显。| - | libraryname | string | 否 | 应用Native层编译输出动态库名称。 | - | controller | [XComponentController](#XComponentController) | 否 | 给组件绑定一个控制器,通过控制器调用组件方法。 | +**参数:** +| 名称 | 参数类型 | 必填 | 描述 | +| ----------- | ---------------------------------------- | ---- | ---------------------------------------- | +| id | string | 是 | 组件的唯一标识,支持最大的字符串长度128。 | +| type | string | 是 | 用于指定XComponent组件类型,可选值为:
-surface:组件内容单独送显,直接合成到屏幕。
-component:组件内容与其他组件合成后统一送显。 | +| libraryname | string | 否 | 应用Native层编译输出动态库名称。 | +| controller | [XComponentController](#XComponentController) | 否 | 给组件绑定一个控制器,通过控制器调用组件方法。 | ## 事件 -| 名称 | 功能描述 | -| ------------------------------- | ------------------------ | +| 名称 | 功能描述 | +| -------------------------------- | ------------ | | onLoad(context?: object) => void | 插件加载完成时回调事件。 | -| onDestroy() => void | 插件卸载完成时回调事件。 | +| onDestroy() => void | 插件卸载完成时回调事件。 | ## XComponentController @@ -50,11 +50,11 @@ getXComponentSurfaceId(): string 获取XComponent对应Surface的ID,供@ohos接口使用,比如camera相关接口。 - - 返回值 +**返回值:** - | 类型 | 描述 | - | ------ | --------------------------- | - | string | XComponent持有Surface的ID。 | +| 类型 | 描述 | +| ------ | ----------------------- | +| string | XComponent持有Surface的ID。 | ### setXComponentSurfaceSize @@ -62,12 +62,12 @@ setXComponentSurfaceSize(value: {surfaceWidth: number, surfaceHeight: number}): 设置XComponent持有Surface的宽度和高度。 -- 参数 +**参数:** - | 参数名 | 参数类型 | 必填 | 默认值 | 描述 | - | ------------- | -------- | ---- | ------ | ----------------------------- | - | surfaceWidth | number | 是 | - | XComponent持有Surface的宽度。 | - | surfaceHeight | number | 是 | - | XComponent持有Surface的高度。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 描述 | +| ------------- | ------ | ---- | ---- | ----------------------- | +| surfaceWidth | number | 是 | - | XComponent持有Surface的宽度。 | +| surfaceHeight | number | 是 | - | XComponent持有Surface的高度。 | ### getXComponentContext @@ -75,18 +75,18 @@ getXComponentContext(): Object 获取XComponent实例对象的context。 -- 返回值 +**返回值:** - | 类型 | 描述 | - | ------ | ------------------------------------------------------------ | - | Object | 获取XComponent实例对象的context,context包含的具体接口方法由开发者自定义。 | +| 类型 | 描述 | +| ------ | ---------------------------------------- | +| Object | 获取XComponent实例对象的context,context包含的具体接口方法由开发者自定义。 | ## 示例 提供surface类型XComponent,支持相机预览等能力。 示例效果请以真机运行为准,当前IDE预览器不支持。 -``` +```ts import camera from '@ohos.multimedia.camera'; @Entry @Component diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md index c75ef770d2f9a587bae43d51dab1ef8368ad4ab9..9c0ee70cedd0cf0c0aa98db7f2af2dfe832431ef 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md @@ -1,7 +1,8 @@ # LongPressGesture -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,31 +14,32 @@ LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: number }) -- 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 1 | 触发长按的最少手指数,最小为1指, 最大取值为10指。 | - | repeat | boolean | 否 | false | 是否连续触发事件回调。 | - | duration | number | 否 | 500 | 最小触发长按的时间,单位为毫秒(ms)。 | +**参数:** +| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------- | ------- | ---- | ----- | -------------------------------- | +| fingers | number | 否 | 1 | 触发长按的最少手指数,最小为1指, 最大取值为10指。 | +| repeat | boolean | 否 | false | 是否连续触发事件回调。 | +| duration | number | 否 | 500 | 最小触发长按的时间,单位为毫秒(ms)。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onAction((event?: GestureEvent) => void) | LongPress手势识别成功回调。 | -| onActionEnd((event?: GestureEvent) => void) | LongPress手势识别成功,手指抬起后触发回调。 | -| onActionCancel(event: () => void) | LongPress手势识别成功,接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ------------------------------ | +| onAction((event?: GestureEvent) => void) | LongPress手势识别成功回调。 | +| onActionEnd((event?: GestureEvent) => void) | LongPress手势识别成功,手指抬起后触发回调。 | +| onActionCancel(event: () => void) | LongPress手势识别成功,接收到触摸取消事件触发回调。 | -- GestureEvent对象中与LongPress手势相关的属性 - | 属性名称 | 属性类型 | 描述 | - | -------- | -------- | -------- | - | repeat | boolean | 事件是否为重复触发事件。 | +## GestureEvent对象中与LongPress手势相关的属性 +| 属性名称 | 属性类型 | 描述 | +| ------ | ------- | ------------ | +| repeat | boolean | 事件是否为重复触发事件。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct LongPressGestureExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md index 5475d871b670eae16b32c58ad9aa0a33f287f9e6..66f629bdd03115b8dd28a0d8a7a9f8b8636700cc 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md @@ -1,7 +1,8 @@ # PanGesture -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,62 +14,65 @@ PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions)) -- 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 1 | 触发滑动的最少手指数,最小为1指, 最大取值为10指。 | - | direction | PanDirection | 否 | All | 设置滑动方向,此枚举值支持逻辑与(&)和逻辑或(\|)运算。 | - | distance | number | 否 | 5.0 | 最小滑动识别距离,单位为vp。 | +**参数:** -- PanDirection枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | All | 所有方向可滑动。 | - | Horizontal | 水平方向可滑动。 | - | Vertical | 竖直方向可滑动。 | - | Left | 向左滑动。 | - | Right | 向右滑动。 | - | Up | 向上滑动。 | - | Down | 向下滑动。 | - | None | 任何方向都不可滑动。 | +| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ------------ | ---- | ---- | ---------------------------------- | +| fingers | number | 否 | 1 | 触发滑动的最少手指数,最小为1指, 最大取值为10指。 | +| direction | PanDirection | 否 | All | 设置滑动方向,此枚举值支持逻辑与(&)和逻辑或(\|)运算。 | +| distance | number | 否 | 5.0 | 最小滑动识别距离,单位为vp。 | +## PanDirection枚举说明 -### PanGestureOptions +| 名称 | 描述 | +| ---------- | ---------- | +| All | 所有方向可滑动。 | +| Horizontal | 水平方向可滑动。 | +| Vertical | 竖直方向可滑动。 | +| Left | 向左滑动。 | +| Right | 向右滑动。 | +| Up | 向上滑动。 | +| Down | 向下滑动。 | +| None | 任何方向都不可滑动。 | + +## PanGestureOptions 通过PanGestureOptions对象接口可以动态修改滑动手势识别器的属性,从而避免通过状态变量修改属性(状态变量修改会导致UI刷新)。 PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distance?: number }) -- 参数 - 同PanGesture参数说明。 +**参数:** + +同PanGesture参数说明。 -- 接口 - | 名称 | 功能描述 | - | -------- | -------- | - | setDirection(value: PanDirection) | 设置direction属性。 | - | setDistance(value: number) | 设置distance属性。 | - | setFingers(value: number) | 设置fingers属性。 | +**接口:** +| 名称 | 功能描述 | +| -------------------------------------- | -------------- | +| setDirection(value: PanDirection) | 设置direction属性。 | +| setDistance(value: number) | 设置distance属性。 | +| setFingers(value: number) | 设置fingers属性。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onActionStart(callback: (event?: GestureEvent) => void) | Pan手势识别成功回调。 | -| onActionUpdate(callback: (event?: GestureEvent) => void) | Pan手势移动过程中回调。 | -| onActionEnd(callback: (event?: GestureEvent) => void) | Pan手势识别成功,手指抬起后触发回调。 | -| onActionCancel(callback: () => void) | Pan手势识别成功,接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ------------------------ | +| onActionStart(callback: (event?: GestureEvent) => void) | Pan手势识别成功回调。 | +| onActionUpdate(callback: (event?: GestureEvent) => void) | Pan手势移动过程中回调。 | +| onActionEnd(callback: (event?: GestureEvent) => void) | Pan手势识别成功,手指抬起后触发回调。 | +| onActionCancel(callback: () => void) | Pan手势识别成功,接收到触摸取消事件触发回调。 | -- GestureEvent对象中与Pan手势相关的属性 - | 属性名称 | 属性类型 | 描述 | - | -------- | -------- | -------- | - | offsetX | number | 手势事件偏移量,单位为vp。 | - | offsetY | number | 手势事件偏移量,单位为vp。 | +## GestureEvent对象中与Pan手势相关的属性 +| 属性名称 | 属性类型 | 描述 | +| ------- | ------ | -------------- | +| offsetX | number | 手势事件偏移量,单位为vp。 | +| offsetY | number | 手势事件偏移量,单位为vp。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PanGestureExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md index 267062aa0c72aa7619d07f3eee617a09b4919b0f..9a0c0617016eeaba265be78b3ebda0a10704d4aa 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md @@ -1,7 +1,8 @@ # PinchGesture -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,33 +14,34 @@ PinchGesture(options?: { fingers?: number, distance?: number }) -- 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 2 | 触发捏合的最少手指数, 最小为2指,最大为5指。 | - | distance | number | 否 | 3.0 | 最小识别距离,单位为vp。 | +**参数:** +| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------- | ------ | ---- | ---- | ----------------------------- | +| fingers | number | 否 | 2 | 触发捏合的最少手指数, 最小为2指,最大为5指。 | +| distance | number | 否 | 3.0 | 最小识别距离,单位为vp。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onActionStart((event?: GestureEvent) => void) | Pinch手势识别成功回调。 | -| onActionUpdate((event?: GestureEvent) => void) | Pinch手势移动过程中回调。 | -| onActionEnd((event?: GestureEvent) => void) | Pinch手势识别成功,手指抬起后触发回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | -------------------------- | +| onActionStart((event?: GestureEvent) => void) | Pinch手势识别成功回调。 | +| onActionUpdate((event?: GestureEvent) => void) | Pinch手势移动过程中回调。 | +| onActionEnd((event?: GestureEvent) => void) | Pinch手势识别成功,手指抬起后触发回调。 | | onActionCancel(event: () => void) | Pinch手势识别成功,接收到触摸取消事件触发回调。 | -- GestureEvent对象中与Pinch手势相关的属性 - | 属性名称 | 属性类型 | 描述 | - | -------- | -------- | -------- | - | scale | number | 缩放比例,用于PinchGesture手势触发场景。 | - | pinchCenterX | number | 捏合手势中心点X轴坐标,单位为px。 | - | pinchCenterY | number | 捏合手势中心点Y轴坐标,单位为px。 | +## GestureEvent对象中与Pinch手势相关的属性 +| 属性名称 | 属性类型 | 描述 | +| ------------ | ------ | -------------------------- | +| scale | number | 缩放比例,用于PinchGesture手势触发场景。 | +| pinchCenterX | number | 捏合手势中心点X轴坐标,单位为px。 | +| pinchCenterY | number | 捏合手势中心点Y轴坐标,单位为px。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PinchGestureExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md index 32db06fd1db4de26038f8a53d6380fd4a3d62d8a..b7d7b34289a953ae15aa191215dec83e362093bd 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md @@ -1,7 +1,8 @@ # RotationGesture -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,31 +14,32 @@ RotationGesture(options?: { fingers?: number, angle?: number }) -- 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 2 | 触发旋转的最少手指数, 最小为2指,最大为5指。 | - | angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数,单位为度数。 | +**参数:** +| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ------ | ---- | ---- | ----------------------------- | +| fingers | number | 否 | 2 | 触发旋转的最少手指数, 最小为2指,最大为5指。 | +| angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数,单位为度数。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onActionStart((event?: GestureEvent) => void) | Rotation手势识别成功回调。 | -| onActionUpdate((event?: GestureEvent) => void) | Rotation手势移动过程中回调。 | -| onActionEnd((event?: GestureEvent) => void) | Rotation手势识别成功,手指抬起后触发回调。 | -| onActionCancel(event: () => void) | Rotation手势识别成功,接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ----------------------------- | +| onActionStart((event?: GestureEvent) => void) | Rotation手势识别成功回调。 | +| onActionUpdate((event?: GestureEvent) => void) | Rotation手势移动过程中回调。 | +| onActionEnd((event?: GestureEvent) => void) | Rotation手势识别成功,手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Rotation手势识别成功,接收到触摸取消事件触发回调。 | -- GestureEvent对象中与Rotation手势相关的属性 - | 属性名称 | 属性类型 | 描述 | - | -------- | -------- | -------- | - | angle | number | 旋转角度。 | +## GestureEvent对象中与Rotation手势相关的属性 +| 属性名称 | 属性类型 | 描述 | +| ----- | ------ | ----- | +| angle | number | 旋转角度。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct RotationGestureExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md index 0ebf5535e22e0369dcdf47e63bce381a25128229..7ed289a2dbb41da40eafbfad3b991a956ddb61b3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md @@ -1,7 +1,8 @@ # SwipeGesture -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,38 +14,40 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: number }) -- 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | fingers | number | 否 | 1 | 触发滑动的最少手指数,默认为1,最小为1指,最大为10指。 | - | direction | SwipeDirection | 否 | SwipeDirection.All | 滑动方向。 | - | speed | number | 否 | 100 | 识别滑动的最小速度(100VP/秒)。 | +**参数:** -- SwipeDirection枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | All | 所有方向。 | - | Horizontal | 水平方向。 | - | Vertical | 竖直方向。 | +| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | -------------- | ---- | ------------------ | ----------------------------- | +| fingers | number | 否 | 1 | 触发滑动的最少手指数,默认为1,最小为1指,最大为10指。 | +| direction | SwipeDirection | 否 | SwipeDirection.All | 滑动方向。 | +| speed | number | 否 | 100 | 识别滑动的最小速度(100VP/秒)。 | +## SwipeDirection枚举说明 + +| 名称 | 描述 | +| ---------- | ----- | +| All | 所有方向。 | +| Horizontal | 水平方向。 | +| Vertical | 竖直方向。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onAction(callback:(event?: GestureEvent) => void) | 滑动手势识别成功回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ----------- | +| onAction(callback:(event?: GestureEvent) => void) | 滑动手势识别成功回调。 | +## GestureEvent对象中与Swipe手势相关的属性 -- GestureEvent对象中与Swipe手势相关的属性 - | 参数名 | 类型 | 说明 | - | -------- | -------- | -------- | - | angle | number | 滑动手势的角度,即两根手指间的线段与水平方向的夹角变化的度数。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 角度计算方式:滑动手势被识别到后,连接两根手指之间的线被识别为起始线条,随着手指的滑动,手指之间的线条会发生旋转,根据起始线条两端点和当前线条两端点的坐标,使用反正切函数分别计算其相对于水平方向的夹角,最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系,顺时针旋转为0到180度,逆时针旋转为-180到0度。 | - | speed | number | 滑动手势的速度,是所有手指滑动的平均速度,单位为VP/秒。 | +| 参数名 | 类型 | 说明 | +| ----- | ------ | ---------------------------------------- | +| angle | number | 滑动手势的角度,即两根手指间的线段与水平方向的夹角变化的度数。
>  **说明:**
> 角度计算方式:滑动手势被识别到后,连接两根手指之间的线被识别为起始线条,随着手指的滑动,手指之间的线条会发生旋转,根据起始线条两端点和当前线条两端点的坐标,使用反正切函数分别计算其相对于水平方向的夹角,最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系,顺时针旋转为0到180度,逆时针旋转为-180到0度。 | +| speed | number | 滑动手势的速度,是所有手指滑动的平均速度,单位为VP/秒。 | ![zh-cn_image_0000001231374559](figures/zh-cn_image_0000001231374661.png) ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct SwipeGestureExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md index eed7d440cf94d98e301a8511c8338498fb024304..4c332ec0f342a372c72e8a3074c88675d8c2b956 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md @@ -1,7 +1,8 @@ # TapGesture -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,23 +14,24 @@ TapGesture(options?: { count?: number, fingers?: number }) -- 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1,会被转化为默认值。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如配置多击,上一次抬起和下一次按下的超时时间为300毫秒(ms)。 | - | fingers | number | 否 | 1 | 触发点击的最少手指数,最小为1指, 最大为10指。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 1. 当配置多指时,第一根手指按下后300毫秒(ms)内未有足够的手指数按下,手势识别失败。

> 2. 实际点击手指数超过配置值,手势识别失败。 | +**参数:** +| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ------ | ---- | ---- | ---------------------------------------- | +| count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1,会被转化为默认值。
>  **说明:**
> 如配置多击,上一次抬起和下一次按下的超时时间为300毫秒(ms)。 | +| fingers | number | 否 | 1 | 触发点击的最少手指数,最小为1指, 最大为10指。
>  **说明:**
> 1. 当配置多指时,第一根手指按下后300毫秒(ms)内未有足够的手指数按下,手势识别失败。

> 2. 实际点击手指数超过配置值,手势识别失败。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ------------ | +| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TapGestureExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md b/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md index 198ae125187f3c4ace88a6618f3320affc64499d..08db299f856f4fdae23a238e0bc16c6c6bfcdee4 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-canvasrenderingcontext2d.md @@ -1,7 +1,8 @@ # CanvasRenderingContext2D对象 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 使用RenderingContext在Canvas组件上进行绘制,绘制对象可以是矩形、文本、图片等。 @@ -11,10 +12,11 @@ CanvasRenderingContext2D(setting: RenderingContextSetting) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | setting | [RenderingContextSettings](#renderingcontextsettings) | 是 | - | 见[RenderingContextSettings](#renderingcontextsettings)。 | +**参数:** + +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| setting | [RenderingContextSettings](#renderingcontextsettings) | 是 | - | 见[RenderingContextSettings](#renderingcontextsettings)。 | ### RenderingContextSettings @@ -23,10 +25,10 @@ RenderingContextSettings(antialias?: bool) 用来配置CanvasRenderingContext2D对象的参数,包括是否开启抗锯齿。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------- | ---- | ---- | ----- | ---------------- | - | antialias | bool | 否 | false | 表明canvas是否开启抗锯齿。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ---- | ---- | ----- | ---------------- | +| antialias | bool | 否 | false | 表明canvas是否开启抗锯齿。 | ## 属性 @@ -40,7 +42,7 @@ RenderingContextSettings(antialias?: bool) | [lineJoin](#linejoin) | string | 'miter' | 指定线段间相交的交点样式,可选值为:
- 'round':在线段相连处绘制一个扇形,扇形的圆角半径是线段的宽度。
- 'bevel':在线段相连处使用三角形为底填充, 每个部分矩形拐角独立。
- 'miter':在相连部分的外边缘处进行延伸,使其相交于一点,形成一个菱形区域,该属性可以通过设置miterLimit属性展现效果。 | | [miterLimit](#miterlimit) | number | 10 | 设置斜接面限制值,该值指定了线条相交处内角和外角的距离。 | | [font](#font) | string | 'normal normal 14px sans-serif' | 设置文本绘制中的字体样式。
语法:ctx.font='font-size font-family'
- font-size(可选),指定字号和行高,单位只支持px。
- font-family(可选),指定字体系列。
语法:ctx.font='font-style font-weight font-size font-family'
- font-style(可选),用于指定字体样式,支持如下几种样式:'normal',talic。
- font-weight(可选),用于指定字体的粗细,支持如下几种类型:'normal', 'bold', 'bolder', 'lighter', 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选),指定字号和行高,单位只支持px。
- font-family(可选),指定字体系列,支持如下几种类型:'sans-serif', 'serif', 'monospace'。 | -| [textAlign](#textalign) | string | 'left' | 设置文本绘制中的文本对齐方式,可选值为:
- 'left':文本左对齐。
- 'right':文本右对齐。
- 'center':文本居中对齐。
- 'start':文本对齐界线开始的地方。
- 'end':文本对齐界线结束的地方。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ltr布局模式下'start'和'left'一致,rtl布局模式下'start'和'right'一致·。 | +| [textAlign](#textalign) | string | 'left' | 设置文本绘制中的文本对齐方式,可选值为:
- 'left':文本左对齐。
- 'right':文本右对齐。
- 'center':文本居中对齐。
- 'start':文本对齐界线开始的地方。
- 'end':文本对齐界线结束的地方。
>  **说明:**
> ltr布局模式下'start'和'left'一致,rtl布局模式下'start'和'right'一致·。 | | [textBaseline](#textbaseline) | string | 'alphabetic' | 设置文本绘制中的水平对齐方式,可选值为:
- 'alphabetic':文本基线是标准的字母基线。
- 'top':文本基线在文本块的顶部。
- 'hanging':文本基线是悬挂基线。
- 'middle':文本基线在文本块的中间。
- 'ideographic':文字基线是表意字基线;如果字符本身超出了alphabetic基线,那么ideograhpic基线位置在字符本身的底部。
- 'bottom':文本基线在文本块的底部。 与ideographic基线的区别在于ideographic基线不需要考虑下行字母。 | | [globalAlpha](#globalalpha) | number | - | 设置透明度,0.0为完全透明,1.0为完全不透明。 | | [lineDashOffset](#linedashoffset) | number | 0.0 | 设置画布的虚线偏移量,精度为float。 | @@ -52,13 +54,15 @@ RenderingContextSettings(antialias?: bool) | [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整,true为启用,false为不启用。 | | imageSmoothingQuality | string | 'low' | 用于设置图像平滑度,支持如下三种类型:'low', 'medium', 'high'。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> <color>类型格式为 'rgb(255, 255, 255)','rgba(255, 255, 255, 1.0)','\#FFFFFF'。 +> **说明:** +> +> <color>类型格式为 'rgb(255, 255, 255)','rgba(255, 255, 255, 1.0)','\#FFFFFF'。 ### fillStyle -``` +```ts +// xxx.ets @Entry @Component struct FillStyleExample { @@ -87,7 +91,8 @@ struct FillStyleExample { ### lineWidth -``` +```ts +// xxx.ets @Entry @Component struct LineWidthExample { @@ -116,7 +121,8 @@ struct LineWidthExample { ### strokeStyle -``` +```ts +// xxx.ets @Entry @Component struct StrokeStyleExample { @@ -147,7 +153,8 @@ struct StrokeStyleExample { ### lineCap -``` +```ts +// xxx.ets @Entry @Component struct LineCapExample { @@ -180,7 +187,8 @@ struct LineCapExample { ### lineJoin -``` +```ts +// xxx.ets @Entry @Component struct LineJoinExample { @@ -214,7 +222,8 @@ struct LineJoinExample { ### miterLimit -``` +```ts +// xxx.ets @Entry @Component struct MiterLimit { @@ -248,7 +257,8 @@ struct MiterLimit { ### font -``` +```ts +// xxx.ets @Entry @Component struct Fonts { @@ -277,7 +287,8 @@ struct Fonts { ### textAlign -``` +```ts +// xxx.ets @Entry @Component struct CanvasExample { @@ -321,7 +332,8 @@ struct CanvasExample { ### textBaseline -``` +```ts +// xxx.ets @Entry @Component struct TextBaseline { @@ -365,7 +377,8 @@ struct TextBaseline { ### globalAlpha -``` +```ts +// xxx.ets @Entry @Component struct GlobalAlpha { @@ -397,7 +410,8 @@ struct GlobalAlpha { ### lineDashOffset -``` +```ts +// xxx.ets @Entry @Component struct LineDashOffset { @@ -441,7 +455,8 @@ struct LineDashOffset { | copy | 显示新绘制内容而忽略现有绘制内容。 | | xor | 使用异或操作对新绘制内容与现有绘制内容进行融合。 | -``` +```ts +// xxx.ets @Entry @Component struct GlobalCompositeOperation { @@ -478,7 +493,8 @@ struct GlobalCompositeOperation { ### shadowBlur -``` +```ts +// xxx.ets @Entry @Component struct ShadowBlur { @@ -509,7 +525,8 @@ struct ShadowBlur { ### shadowColor -``` +```ts +// xxx.ets @Entry @Component struct ShadowColor { @@ -540,7 +557,8 @@ struct ShadowColor { ### shadowOffsetX -``` +```ts +// xxx.ets @Entry @Component struct ShadowOffsetX { @@ -572,7 +590,8 @@ struct ShadowOffsetX { ### shadowOffsetY -``` +```ts +// xxx.ets @Entry @Component struct ShadowOffsetY { @@ -603,7 +622,8 @@ struct ShadowOffsetY { ### imageSmoothingEnabled -``` +```ts +// xxx.ets @Entry @Component struct ImageSmoothingEnabled { @@ -640,15 +660,15 @@ fillRect(x: number, y: number, w: number, h: number): void 填充一个矩形。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ------ | ------ | ---- | ---- | ------------- | - | x | number | 是 | 0 | 指定矩形左上角点的x坐标。 | - | y | number | 是 | 0 | 指定矩形左上角点的y坐标。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ------ | ------ | ---- | ---- | ------------- | +| x | number | 是 | 0 | 指定矩形左上角点的x坐标。 | +| y | number | 是 | 0 | 指定矩形左上角点的y坐标。 | +| width | number | 是 | 0 | 指定矩形的宽度。 | +| height | number | 是 | 0 | 指定矩形的高度。 | -- 示例 +**示例:** ``` @Entry @Component @@ -681,15 +701,15 @@ strokeRect(x: number, y: number, w: number, h: number): void 绘制具有边框的矩形,矩形内部不填充。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ------ | ------ | ---- | ---- | ------------ | - | x | number | 是 | 0 | 指定矩形的左上角x坐标。 | - | y | number | 是 | 0 | 指定矩形的左上角y坐标。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ------ | ------ | ---- | ---- | ------------ | +| x | number | 是 | 0 | 指定矩形的左上角x坐标。 | +| y | number | 是 | 0 | 指定矩形的左上角y坐标。 | +| width | number | 是 | 0 | 指定矩形的宽度。 | +| height | number | 是 | 0 | 指定矩形的高度。 | -- 示例 +**示例:** ``` @Entry @Component @@ -721,15 +741,15 @@ clearRect(x: number, y: number, w: number, h: number): void 删除指定区域内的绘制内容。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | x | number | 是 | 0 | 指定矩形上的左上角x坐标。 | - | y | number | 是 | 0 | 指定矩形上的左上角y坐标。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ------ | ---- | ---- | ------------- | +| x | number | 是 | 0 | 指定矩形上的左上角x坐标。 | +| y | number | 是 | 0 | 指定矩形上的左上角y坐标。 | +| width | number | 是 | 0 | 指定矩形的宽度。 | +| height | number | 是 | 0 | 指定矩形的高度。 | -- 示例 +**示例:** ``` @Entry @Component @@ -763,14 +783,14 @@ fillText(text: string, x: number, y: number): void 绘制填充类文本。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ---- | ------ | ---- | ---- | --------------- | - | text | string | 是 | “” | 需要绘制的文本内容。 | - | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | - | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---- | ------ | ---- | ---- | --------------- | +| text | string | 是 | “” | 需要绘制的文本内容。 | +| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | +| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | -- 示例 +**示例:** ``` @Entry @Component @@ -803,14 +823,14 @@ strokeText(text: string, x: number, y: number): void 绘制描边类文本。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------------- | - | text | string | 是 | “” | 需要绘制的文本内容。 | - | x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | - | y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | --------------- | +| text | string | 是 | “” | 需要绘制的文本内容。 | +| x | number | 是 | 0 | 需要绘制的文本的左下角x坐标。 | +| y | number | 是 | 0 | 需要绘制的文本的左下角y坐标。 | -- 示例 +**示例:** ``` @Entry @Component @@ -843,10 +863,10 @@ measureText(text: string): TextMetrics 该方法返回一个文本测算的对象,通过该对象可以获取指定文本的宽度值。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ---- | ------ | ---- | ---- | ---------- | - | text | string | 是 | "" | 需要进行测量的文本。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---- | ------ | ---- | ---- | ---------- | +| text | string | 是 | "" | 需要进行测量的文本。 | - 返回值 | 类型 | 说明 | @@ -858,7 +878,7 @@ measureText(text: string): TextMetrics | ----- | ------ | ------- | | width | number | 字符串的宽度。 | -- 示例 +**示例:** ``` @Entry @Component @@ -892,12 +912,12 @@ stroke(path?: Path2D): void 进行边框绘制操作。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ---------------------------------------- | ---- | ---- | ------------ | - | path | [Path2D](ts-components-canvas-path2d.md) | 否 | null | 需要绘制的Path2D。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ---------------------------------------- | ---- | ---- | ------------ | +| path | [Path2D](ts-components-canvas-path2d.md) | 否 | null | 需要绘制的Path2D。 | -- 示例 +**示例:** ``` @Entry @Component @@ -933,7 +953,7 @@ beginPath(): void 创建一个新的绘制路径。 -- 示例 +**示例:** ``` @Entry @Component @@ -971,13 +991,13 @@ moveTo(x: number, y: number): void 路径从当前点移动到指定点。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ---- | ------ | ---- | ---- | --------- | - | x | number | 是 | 0 | 指定位置的x坐标。 | - | y | number | 是 | 0 | 指定位置的y坐标。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ---- | ------ | ---- | ---- | --------- | +| x | number | 是 | 0 | 指定位置的x坐标。 | +| y | number | 是 | 0 | 指定位置的y坐标。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1013,13 +1033,13 @@ lineTo(x: number, y: number): void 从当前点到指定点进行路径连接。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------- | - | x | number | 是 | 0 | 指定位置的x坐标。 | - | y | number | 是 | 0 | 指定位置的y坐标。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | --------- | +| x | number | 是 | 0 | 指定位置的x坐标。 | +| y | number | 是 | 0 | 指定位置的y坐标。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1055,7 +1075,7 @@ closePath(): void 结束当前路径形成一个封闭路径。 -- 示例 +**示例:** ``` @Entry @Component @@ -1093,13 +1113,13 @@ createPattern(image: ImageBitmap, repetition: string): void 通过指定图像和重复方式创建图片填充的模板。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图源对象,具体参考ImageBitmap对象。 | - | repetition | string | 是 | “” | 设置图像重复的方式,取值为:'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| image | [ImageBitmap](ts-components-canvas-imagebitmap.md) | 是 | null | 图源对象,具体参考ImageBitmap对象。 | +| repetition | string | 是 | “” | 设置图像重复的方式,取值为:'repeat'、'repeat-x'、 'repeat-y'、'no-repeat'。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1135,17 +1155,17 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, 创建三次贝赛尔曲线的路径。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | -------------- | - | cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | - | cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | - | cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | - | cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | - -- 示例 +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------------- | +| cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | +| cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | +| cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | +| cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | +| x | number | 是 | 0 | 路径结束时的x坐标值。 | +| y | number | 是 | 0 | 路径结束时的y坐标值。 | + +**示例:** ``` @Entry @Component @@ -1181,15 +1201,15 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void 创建二次贝赛尔曲线的路径。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | ----------- | - | cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | - | cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ----------- | +| cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | +| cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | +| x | number | 是 | 0 | 路径结束时的x坐标值。 | +| y | number | 是 | 0 | 路径结束时的y坐标值。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1224,17 +1244,17 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, 绘制弧线路径。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------------- | ------- | ---- | ----- | ---------- | - | x | number | 是 | 0 | 弧线圆心的x坐标值。 | - | y | number | 是 | 0 | 弧线圆心的y坐标值。 | - | radius | number | 是 | 0 | 弧线的圆半径。 | - | startAngle | number | 是 | 0 | 弧线的起始弧度。 | - | endAngle | number | 是 | 0 | 弧线的终止弧度。 | - | anticlockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | - -- 示例 +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------------- | ------- | ---- | ----- | ---------- | +| x | number | 是 | 0 | 弧线圆心的x坐标值。 | +| y | number | 是 | 0 | 弧线圆心的y坐标值。 | +| radius | number | 是 | 0 | 弧线的圆半径。 | +| startAngle | number | 是 | 0 | 弧线的起始弧度。 | +| endAngle | number | 是 | 0 | 弧线的终止弧度。 | +| anticlockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | + +**示例:** ``` @Entry @Component @@ -1269,16 +1289,16 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void 依据圆弧经过的点和圆弧半径创建圆弧路径。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | --------------- | - | x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | - | y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | - | x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | - | y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | - | radius | number | 是 | 0 | 圆弧的圆半径值。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ------ | ---- | ---- | --------------- | +| x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | +| y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | +| x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | +| y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | +| radius | number | 是 | 0 | 圆弧的圆半径值。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1313,19 +1333,19 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number 在规定的矩形区域绘制一个椭圆。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 说明 | - | ------------- | ------- | ---- | ----- | ----------------- | - | x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | - | y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | - | radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | - | radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | - | rotation | number | 是 | 0 | 椭圆的旋转角度,单位为弧度。 | - | startAngle | number | 是 | 0 | 椭圆绘制的起始点角度,以弧度表示。 | - | endAngle | number | 是 | 0 | 椭圆绘制的结束点角度,以弧度表示。 | - | anticlockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 说明 | +| ------------- | ------- | ---- | ----- | ----------------- | +| x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | +| y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | +| radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | +| radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | +| rotation | number | 是 | 0 | 椭圆的旋转角度,单位为弧度。 | +| startAngle | number | 是 | 0 | 椭圆绘制的起始点角度,以弧度表示。 | +| endAngle | number | 是 | 0 | 椭圆绘制的结束点角度,以弧度表示。 | +| anticlockwise | boolean | 否 | false | 是否以逆时针方向绘制椭圆。 | -- 示例 +**示例:** ``` @Entry @@ -1361,15 +1381,15 @@ rect(x: number, y: number, width: number, height: number): void 创建矩形路径。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | - | y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ------ | ---- | ---- | ------------- | +| x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | +| y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | +| width | number | 是 | 0 | 指定矩形的宽度。 | +| height | number | 是 | 0 | 指定矩形的高度。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1403,7 +1423,7 @@ fill(): void 对封闭路径进行填充。 -- 示例 +**示例:** ``` @Entry @Component @@ -1437,7 +1457,7 @@ clip(): void 设置当前路径为剪切路径。 -- 示例 +**示例:** ``` @Entry @Component @@ -1474,12 +1494,12 @@ rotate(rotate: number): void 针对当前坐标轴进行顺时针旋转。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------ | ------ | ---- | ---- | ---------------------------------------- | - | rotate | number | 是 | 0 | 设置顺时针旋转的弧度值,可以通过Math.PI / 180将角度转换为弧度值。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ------ | ---- | ---- | ---------------------------------------- | +| rotate | number | 是 | 0 | 设置顺时针旋转的弧度值,可以通过Math.PI / 180将角度转换为弧度值。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1513,13 +1533,13 @@ scale(x: number, y: number): void 设置canvas画布的缩放变换属性,后续的绘制操作将按照缩放比例进行缩放。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | ----------- | - | x | number | 是 | 0 | 设置水平方向的缩放值。 | - | y | number | 是 | 0 | 设置垂直方向的缩放值。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ----------- | +| x | number | 是 | 0 | 设置水平方向的缩放值。 | +| y | number | 是 | 0 | 设置垂直方向的缩放值。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1554,24 +1574,24 @@ transform(scaleX: number, skewX: number, skewY: number, scaleY: number, translat transform方法对应一个变换矩阵,想对一个图形进行变化的时候,只要设置此变换矩阵相应的参数,对图形的各个定点的坐标分别乘以这个矩阵,就能得到新的定点的坐标。矩阵变换效果可叠加。 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标): +> **说明:** +> 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标): > -> - x' = scaleX \* x + skewY \* y + translateX +> - x' = scaleX \* x + skewY \* y + translateX > -> - y' = skewX \* x + scaleY \* y + translateY - -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---------- | ------ | ---- | ---- | -------- | - | scaleX | number | 是 | 0 | 指定水平缩放值。 | - | skewX | number | 是 | 0 | 指定水平倾斜值。 | - | skewY | number | 是 | 0 | 指定垂直倾斜值。 | - | scaleY | number | 是 | 0 | 指定垂直缩放值。 | - | translateX | number | 是 | 0 | 指定水平移动值。 | - | translateY | number | 是 | 0 | 指定垂直移动值。 | - -- 示例 +> - y' = skewX \* x + scaleY \* y + translateY + +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---------- | ------ | ---- | ---- | -------- | +| scaleX | number | 是 | 0 | 指定水平缩放值。 | +| skewX | number | 是 | 0 | 指定水平倾斜值。 | +| skewY | number | 是 | 0 | 指定垂直倾斜值。 | +| scaleY | number | 是 | 0 | 指定垂直缩放值。 | +| translateX | number | 是 | 0 | 指定水平移动值。 | +| translateY | number | 是 | 0 | 指定垂直移动值。 | + +**示例:** ``` @Entry @Component @@ -1611,17 +1631,17 @@ setTransform(scaleX: number, skewX: number, skewY: number, scale: number, transl setTransfrom方法使用的参数和transform()方法相同,但setTransform()方法会重置现有的变换矩阵并创建新的变换矩阵。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---------- | ------ | ---- | ---- | -------- | - | scaleX | number | 是 | 0 | 指定水平缩放值。 | - | skewX | number | 是 | 0 | 指定水平倾斜值。 | - | skewY | number | 是 | 0 | 指定垂直倾斜值。 | - | scaleY | number | 是 | 0 | 指定垂直缩放值。 | - | translateX | number | 是 | 0 | 指定水平移动值。 | - | translateY | number | 是 | 0 | 指定垂直移动值。 | - -- 示例 +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---------- | ------ | ---- | ---- | -------- | +| scaleX | number | 是 | 0 | 指定水平缩放值。 | +| skewX | number | 是 | 0 | 指定水平倾斜值。 | +| skewY | number | 是 | 0 | 指定垂直倾斜值。 | +| scaleY | number | 是 | 0 | 指定垂直缩放值。 | +| translateX | number | 是 | 0 | 指定水平移动值。 | +| translateY | number | 是 | 0 | 指定垂直移动值。 | + +**示例:** ``` @Entry @Component @@ -1658,13 +1678,13 @@ translate(x: number, y: number): void 移动当前坐标系的原点。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | -------- | - | x | number | 是 | 0 | 设置水平平移量。 | - | y | number | 是 | 0 | 设置竖直平移量。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------- | +| x | number | 是 | 0 | 设置水平平移量。 | +| y | number | 是 | 0 | 设置竖直平移量。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1703,21 +1723,21 @@ drawImage(image: ImageBitmap | PixelMap, sx: number, sy: number, sWidth: number, 进行图像绘制。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | image | [ImageBitmap](ts-components-canvas-imagebitmap.md)或[PixelMap](../apis/js-apis-image.md#pixelmap7) | 是 | null | 图片资源,请参考ImageBitmap或PixelMap。 | - | sx | number | 否 | 0 | 裁切源图像时距离源图像左上角的x坐标值。 | - | sy | number | 否 | 0 | 裁切源图像时距离源图像左上角的y坐标值。 | - | sWidth | number | 否 | 0 | 裁切源图像时需要裁切的宽度。 | - | sHeight | number | 否 | 0 | 裁切源图像时需要裁切的高度。 | - | dx | number | 是 | 0 | 绘制区域左上角在x轴的位置。 | - | dy | number | 是 | 0 | 绘制区域左上角在y 轴的位置。 | - | dWidth | number | 否 | 0 | 绘制区域的宽度。 当绘制区域的宽度和裁剪图像的宽度不一致时,将图像宽度拉伸或压缩为绘制区域的宽度。 | - | dHeight | number | 否 | 0 | 绘制区域的高度。 当绘制区域的高度和裁剪图像的高度不一致时,将图像高度拉伸或压缩为绘制区域的高度。 | - - -- 示例 +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| image | [ImageBitmap](ts-components-canvas-imagebitmap.md)或[PixelMap](../apis/js-apis-image.md#pixelmap7) | 是 | null | 图片资源,请参考ImageBitmap或PixelMap。 | +| sx | number | 否 | 0 | 裁切源图像时距离源图像左上角的x坐标值。 | +| sy | number | 否 | 0 | 裁切源图像时距离源图像左上角的y坐标值。 | +| sWidth | number | 否 | 0 | 裁切源图像时需要裁切的宽度。 | +| sHeight | number | 否 | 0 | 裁切源图像时需要裁切的高度。 | +| dx | number | 是 | 0 | 绘制区域左上角在x轴的位置。 | +| dy | number | 是 | 0 | 绘制区域左上角在y 轴的位置。 | +| dWidth | number | 否 | 0 | 绘制区域的宽度。 当绘制区域的宽度和裁剪图像的宽度不一致时,将图像宽度拉伸或压缩为绘制区域的宽度。 | +| dHeight | number | 否 | 0 | 绘制区域的高度。 当绘制区域的高度和裁剪图像的高度不一致时,将图像高度拉伸或压缩为绘制区域的高度。 | + + +**示例:** ``` @Entry @Component @@ -1750,11 +1770,11 @@ createImageData(width: number, height: number): Object 创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagebitmap.md)。 -- 参数 - | 参数 | 类型 | 必填 | 默认 | 描述 | - | ------ | ------ | ---- | ---- | ------------- | - | width | number | 是 | 0 | ImageData的宽度。 | - | height | number | 是 | 0 | ImageData的高度。 | +**参数:** +| 参数 | 类型 | 必填 | 默认 | 描述 | +| ------ | ------ | ---- | ---- | ------------- | +| width | number | 是 | 0 | ImageData的宽度。 | +| height | number | 是 | 0 | ImageData的高度。 | ### createImageData @@ -1763,36 +1783,36 @@ createImageData(imageData: Object): Object 创建新的ImageData 对象,请参考[ImageData](ts-components-canvas-imagebitmap.md)。 -- 参数 - | 参数 | 类型 | 必填 | 默认 | 描述 | - | --------- | ------ | ---- | ---- | ----------------- | - | imagedata | Object | 是 | null | 复制现有的ImageData对象。 | +**参数:** +| 参数 | 类型 | 必填 | 默认 | 描述 | +| --------- | ------ | ---- | ---- | ----------------- | +| imagedata | Object | 是 | null | 复制现有的ImageData对象。 | ### getPixelMap getPixelMap(sx: number, sy: number, sw: number, sh: number): PixelMap 以当前canvas指定区域内的像素创建[PixelMap](../apis/js-apis-image.md#pixelmap7)对象。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------------- | - | sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | - | sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | - | sw | number | 是 | 0 | 需要输出的区域的宽度。 | - | sh | number | 是 | 0 | 需要输出的区域的高度。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | --------------- | +| sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | +| sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | +| sw | number | 是 | 0 | 需要输出的区域的宽度。 | +| sh | number | 是 | 0 | 需要输出的区域的高度。 | ### getImageData getImageData(sx: number, sy: number, sw: number, sh: number): Object 以当前canvas指定区域内的像素创建[ImageData](ts-components-canvas-imagebitmap.md)对象。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | --------------- | - | sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | - | sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | - | sw | number | 是 | 0 | 需要输出的区域的宽度。 | - | sh | number | 是 | 0 | 需要输出的区域的高度。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | --------------- | +| sx | number | 是 | 0 | 需要输出的区域的左上角x坐标。 | +| sy | number | 是 | 0 | 需要输出的区域的左上角y坐标。 | +| sw | number | 是 | 0 | 需要输出的区域的宽度。 | +| sh | number | 是 | 0 | 需要输出的区域的高度。 | ### putImageData @@ -1801,18 +1821,18 @@ putImageData(imageData: Object, dx: number, dy: number, dirtyX?: number, dirtyY? 使用[ImageData](ts-components-canvas-imagebitmap.md)数据填充新的矩形区域。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ----------- | ------ | ---- | ------------ | ----------------------------- | - | imagedata | Object | 是 | null | 包含像素值的ImageData对象。 | - | dx | number | 是 | 0 | 填充区域在x轴方向的偏移量。 | - | dy | number | 是 | 0 | 填充区域在y轴方向的偏移量。 | - | dirtyX | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | - | dirtyY | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | - | dirtyWidth | number | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | - | dirtyHeight | number | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | - -- 示例 +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ----------- | ------ | ---- | ------------ | ----------------------------- | +| imagedata | Object | 是 | null | 包含像素值的ImageData对象。 | +| dx | number | 是 | 0 | 填充区域在x轴方向的偏移量。 | +| dy | number | 是 | 0 | 填充区域在y轴方向的偏移量。 | +| dirtyX | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的x轴偏移量。 | +| dirtyY | number | 否 | 0 | 源图像数据矩形裁切范围左上角距离源图像左上角的y轴偏移量。 | +| dirtyWidth | number | 否 | imagedata的宽度 | 源图像数据矩形裁切范围的宽度。 | +| dirtyHeight | number | 否 | imagedata的高度 | 源图像数据矩形裁切范围的高度。 | + +**示例:** ``` @Entry @Component @@ -1852,7 +1872,7 @@ restore(): void 对保存的绘图上下文进行恢复。 -- 示例 +**示例:** ``` @Entry @Component @@ -1883,7 +1903,7 @@ save(): void 对当前的绘图上下文进行保存。 -- 示例 +**示例:** ``` @Entry @Component @@ -1914,15 +1934,15 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): void 创建一个线性渐变色。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | -------- | - | x0 | number | 是 | 0 | 起点的x轴坐标。 | - | y0 | number | 是 | 0 | 起点的y轴坐标。 | - | x1 | number | 是 | 0 | 终点的x轴坐标。 | - | y1 | number | 是 | 0 | 终点的y轴坐标。 | +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | -------- | +| x0 | number | 是 | 0 | 起点的x轴坐标。 | +| y0 | number | 是 | 0 | 起点的y轴坐标。 | +| x1 | number | 是 | 0 | 终点的x轴坐标。 | +| y1 | number | 是 | 0 | 终点的y轴坐标。 | -- 示例 +**示例:** ``` @Entry @Component @@ -1960,17 +1980,17 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, 创建一个径向渐变色。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | ---- | ------ | ---- | ---- | ----------------- | - | x0 | number | 是 | 0 | 起始圆的x轴坐标。 | - | y0 | number | 是 | 0 | 起始圆的y轴坐标。 | - | r0 | number | 是 | 0 | 起始圆的半径。必须是非负且有限的。 | - | x1 | number | 是 | 0 | 终点圆的x轴坐标。 | - | y1 | number | 是 | 0 | 终点圆的y轴坐标。 | - | r1 | number | 是 | 0 | 终点圆的半径。必须为非负且有限的。 | - -- 示例 +**参数:** +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ---- | ------ | ---- | ---- | ----------------- | +| x0 | number | 是 | 0 | 起始圆的x轴坐标。 | +| y0 | number | 是 | 0 | 起始圆的y轴坐标。 | +| r0 | number | 是 | 0 | 起始圆的半径。必须是非负且有限的。 | +| x1 | number | 是 | 0 | 终点圆的x轴坐标。 | +| y1 | number | 是 | 0 | 终点圆的y轴坐标。 | +| r1 | number | 是 | 0 | 终点圆的半径。必须为非负且有限的。 | + +**示例:** ``` @Entry @Component diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md b/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md index f191e2dc2335c0d0c3f08a8b49c08d1abd85be2c..391e14147694953eddcc178a7b91708a9d860670 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md @@ -1,7 +1,8 @@ # 组合手势 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -13,30 +14,32 @@ GestureGroup(mode: GestureMode, ...gesture: GestureType[]) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | mode | GestureMode | 是 | - | 设置组合手势识别模式。 | - | gesture | [TapGesture](ts-basic-gestures-tapgesture.md)
\| [LongPressGesture](ts-basic-gestures-longpressgesture.md)
\| [PanGesture](ts-basic-gestures-pangesture.md)
\| [PinchGesture](ts-basic-gestures-pinchgesture.md)
\| [RotationGesture](ts-basic-gestures-rotationgesture.md) | 是 | - | 可变长参数,1个或者多个基础手势类型,这些手势会被组合识别。 | +**参数:** -- GestureMode枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Sequence | 顺序识别,按照手势的注册顺序识别手势,直到所有手势识别成功。当有一个手势识别失败时,所有手势识别失败。 | - | Parallel | 并发识别,注册的手势同时识别,直到所有手势识别结束,手势识别互相不影响。 | - | Exclusive | 互斥识别,注册的手势同时识别,若有一个手势识别成功,则结束手势识别。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ---------------------------------------- | ---- | ---- | ------------------------------ | +| mode | GestureMode | 是 | - | 设置组合手势识别模式。 | +| gesture | [TapGesture](ts-basic-gestures-tapgesture.md)
\| [LongPressGesture](ts-basic-gestures-longpressgesture.md)
\| [PanGesture](ts-basic-gestures-pangesture.md)
\| [PinchGesture](ts-basic-gestures-pinchgesture.md)
\| [RotationGesture](ts-basic-gestures-rotationgesture.md) | 是 | - | 可变长参数,1个或者多个基础手势类型,这些手势会被组合识别。 | +## GestureMode枚举说明 + +| 名称 | 描述 | +| --------- | ---------------------------------------- | +| Sequence | 顺序识别,按照手势的注册顺序识别手势,直到所有手势识别成功。当有一个手势识别失败时,所有手势识别失败。 | +| Parallel | 并发识别,注册的手势同时识别,直到所有手势识别结束,手势识别互相不影响。 | +| Exclusive | 互斥识别,注册的手势同时识别,若有一个手势识别成功,则结束手势识别。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ------------------------------------ | | onCancel(event: () => void) | 顺序组合手势(GestureMode.Sequence)取消后触发回调。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct GestureGroupExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvas.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvas.md index ea1d29106df1db7eedb5b28b8cec9fd43f5a51d1..32a14b8bc4e168b013a9f8380f68e43c1cb56231 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvas.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvas.md @@ -1,6 +1,8 @@ # Canvas -> ![img](public_sys-resources/icon-note.gif) **说明:** 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 提供画布组件,用于自定义绘制图形。 @@ -16,11 +18,11 @@ Canvas(context: CanvasRenderingContext2D) -- 参数 +**参数:** - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ------- | ---------------------------------------- | ---- | ---- | ---------------------------- | - | context | [CanvasRenderingContext2D](ts-canvasrenderingcontext2d.md) | 是 | - | 见CanvasRenderingContext2D对象。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ---------------------------------------- | ---- | ---- | ---------------------------- | +| context | [CanvasRenderingContext2D](ts-canvasrenderingcontext2d.md) | 是 | - | 见CanvasRenderingContext2D对象。 | ## 属性 @@ -36,7 +38,8 @@ Canvas(context: CanvasRenderingContext2D) ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct CanvasExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvasgradient.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvasgradient.md index aa0bc39520f2a1ea4dd66a314cb875425d0a339a..22b76489fe350fed7e67af969241eadb533a3487 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvasgradient.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-canvasgradient.md @@ -1,7 +1,8 @@ # CanvasGradient对象 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 渐变对象。 @@ -13,39 +14,41 @@ addColorStop(offset: number, color: string): void 设置渐变断点值,包括偏移和颜色。 -- 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | offset | number | 是 | 0 | 设置渐变点距离起点的位置占总体长度的比例,范围为0到1。 | - | color | string | 是 | 'ffffff' | 设置渐变的颜色。 | - -- 示例 - ``` - @Entry - @Component - struct Page45 { - private settings: RenderingContextSettings = new RenderingContextSettings(true) - private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) - - build() { - Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { - Canvas(this.context) - .width('100%') - .height('100%') - .backgroundColor('#ffff00') - .onReady(() =>{ - var grad = this.context.createLinearGradient(50,0, 300,100) - grad.addColorStop(0.0, 'red') - grad.addColorStop(0.5, 'white') - grad.addColorStop(1.0, 'green') - this.context.fillStyle = grad - this.context.fillRect(0, 0, 500, 500) - }) - } - .width('100%') - .height('100%') +**参数:** + +| 参数 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ------ | ---- | -------- | ---------------------------- | +| offset | number | 是 | 0 | 设置渐变点距离起点的位置占总体长度的比例,范围为0到1。 | +| color | string | 是 | 'ffffff' | 设置渐变的颜色。 | + +**示例:** + +```ts +@Entry +@Component +struct Page45 { + private settings: RenderingContextSettings = new RenderingContextSettings(true) + private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) + + build() { + Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { + Canvas(this.context) + .width('100%') + .height('100%') + .backgroundColor('#ffff00') + .onReady(() =>{ + var grad = this.context.createLinearGradient(50,0, 300,100) + grad.addColorStop(0.0, 'red') + grad.addColorStop(0.5, 'white') + grad.addColorStop(1.0, 'green') + this.context.fillStyle = grad + this.context.fillRect(0, 0, 500, 500) + }) } + .width('100%') + .height('100%') } - ``` +} +``` - ![zh-cn_image_0000001194032516](figures/zh-cn_image_0000001194032516.png) +![zh-cn_image_0000001194032516](figures/zh-cn_image_0000001194032516.png) \ No newline at end of file diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagebitmap.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagebitmap.md index 4d29fbf8f32a1071465cc7c31be6fb0242c4a957..503f356cdfb8a25f2fd707d7f910198f409a4322 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagebitmap.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagebitmap.md @@ -1,7 +1,8 @@ # ImageBitmap对象 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 CanvasImageData对象可以存储canvas渲染的像素数据。 @@ -9,8 +10,8 @@ CanvasImageData对象可以存储canvas渲染的像素数据。 ## 属性 -| 属性 | 类型 | 描述 | -| -------- | -------- | -------- | -| width | number | 矩形区域实际像素宽度。 | -| height | number | 矩形区域实际像素高度。 | -| data | <Uint8ClampedArray> | 一维数组,保存了相应的颜色数据,数据值范围为0到255。 | +| 属性 | 类型 | 描述 | +| ------ | ------------------------- | ---------------------------- | +| width | number | 矩形区域实际像素宽度。 | +| height | number | 矩形区域实际像素高度。 | +| data | <Uint8ClampedArray> | 一维数组,保存了相应的颜色数据,数据值范围为0到255。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagedata.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagedata.md index 2e5d0d3546dad89a41f8fba0989681d50f4fbeae..7a0306444c98c9e9f42f4d966d7515813c554bc5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagedata.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagedata.md @@ -1,7 +1,8 @@ # ImageData对象 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ImageData对象可以存储canvas渲染的像素数据。 @@ -9,8 +10,8 @@ ImageData对象可以存储canvas渲染的像素数据。 ## 属性 -| 属性 | 类型 | 描述 | -| -------- | -------- | -------- | -| width | number | 矩形区域实际像素宽度。 | -| height | number | 矩形区域实际像素高度。 | -| data | <Uint8ClampedArray> | 一维数组,保存了相应的颜色数据,数据值范围为0到255。 | +| 属性 | 类型 | 描述 | +| ------ | ------------------------- | ---------------------------- | +| width | number | 矩形区域实际像素宽度。 | +| height | number | 矩形区域实际像素高度。 | +| data | <Uint8ClampedArray> | 一维数组,保存了相应的颜色数据,数据值范围为0到255。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md index 15faeda1b25d7c00c560c380620ebe4e9add4d6d..68a709edb5bb657b47eef303399006f31d53f774 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-lottie.md @@ -1,7 +1,8 @@ # Lottie -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -15,8 +16,8 @@ import lottie from '@ohos/lottieETS' ``` -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 在Terminal窗口使用 `npm install @ohos/lottieETS` 命令下载Lottie。 +> **说明:** +> 在Terminal窗口使用 `npm install @ohos/lottieETS` 命令下载Lottie。 ## lottie.loadAnimation diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-path2d.md b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-path2d.md index 34e25b16a7a35c3985ad2fb73dd68b0ceed719fa..e457d286728476cdd8a566903c5622843104270f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-path2d.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-path2d.md @@ -1,7 +1,8 @@ # Path2D对象 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 路径对象,支持通过对象的接口进行路径的描述,并通过Canvas的stroke接口进行绘制。 @@ -14,9 +15,9 @@ addPath(path: Object): void 将另一个路径添加到当前的路径对象中。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | path | Object | 是 | null | 需要添加到当前路径的路径对象 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | -------------- | + | path | Object | 是 | null | 需要添加到当前路径的路径对象 | - 示例 ``` @@ -25,10 +26,10 @@ addPath(path: Object): void struct AddPath { private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) - + private path2Da: Path2D = new Path2D("M250 150 L150 350 L350 350 Z") private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -63,7 +64,7 @@ closePath(): void private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -94,10 +95,10 @@ moveTo(x: number, y: number): void 将路径的当前坐标点移动到目标点,移动过程中不绘制线条。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 目标点X轴坐标 | - | y | number | 是 | 0 | 目标点Y轴坐标 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | ------- | + | x | number | 是 | 0 | 目标点X轴坐标 | + | y | number | 是 | 0 | 目标点Y轴坐标 | - 示例 ``` @@ -107,7 +108,7 @@ moveTo(x: number, y: number): void private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -138,10 +139,10 @@ lineTo(x: number, y: number): void 从当前点绘制一条直线到目标点。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 目标点X轴坐标 | - | y | number | 是 | 0 | 目标点Y轴坐标 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | ------- | + | x | number | 是 | 0 | 目标点X轴坐标 | + | y | number | 是 | 0 | 目标点Y轴坐标 | - 示例 ``` @@ -151,7 +152,7 @@ lineTo(x: number, y: number): void private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -183,14 +184,14 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, 创建三次贝赛尔曲线的路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | - | cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | - | cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | - | cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | -------------- | + | cp1x | number | 是 | 0 | 第一个贝塞尔参数的x坐标值。 | + | cp1y | number | 是 | 0 | 第一个贝塞尔参数的y坐标值。 | + | cp2x | number | 是 | 0 | 第二个贝塞尔参数的x坐标值。 | + | cp2y | number | 是 | 0 | 第二个贝塞尔参数的y坐标值。 | + | x | number | 是 | 0 | 路径结束时的x坐标值。 | + | y | number | 是 | 0 | 路径结束时的y坐标值。 | - 示例 ``` @@ -200,7 +201,7 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -228,12 +229,12 @@ quadraticCurveTo(cpx: number, cpy: number, x: number ,y: number): void 创建二次贝赛尔曲线的路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | - | cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | - | x | number | 是 | 0 | 路径结束时的x坐标值。 | - | y | number | 是 | 0 | 路径结束时的y坐标值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ---- | ------ | ---- | ---- | ----------- | + | cpx | number | 是 | 0 | 贝塞尔参数的x坐标值。 | + | cpy | number | 是 | 0 | 贝塞尔参数的y坐标值。 | + | x | number | 是 | 0 | 路径结束时的x坐标值。 | + | y | number | 是 | 0 | 路径结束时的y坐标值。 | - 示例 ``` @@ -243,7 +244,7 @@ quadraticCurveTo(cpx: number, cpy: number, x: number ,y: number): void private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -272,14 +273,14 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, 绘制弧线路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 弧线圆心的x坐标值。 | - | y | number | 是 | 0 | 弧线圆心的y坐标值。 | - | radius | number | 是 | 0 | 弧线的圆半径。 | - | startAngle | number | 是 | 0 | 弧线的起始弧度。 | - | endAngle | number | 是 | 0 | 弧线的终止弧度。 | - | anticlockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------------- | ------- | ---- | ----- | ---------- | + | x | number | 是 | 0 | 弧线圆心的x坐标值。 | + | y | number | 是 | 0 | 弧线圆心的y坐标值。 | + | radius | number | 是 | 0 | 弧线的圆半径。 | + | startAngle | number | 是 | 0 | 弧线的起始弧度。 | + | endAngle | number | 是 | 0 | 弧线的终止弧度。 | + | anticlockwise | boolean | 否 | false | 是否逆时针绘制圆弧。 | - 示例 ``` @@ -289,7 +290,7 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -316,13 +317,13 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void 依据圆弧经过的点和圆弧半径创建圆弧路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | - | y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | - | x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | - | y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | - | radius | number | 是 | 0 | 圆弧的圆半径值。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------ | ------ | ---- | ---- | --------------- | + | x1 | number | 是 | 0 | 圆弧经过的第一个点的x坐标值。 | + | y1 | number | 是 | 0 | 圆弧经过的第一个点的y坐标值。 | + | x2 | number | 是 | 0 | 圆弧经过的第二个点的x坐标值。 | + | y2 | number | 是 | 0 | 圆弧经过的第二个点的y坐标值。 | + | radius | number | 是 | 0 | 圆弧的圆半径值。 | - 示例 ``` @@ -332,7 +333,7 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -360,16 +361,16 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number 在规定的矩形区域绘制一个椭圆。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | - | y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | - | radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | - | radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | - | rotation | number | 是 | 0 | 椭圆的旋转角度,单位为弧度。 | - | startAngle | number | 是 | 0 | 椭圆绘制的起始点角度,以弧度表示。 | - | endAngle | number | 是 | 0 | 椭圆绘制的结束点角度,以弧度表示。 | - | anticlockwise | number | 否 | 0 | 是否以逆时针方向绘制椭圆,0为顺时针,1为逆时针。(可选参数,默认为0) | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------------- | ------ | ---- | ---- | ------------------------------------ | + | x | number | 是 | 0 | 椭圆圆心的x轴坐标。 | + | y | number | 是 | 0 | 椭圆圆心的y轴坐标。 | + | radiusX | number | 是 | 0 | 椭圆x轴的半径长度。 | + | radiusY | number | 是 | 0 | 椭圆y轴的半径长度。 | + | rotation | number | 是 | 0 | 椭圆的旋转角度,单位为弧度。 | + | startAngle | number | 是 | 0 | 椭圆绘制的起始点角度,以弧度表示。 | + | endAngle | number | 是 | 0 | 椭圆绘制的结束点角度,以弧度表示。 | + | anticlockwise | number | 否 | 0 | 是否以逆时针方向绘制椭圆,0为顺时针,1为逆时针。(可选参数,默认为0) | - 示例 ``` @@ -379,7 +380,7 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) @@ -407,12 +408,12 @@ rect(x: number, y: number, width: number, height: number): void 创建矩形路径。 - 参数 - | 参数 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | - | y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | - | width | number | 是 | 0 | 指定矩形的宽度。 | - | height | number | 是 | 0 | 指定矩形的高度。 | + | 参数 | 类型 | 必填 | 默认值 | 描述 | + | ------ | ------ | ---- | ---- | ------------- | + | x | number | 是 | 0 | 指定矩形的左上角x坐标值。 | + | y | number | 是 | 0 | 指定矩形的左上角y坐标值。 | + | width | number | 是 | 0 | 指定矩形的宽度。 | + | height | number | 是 | 0 | 指定矩形的高度。 | - 示例 ``` @@ -422,7 +423,7 @@ rect(x: number, y: number, width: number, height: number): void private settings: RenderingContextSettings = new RenderingContextSettings(true) private context: CanvasRenderingContext2D = new CanvasRenderingContext2D(this.settings) private path2Db: Path2D = new Path2D() - + build() { Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { Canvas(this.context) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md index 7ff4c1b32b752117270cbd503aaeb3787da8615d..07fc48d403c96427080e2ae8d5433589c669cb95 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md @@ -1,12 +1,10 @@ # AlphabetIndexer -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 字母索引条。 - +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -22,48 +20,49 @@ AlphabetIndexer(value: {arrayValue : Array<string>, selected : number}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | arrayValue | Array<string> | 是 | - | 字母索引字符串数组。 | - | selected | number | 是 | - | 选中项编号。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---------- | ------------------- | ---- | ---- | ---------- | +| arrayValue | Array<string> | 是 | - | 字母索引字符串数组。 | +| selected | number | 是 | - | 选中项编号。 | ## 属性 -| 名称 | 参数类型 | 描述 | -| -------- | -------- | -------- | -| selectedColor | Color | 选中文本文字颜色。 | -| popupColor | Color | 弹出提示文本字体颜色。 | -| selectedBackgroundColor | Color | 选中文本背景颜色。 | -| popupBackground | Color | 弹窗索引背景色。 | -| usingPopup | boolean | 是否使用弹出索引提示。 | -| selectedFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 选中文本文字样式。 | -| popupFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 弹出提示文本字体样式。 | -| font | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 字母索引条默认文本字体样式。 | -| itemSize | Length | 字母索引条字母区域大小,字母区域为正方形,设置正方形边长。 | -| alignStyle | IndexerAlign | 字母索引条对齐样式,支持左侧对齐样式与右侧对齐样式,影响弹窗弹出位置。 | - -- IndexerAlign枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Left | 弹框显示在索引条右侧。 | - | Right | 弹框显示在索引条左侧。 | - +| 名称 | 参数类型 | 描述 | +| ----------------------- | ---------------------------------------- | ----------------------------------- | +| selectedColor | Color | 选中文本文字颜色。 | +| popupColor | Color | 弹出提示文本字体颜色。 | +| selectedBackgroundColor | Color | 选中文本背景颜色。 | +| popupBackground | Color | 弹窗索引背景色。 | +| usingPopup | boolean | 是否使用弹出索引提示。 | +| selectedFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 选中文本文字样式。 | +| popupFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 弹出提示文本字体样式。 | +| font | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 字母索引条默认文本字体样式。 | +| itemSize | Length | 字母索引条字母区域大小,字母区域为正方形,设置正方形边长。 | +| alignStyle | IndexerAlign | 字母索引条对齐样式,支持左侧对齐样式与右侧对齐样式,影响弹窗弹出位置。 | + +## IndexerAlign枚举说明 + +| 名称 | 描述 | +| ----- | ----------- | +| Left | 弹框显示在索引条右侧。 | +| Right | 弹框显示在索引条左侧。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onSelected(index: number) => void(deprecated) | 索引条选中回调。 | -| onSelect(index: number) => void8+ | 索引条选中回调。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onSelected(index: number) => void(deprecated) | 索引条选中回调。 | +| onSelect(index: number) => void8+ | 索引条选中回调。 | | onRequestPopupData(callback: (index: number) => Array<string>)8+ | 选中字母索引后,请求索引提示窗口显示内容回调。
返回值:索引对应的字符串数组,此字符串数组在弹出窗口中竖排显示,字符串列表最多显示5个,超出部分可以滑动显示。 | -| onPopupSelect(callback: (index: number) => void)8+ | 字母索引提示窗口选中回调。 | +| onPopupSelect(callback: (index: number) => void)8+ | 字母索引提示窗口选中回调。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct AlphabetIndexerSample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md index 3c2159a08da2df72870e4edb268de33916722e0b..e46016e32002286fd98d4c305aaee07b77715bd5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md @@ -1,7 +1,8 @@ # Badge -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 新事件标记组件,在组件上提供事件信息展示能力。 @@ -21,44 +22,48 @@ Badge(value: {count: number, position?: BadgePosition, maxCount?: number, style?: BadgeStyle}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | count | number | 是 | - | 设置提醒消息数。 | - | position | BadgePosition | 否 | BadgePosition.RightTop | 设置提示点显示位置。 | - | maxCount | number | 否 | 99 | 最大消息数,超过最大消息时仅显示maxCount+。 | - | style | BadgeStyle | 否 | - | Badge组件可设置样式,支持设置文本颜色、尺寸、圆点颜色和尺寸。 | +**参数:** + +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------- | ------------- | ---- | ---------------------- | --------------------------------- | +| count | number | 是 | - | 设置提醒消息数。 | +| position | BadgePosition | 否 | BadgePosition.RightTop | 设置提示点显示位置。 | +| maxCount | number | 否 | 99 | 最大消息数,超过最大消息时仅显示maxCount+。 | +| style | BadgeStyle | 否 | - | Badge组件可设置样式,支持设置文本颜色、尺寸、圆点颜色和尺寸。 | Badge(value: {value: string, position?: BadgePosition, style?: BadgeStyle}) 根据字符串创建提醒组件。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | string | 是 | - | 提示内容的文本字符串。 | - | position | BadgePosition | 否 | BadgePosition.RightTop | 设置提示点显示位置。 | - | style | BadgeStyle | 否 | - | Badge组件可设置样式,支持设置文本颜色、尺寸、圆点颜色和尺寸。 | - -- BadgeStyle对象说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | color | Color | 否 | Color.White | 文本颜色。 | - | fontSize | number \| string | 否 | 10 | 文本大小。 | - | badgeSize | number \| string | 是 | - | badge的大小。 | - | badgeColor | Color | 否 | Color.Red | badge的颜色。 | - -- BadgePosition枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Right | 圆点显示在右侧纵向居中。 | - | RightTop | 圆点显示在右上角。 | - | Left | 圆点显示在左侧纵向居中。 | +**参数:** + +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------- | ------------- | ---- | ---------------------- | --------------------------------- | +| value | string | 是 | - | 提示内容的文本字符串。 | +| position | BadgePosition | 否 | BadgePosition.RightTop | 设置提示点显示位置。 | +| style | BadgeStyle | 否 | - | Badge组件可设置样式,支持设置文本颜色、尺寸、圆点颜色和尺寸。 | + +## BadgeStyle对象说明 +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| ---------- | -------------------------- | ---- | ----------- | --------- | +| color | Color | 否 | Color.White | 文本颜色。 | +| fontSize | number \| string | 否 | 10 | 文本大小。 | +| badgeSize | number \| string | 是 | - | badge的大小。 | +| badgeColor | Color | 否 | Color.Red | badge的颜色。 | + +## BadgePosition枚举说明 + +| 名称 | 描述 | +| -------- | ------------ | +| Right | 圆点显示在右侧纵向居中。 | +| RightTop | 圆点显示在右上角。 | +| Left | 圆点显示在左侧纵向居中。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct BadgeExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md index 42bf03f17d543448f2172098b54817a1003d100e..b6f8c14612dba32eebbbeccf8815a7c0f24dad6b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md @@ -1,11 +1,11 @@ # Column -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 沿垂直方向布局的容器。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,32 +21,32 @@ Column(value:{space?: Length}) +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | space | Length | 否 | 0 | 纵向布局元素间距。 | - +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | --------- | +| space | Length | 否 | 0 | 纵向布局元素间距。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| alignItems | HorizontalAlign | HorizontalAlign.Center | 设置子组件在水平方向上的对齐格式。 | -| justifyContent8+ | [FlexAlign](ts-container-flex.md) | FlexAlign.Start | 设置子组件在垂直方向上的对齐格式。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------------- | --------------------------------- | ---------------------- | ----------------- | +| alignItems | HorizontalAlign | HorizontalAlign.Center | 设置子组件在水平方向上的对齐格式。 | +| justifyContent8+ | [FlexAlign](ts-container-flex.md) | FlexAlign.Start | 设置子组件在垂直方向上的对齐格式。 | -- HorizontalAlign枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Start | 按照语言方向起始端对齐。 | - | Center | 居中对齐,默认对齐方式。 | - | End | 按照语言方向末端对齐。 | +## HorizontalAlign枚举说明 +| 名称 | 描述 | +| ------ | ------------ | +| Start | 按照语言方向起始端对齐。 | +| Center | 居中对齐,默认对齐方式。 | +| End | 按照语言方向末端对齐。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ColumnExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-columnsplit.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-columnsplit.md index 184d4e6c6f0b5c70d60f8a46ea4a7cc16e065053..22351db03f2ec17d82abc55efc5326868acad0fd 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-columnsplit.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-columnsplit.md @@ -1,11 +1,11 @@ # ColumnSplit -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 将子组件纵向布局,并在每个子组件之间插入一根横向的分割线。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -24,17 +24,18 @@ ColumnSplit() ## 属性 -| 名称 | 参数类型 | 描述 | -| -------- | -------- | -------- | -| resizeable | boolean | 分割线是否可拖拽,默认为false。 | +| 名称 | 参数类型 | 描述 | +| ---------- | ------- | ------------------ | +| resizeable | boolean | 分割线是否可拖拽,默认为false。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 与RowSplit相同,ColumnSplit的分割线最小能拖动到刚好包含子组件。 +> **说明:** +> 与RowSplit相同,ColumnSplit的分割线最小能拖动到刚好包含子组件。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ColumnSplitExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-counter.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-counter.md index 1a3f71f9a886de0a44220ebfaa5f1e81de435e01..4eb113fba9c3f3a8cc0ae37aad2cc63875c61aa9 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-counter.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-counter.md @@ -1,7 +1,8 @@ # Counter -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 计数器组件,提供相应的增加或者减少的计数操作。 @@ -26,15 +27,16 @@ Counter() 不支持通用事件和手势, 仅支持如下事件: -| 名称 | 功能描述 | -| -------- | -------- | -| onInc(event: () => void) | 监听数值增加事件。 | -| onDec(event: () => void) | 监听数值减少事件。 | +| 名称 | 功能描述 | +| ---------------------------------------- | --------- | +| onInc(event: () => void) | 监听数值增加事件。 | +| onDec(event: () => void) | 监听数值减少事件。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct CounterExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md index abf5d65e286590e35f670f8e636ef2b9310d6964..11b41334040d4c7b60b0f2cad0cd43f66019c5c8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md @@ -1,11 +1,11 @@ # Flex -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 弹性布局组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -23,40 +23,43 @@ Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: F 标准Flex布局容器。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | direction | FlexDirection | 否 | FlexDirection.Row | 子组件在Flex容器上排列的方向,即主轴的方向。 | - | wrap | FlexWrap | 否 | FlexWrap.NoWrap | Flex容器是单行/列还是多行/列排列。 | - | justifyContent | FlexAlign | 否 | FlexAlign.Start | 子组件在Flex容器主轴上的对齐格式。 | - | alignItems | [ItemAlign](ts-appendix-enums.md#itemalign枚举说明) | 否 | ItemAlign.Stretch | 子组件在Flex容器交叉轴上的对齐格式。 | - | alignContent | FlexAlign | 否 | FlexAlign.Start | 交叉轴中有额外的空间时,多行内容的对齐方式。仅在wrap为Wrap或WrapReverse下生效。 | - -- FlexDirection枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Row | 主轴与行方向一致作为布局模式。 | - | RowReverse | 与Row方向相反方向进行布局。 | - | Column | 主轴与列方向一致作为布局模式。 | - | ColumnReverse | 与Column相反方向进行布局。 | - -- FlexWrap枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | NoWrap | Flex容器的元素单行/列布局,子项不允许超出容器。 | - | Wrap | Flex容器的元素多行/列排布,子项允许超出容器。 | - | WrapReverse | Flex容器的元素反向多行/列排布,子项允许超出容器。 | - -- FlexAlign枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Start | 元素在主轴方向首端对齐, 第一个元素与行首对齐,同时后续的元素与前一个对齐。 | - | Center | 元素在主轴方向中心对齐,第一个元素与行首的距离与最后一个元素与行尾距离相同。 | - | End | 元素在主轴方向尾部对齐,  最后一个元素与行尾对齐,其他元素与后一个对齐。 | - | SpaceBetween | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。 第一个元素与行首对齐,最后一个元素与行尾对齐。 | - | SpaceAround | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。 第一个元素到行首的距离和最后一个元素到行尾的距离是相邻元素之间距离的一半。 | - | SpaceEvenly | Flex主轴方向元素等间距布局, 相邻元素之间的间距、第一个元素与行首的间距、最后一个元素到行尾的间距都完全一样。 | - +**参数:** + +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| -------------- | ---------------------------------------- | ---- | ----------------- | ---------------------------------------- | +| direction | FlexDirection | 否 | FlexDirection.Row | 子组件在Flex容器上排列的方向,即主轴的方向。 | +| wrap | FlexWrap | 否 | FlexWrap.NoWrap | Flex容器是单行/列还是多行/列排列。 | +| justifyContent | FlexAlign | 否 | FlexAlign.Start | 子组件在Flex容器主轴上的对齐格式。 | +| alignItems | [ItemAlign](ts-appendix-enums.md#itemalign枚举说明) | 否 | ItemAlign.Stretch | 子组件在Flex容器交叉轴上的对齐格式。 | +| alignContent | FlexAlign | 否 | FlexAlign.Start | 交叉轴中有额外的空间时,多行内容的对齐方式。仅在wrap为Wrap或WrapReverse下生效。 | + +## FlexDirection枚举说明 + +| 名称 | 描述 | +| ------------- | ---------------- | +| Row | 主轴与行方向一致作为布局模式。 | +| RowReverse | 与Row方向相反方向进行布局。 | +| Column | 主轴与列方向一致作为布局模式。 | +| ColumnReverse | 与Column相反方向进行布局。 | + +## FlexWrap枚举说明 + +| 名称 | 描述 | +| ----------- | --------------------------- | +| NoWrap | Flex容器的元素单行/列布局,子项不允许超出容器。 | +| Wrap | Flex容器的元素多行/列排布,子项允许超出容器。 | +| WrapReverse | Flex容器的元素反向多行/列排布,子项允许超出容器。 | + +## FlexAlign枚举说明 + +| 名称 | 描述 | +| ------------ | ---------------------------------------- | +| Start | 元素在主轴方向首端对齐, 第一个元素与行首对齐,同时后续的元素与前一个对齐。 | +| Center | 元素在主轴方向中心对齐,第一个元素与行首的距离与最后一个元素与行尾距离相同。 | +| End | 元素在主轴方向尾部对齐,  最后一个元素与行尾对齐,其他元素与后一个对齐。 | +| SpaceBetween | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。 第一个元素与行首对齐,最后一个元素与行尾对齐。 | +| SpaceAround | Flex主轴方向均匀分配弹性元素,相邻元素之间距离相同。 第一个元素到行首的距离和最后一个元素到行尾的距离是相邻元素之间距离的一半。 | +| SpaceEvenly | Flex主轴方向元素等间距布局, 相邻元素之间的间距、第一个元素与行首的间距、最后一个元素到行尾的间距都完全一样。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md index ee937be3a90c5e6e519c05a3e6ed29911f3145fc..867eb1359ab7b54ca19a9a0b17e6a69b2ec8f123 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md @@ -1,11 +1,10 @@ # Grid -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 网格容器,由“行”和“列”分割的单元格所组成,通过指定“项目”所在的单元格做出各种各样的布局。 - +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -46,7 +45,8 @@ Grid() ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct GridExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md index b90566a04ba55389ccc14135cc5afd6face5f36a..51e10bb92756b345c0ca2cce102d25ac78229935 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md @@ -1,7 +1,7 @@ # GridContainer -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 纵向排布栅格布局容器,仅在栅格布局场景中使用。 @@ -21,23 +21,24 @@ GridContainer(options?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: Length, margin?: Length}) -- 参数 - | 参数名 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | columns | number \| 'auto' | 否 | 'auto' | 设置当前布局总列数。 | - | sizeType | SizeType | 否 | SizeType.Auto | 选用设备宽度类型。 | - | gutter | Length | 否 | - | 栅格布局列间距。 | - | margin | Length | 否 | - | 栅格布局两侧间距。 | +**参数:** -- SizeType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | XS | 最小宽度类型设备。 | - | SM | 小宽度类型设备。 | - | MD | 中等宽度类型设备。 | - | LG | 大宽度类型设备。 | - | Auto | 根据设备类型进行选择。 | +| 参数名 | 类型 | 必填 | 默认值 | 说明 | +| -------- | -------------------------- | ---- | ------------- | ---------- | +| columns | number \| 'auto' | 否 | 'auto' | 设置当前布局总列数。 | +| sizeType | SizeType | 否 | SizeType.Auto | 选用设备宽度类型。 | +| gutter | Length | 否 | - | 栅格布局列间距。 | +| margin | Length | 否 | - | 栅格布局两侧间距。 | +## SizeType枚举说明 + +| 名称 | 描述 | +| ---- | ----------- | +| XS | 最小宽度类型设备。 | +| SM | 小宽度类型设备。 | +| MD | 中等宽度类型设备。 | +| LG | 大宽度类型设备。 | +| Auto | 根据设备类型进行选择。 | ## 属性 @@ -51,7 +52,8 @@ GridContainer(options?: { columns?: number | 'auto', sizeType?: SizeType, gutter ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct GridContainerExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md index 98363660810da775de1869dbe402d36d3e674926..691cc7f06f7a182ee270de0efbde5ae8f262302b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md @@ -1,11 +1,11 @@ # GridItem -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 网格容器中单项内容容器。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -24,26 +24,27 @@ GridItem() ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| rowStart | number | - | 用于指定当前元素起始行号。 | -| rowEnd | number | - | 用于指定当前元素终点行号。 | -| columnStart | number | - | 用于指定当前元素起始列号。 | -| columnEnd | number | - | 用于指定当前元素终点列号。 | -| forceRebuild | boolean | false | 用于设置在触发组件build时是否重新创建此节点。 | -| selectable8+ | boolean | true | 当前GridItem元素是否可以被鼠标框选。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 外层Grid容器的鼠标框选开启时,GridItem的框选才生效。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------------- | ------- | ----- | ---------------------------------------- | +| rowStart | number | - | 用于指定当前元素起始行号。 | +| rowEnd | number | - | 用于指定当前元素终点行号。 | +| columnStart | number | - | 用于指定当前元素起始列号。 | +| columnEnd | number | - | 用于指定当前元素终点列号。 | +| forceRebuild | boolean | false | 用于设置在触发组件build时是否重新创建此节点。 | +| selectable8+ | boolean | true | 当前GridItem元素是否可以被鼠标框选。
>  **说明:**
> 外层Grid容器的鼠标框选开启时,GridItem的框选才生效。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onSelect(callback: (isSelected: boolean) => any)8+ | GridItem元素被鼠标框选的状态改变时触发回调。
isSelected:进入鼠标框选范围即被选中返回true, 移出鼠标框选范围即未被选中返回false。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct GridItemExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md index c86fd24d0039df64ce45978ba6882b586f1211d8..ab48b27f7ffe68289ab6a37d9b4b24f10b95e4a5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md @@ -1,11 +1,11 @@ # List -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,58 +21,60 @@ 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枚举说明。 | -| divider | {
strokeWidth: Length,
color?:Color,
startMargin?: Length,
endMargin?: Length
} | - | 用于设置ListItem分割线样式,默认无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin: 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | -| editMode | boolean | false | 声明当前List组件是否处于可编辑模式。 | -| edgeEffect | EdgeEffect | EdgeEffect.Spring | 滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。 | -| chainAnimation | boolean | false | 用于设置当前list是否启用链式联动动效,开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果:list内的list-item间隔一定距离,在基本的滑动交互行为下,主动对象驱动从动对象进行联动,驱动效果遵循弹簧物理动效。
- false:不启用链式联动。
- true:启用链式联动。 | -| multiSelectable8+ | boolean | false | 是否开启鼠标框选。
- false:关闭框选。
- true:开启框选。 | -| restoreId8+ | number | - | 组件迁移标识符,标识后的组件在应用迁移时,组件状态会被迁移到被拉起方的同标识组件。
列表组件状态,包括起始位置显示的item序号。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------------------------- | ---------------------------------------- | ----------------- | ---------------------------------------- | +| listDirection | [Axis](ts-appendix-enums.md#axis枚举说明) | Vertical | 设置List组件排列方向参照Axis枚举说明。 | +| divider | {
strokeWidth: Length,
color?:Color,
startMargin?: Length,
endMargin?: Length
} | - | 用于设置ListItem分割线样式,默认无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin: 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | +| editMode | boolean | false | 声明当前List组件是否处于可编辑模式。 | +| edgeEffect | EdgeEffect | EdgeEffect.Spring | 滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。 | +| chainAnimation | boolean | false | 用于设置当前list是否启用链式联动动效,开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果:list内的list-item间隔一定距离,在基本的滑动交互行为下,主动对象驱动从动对象进行联动,驱动效果遵循弹簧物理动效。
- false:不启用链式联动。
- true:启用链式联动。 | +| multiSelectable8+ | boolean | false | 是否开启鼠标框选。
- false:关闭框选。
- true:开启框选。 | +| restoreId8+ | number | - | 组件迁移标识符,标识后的组件在应用迁移时,组件状态会被迁移到被拉起方的同标识组件。
列表组件状态,包括起始位置显示的item序号。 | -- EdgeEffect枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Spring | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 | - | None | 滑动到边缘后无效果。 | +## EdgeEffect枚举说明 +| 名称 | 描述 | +| ------ | ---------------------------------------- | +| Spring | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 | +| None | 滑动到边缘后无效果。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onItemDelete(index: number) => boolean | 列表项删除时触发。 | +| 名称 | 功能描述 | +| ---------------------------------------- | ------------------------ | +| onItemDelete(index: number) => boolean | 列表项删除时触发。 | | onScrollIndex(firstIndex: number, lastIndex: number) => void | 当前列表显示的起始位置和终止位置发生变化时触发。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> List使能可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件: -> -> - editMode属性设置为true。 -> -> - 绑定onItemDelete事件,且事件回调返回true。 -> -> - ListItem的editable属性设置为true。 -> -> 实现ListItem拖拽,需满足以下条件: -> -> - editMode属性设置为true。 -> -> - 绑定onDragStart事件,且事件回调中返回浮动UI布局。 +> **说明:** +> +> List使能可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件: +> +> - editMode属性设置为true。 +> +> - 绑定onItemDelete事件,且事件回调返回true。 +> +> - ListItem的editable属性设置为true。 +> +> 实现ListItem拖拽,需满足以下条件: +> +> - editMode属性设置为true。 +> +> - 绑定onDragStart事件,且事件回调中返回浮动UI布局。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ListExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md index d5c1abcf9079bbc4f57b6275b966a5ae5924fa4c..1cefb5894adba0192db6d10c5bbe80193496bd96 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md @@ -1,11 +1,11 @@ # ListItem -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 用来展示列表具体item,宽度默认充满List组件,必须配合List来使用。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -24,29 +24,30 @@ ListItem() ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| sticky | Sticky | Sticky.None | 设置ListItem吸顶效果,参见Sticky枚举描述。 | -| editable | boolean | false | 当前ListItem元素是否可编辑,进入编辑模式后可删除。 | -| selectable8+ | boolean | true | 当前ListItem元素是否可以被鼠标框选。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 外层List容器的鼠标框选开启时,ListItem的框选才生效。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------------- | ------- | ----------- | ---------------------------------------- | +| sticky | Sticky | Sticky.None | 设置ListItem吸顶效果,参见Sticky枚举描述。 | +| editable | boolean | false | 当前ListItem元素是否可编辑,进入编辑模式后可删除。 | +| selectable8+ | boolean | true | 当前ListItem元素是否可以被鼠标框选。
>  **说明:**
> 外层List容器的鼠标框选开启时,ListItem的框选才生效。 | -- Sticky枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | None | 无吸顶效果。 | - | Normal | 当前item吸顶。 | +## Sticky枚举说明 +| 名称 | 描述 | +| ------ | --------- | +| None | 无吸顶效果。 | +| Normal | 当前item吸顶。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | onSelect(callback: (isSelected: boolean) => any)8+ | ListItem元素被鼠标框选的状态改变时触发回调。
isSelected:进入鼠标框选范围即被选中返回true, 移出鼠标框选范围即未被选中返回false。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ListItemExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-navigator.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-navigator.md index cab72748f3c7faa088f282a5a93ffc9eb1a5f554..96be40af5f4645e3d342f29bfe8fbe579b9b98ac 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-navigator.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-navigator.md @@ -1,11 +1,11 @@ # Navigator -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 路由容器组件,提供路由跳转能力。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -23,26 +23,27 @@ Navigator(value?: {target: string, type?: NavigationType}) 创建路由组件。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | target | string | 是 | - | 指定跳转目标页面的路径。 | - | type | NavigationType | 否 | NavigationType.Push | 指定路由方式。 | +**参数:** + +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | -------------- | ---- | ------------------- | ------------ | +| target | string | 是 | - | 指定跳转目标页面的路径。 | +| type | NavigationType | 否 | NavigationType.Push | 指定路由方式。 | -- NavigationType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Push | 跳转到应用内的指定页面。 | - | Replace | 用应用内的某个页面替换当前页面,并销毁被替换的页面。 | - | Back | 返回上一页面或指定的页面。 | +## NavigationType枚举说明 +| 名称 | 描述 | +| ------- | -------------------------- | +| Push | 跳转到应用内的指定页面。 | +| Replace | 用应用内的某个页面替换当前页面,并销毁被替换的页面。 | +| Back | 返回上一页面或指定的页面。 | ## 属性 -| 名称 | 参数 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| active | boolean | - | 当前路由组件是否处于激活状态,处于激活状态时,会生效相应的路由操作。 | -| params | Object | undefined | 跳转时要同时传递到目标页面的数据,可在目标页面使用router.getParams()获得。 | +| 名称 | 参数 | 默认值 | 描述 | +| ------ | ------- | --------- | ---------------------------------------- | +| active | boolean | - | 当前路由组件是否处于激活状态,处于激活状态时,会生效相应的路由操作。 | +| params | Object | undefined | 跳转时要同时传递到目标页面的数据,可在目标页面使用router.getParams()获得。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-panel.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-panel.md index b92c822e71dc187b16977e3cd71190973d29cabd..a579806a93ba9daa1154e7ec8e948373a2b9593a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-panel.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-panel.md @@ -1,11 +1,11 @@ # Panel -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 可滑动面板。提供一种轻量的内容展示的窗口,可方便的在不同尺寸中切换,属于弹出式组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,48 +21,50 @@ Panel(value:{show:boolean}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | show | boolean | 是 | - | 控制Panel显示或隐藏。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---- | ------- | ---- | ---- | ------------- | +| show | boolean | 是 | - | 控制Panel显示或隐藏。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| type | PanelType | PanelType.Foldable | 设置可滑动面板的类型。 | -| mode | PanelMode | - | 设置可滑动面板的初始状态。 | -| dragBar | boolean | true | 设置是否存在dragbar,true表示存在,false表示不存在。 | -| fullHeight | Length | - | 指定PanelMode.Full状态下的高度。 | -| halfHeight | Length | - | 指定PanelMode.Half状态下的高度,默认为屏幕尺寸的一半。 | -| miniHeight | Length | - | 指定PanelMode.Mini状态下的高度。 | - -- PanelType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Minibar | 提供minibar和类全屏展示切换效果。 | - | Foldable | 内容永久展示类,提供大(类全屏)、中(类半屏)、小三种尺寸展示切换效果。 | - | Temporary | 内容临时展示区,提供大(类全屏)、中(类半屏)两种尺寸展示切换效果。 | - -- PanelMode枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Mini | 类型为minibar和foldable时,为最小状态;类型为temporary,则不生效。 | - | Half | 类型为foldable和temporary时,为类半屏状态;类型为minibar,则不生效。 | - | Full | 类全屏状态。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------- | --------- | ------------------ | ---------------------------------- | +| type | PanelType | PanelType.Foldable | 设置可滑动面板的类型。 | +| mode | PanelMode | - | 设置可滑动面板的初始状态。 | +| dragBar | boolean | true | 设置是否存在dragbar,true表示存在,false表示不存在。 | +| fullHeight | Length | - | 指定PanelMode.Full状态下的高度。 | +| halfHeight | Length | - | 指定PanelMode.Half状态下的高度,默认为屏幕尺寸的一半。 | +| miniHeight | Length | - | 指定PanelMode.Mini状态下的高度。 | + +## PanelType枚举说明 +| 名称 | 描述 | +| --------- | ------------------------------------ | +| Minibar | 提供minibar和类全屏展示切换效果。 | +| Foldable | 内容永久展示类,提供大(类全屏)、中(类半屏)、小三种尺寸展示切换效果。 | +| Temporary | 内容临时展示区,提供大(类全屏)、中(类半屏)两种尺寸展示切换效果。 | + +## PanelMode枚举说明 + +| 名称 | 描述 | +| ---- | ---------------------------------------- | +| 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高度加上内容区高度。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PanelExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md index 2288474152b157e53fec446aeaaf15ff741c7de2..a6c3be65ab1f90b10ab9551aef4ee93ce8691636 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md @@ -1,10 +1,11 @@ # Refresh -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 下拉刷新容器。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 无 @@ -17,38 +18,37 @@ Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number | string\}\) -- 参数 - - | 参数 | 参数名 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | refreshing | boolean | 是 | - | 当前组件是否正在刷新。 | - | offset | Length | 否 | 16 | 刷新组件静止时距离父组件顶部的距离。| - | friction | number \| string | 否 | 62 | 下拉摩擦系数,取值范围为0到100。
- 0表示下拉刷新容器不跟随手势下拉而下拉。
- 100表示下拉刷新容器紧紧跟随手势下拉而下拉。
- 数值越大,下拉刷新容器跟随手势下拉的反应越灵敏。 | +**参数:** +| 参数 | 参数名 | 必填 | 默认值 | 参数描述 | +| ---------- | -------------------------- | ---- | ---- | ---------------------------------------- | +| refreshing | boolean | 是 | - | 当前组件是否正在刷新。 | +| offset | Length | 否 | 16 | 刷新组件静止时距离父组件顶部的距离。 | +| friction | number \| string | 否 | 62 | 下拉摩擦系数,取值范围为0到100。
- 0表示下拉刷新容器不跟随手势下拉而下拉。
- 100表示下拉刷新容器紧紧跟随手势下拉而下拉。
- 数值越大,下拉刷新容器跟随手势下拉的反应越灵敏。 | ## 事件 -| 名称 | 描述 | -| -------- | -------- | -| onStateChange(callback: (state: RefreshStatus) => void)| 当前刷新状态变更时,触发回调。
state:刷新状态。 | -| onRefreshing(callback: () => void)| 进入刷新状态时触发回调。 | +| 名称 | 描述 | +| ---------------------------------------- | ------------------------------- | +| onStateChange(callback: (state: RefreshStatus) => void) | 当前刷新状态变更时,触发回调。
state:刷新状态。 | +| onRefreshing(callback: () => void) | 进入刷新状态时触发回调。 | -- RefreshStatus枚举说明 - - | 名称 | 描述 | - | -------- | -------- | - | Inactive | 默认未下拉状态。 | - | Drag | 下拉中,下拉距离小于刷新距离。 | - | OverDrag | 下拉中,下拉距离超过刷新距离。 | - | Refresh | 下拉结束,回弹至刷新距离,进入刷新状态。 | - | Done | 刷新结束,返回初始状态(顶部)。 | +## RefreshStatus枚举说明 +| 名称 | 描述 | +| -------- | -------------------- | +| Inactive | 默认未下拉状态。 | +| Drag | 下拉中,下拉距离小于刷新距离。 | +| OverDrag | 下拉中,下拉距离超过刷新距离。 | +| Refresh | 下拉结束,回弹至刷新距离,进入刷新状态。 | +| Done | 刷新结束,返回初始状态(顶部)。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct RefreshExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md index 3f9d172cf9ef2c7fcb3d29e66c4866bf9366c907..6c6ae8ae127d65a0759b34e00634d1c446c20765 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md @@ -1,11 +1,11 @@ # Row -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 沿水平方向布局容器。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,30 +21,31 @@ Row(value:{space?: Length}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | space | Length | 否 | 0 | 横向布局元素间距。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | --------- | +| space | Length | 否 | 0 | 横向布局元素间距。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| alignItems | VerticalAlign | VerticalAlign.Center | 在垂直方向上子组件的对齐格式。 | -| justifyContent8+ | [FlexAlign](ts-container-flex.md) | FlexAlign.Start | 设置子组件在水平方向上的对齐格式。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------------- | --------------------------------- | -------------------- | ----------------- | +| alignItems | VerticalAlign | VerticalAlign.Center | 在垂直方向上子组件的对齐格式。 | +| justifyContent8+ | [FlexAlign](ts-container-flex.md) | FlexAlign.Start | 设置子组件在水平方向上的对齐格式。 | -- VerticalAlign枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Top | 顶部对齐。 | - | Center | 居中对齐,默认对齐方式。 | - | Bottom | 底部对齐。 | +## VerticalAlign枚举说明 +| 名称 | 描述 | +| ------ | ------------ | +| Top | 顶部对齐。 | +| Center | 居中对齐,默认对齐方式。 | +| Bottom | 底部对齐。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct RowExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-rowsplit.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-rowsplit.md index 50a27edc41852620a49c0f91c9b653431c69921a..de31180e75a5cdfe34c2f45b50d3832fc2c1cc69 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-rowsplit.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-rowsplit.md @@ -1,11 +1,11 @@ # RowSplit -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 将子组件横向布局,并在每个子组件之间插入一根纵向的分割线。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -24,17 +24,18 @@ RowSplit() ## 属性 -| 名称 | 参数类型 | 描述 | -| -------- | -------- | -------- | -| resizeable | boolean | 分割线是否可拖拽,默认为false。 | +| 名称 | 参数类型 | 描述 | +| ---------- | ------- | ------------------ | +| resizeable | boolean | 分割线是否可拖拽,默认为false。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> RowSplit的分割线最小能拖动到刚好包含子组件。 +> **说明:** +> RowSplit的分割线最小能拖动到刚好包含子组件。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct RowSplitExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md index 5c208cc02a485c858b59cd95527e1ad1e733f528..73c08dfec6f98b43ae0b3e6132b9c2f0febf7dfe 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md @@ -1,11 +1,11 @@ # Scroll -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 可滚动的容器组件,当子组件的布局尺寸超过父组件的视口时,内容可以滚动。 +> **说明:** +> +> 该组件从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -31,12 +31,13 @@ Scroll(scroller?: Scroller) | scrollBarColor | Color | - | 设置滚动条的颜色。 | | scrollBarWidth | Length | - | 设置滚动条的宽度。 | -- ScrollDirection枚举说明 - | 名称 | 描述 | - | ---------- | ---------- | - | Horizontal | 仅支持水平方向滚动。 | - | Vertical | 仅支持竖直方向滚动。 | - | None | 不可滚动。 | +## ScrollDirection枚举说明 + +| 名称 | 描述 | +| ---------- | ---------- | +| Horizontal | 仅支持水平方向滚动。 | +| Vertical | 仅支持竖直方向滚动。 | +| None | 不可滚动。 | ## 事件 @@ -65,14 +66,13 @@ scrollTo(value: { xOffset: number | string, yOffset: number | string, animation? 滑动到指定位置。 +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | xOffset | Length | 是 | - | 水平滑动偏移。 | - | yOffset | Length | 是 | - | 竖直滑动偏移。 | - | animation | {
duration: number,
curve: [Curve](ts-animatorproperty.md) \|
CubicBezier \|
SpringCurve
} | 否 | | 动画配置:
- duration: 滚动时长设置。
- curve: 滚动曲线设置。 | - +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| xOffset | Length | 是 | - | 水平滑动偏移。 | +| yOffset | Length | 是 | - | 竖直滑动偏移。 | +| animation | {
duration: number,
curve: [Curve](ts-animatorproperty.md) \|
CubicBezier \|
SpringCurve
} | 否 | | 动画配置:
- duration: 滚动时长设置。
- curve: 滚动曲线设置。 | ### scrollEdge @@ -81,12 +81,11 @@ scrollEdge(value: Edge): void 滚动到容器边缘。 +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ---- | ---- | ---- | --------- | - | value | Edge | 是 | - | 滚动到的边缘位置。 | - +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ---- | ---- | ---- | --------- | +| value | Edge | 是 | - | 滚动到的边缘位置。 | ### scrollPage @@ -94,12 +93,12 @@ scrollPage(value: { next: boolean, direction?: Axis }): void 滚动到下一页或者上一页。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------- | ------- | ---- | ---- | ------------------------------ | - | next | boolean | 是 | - | 是否向下翻页。true表示向下翻页,false表示向上翻页。 | - | direction | Axis | 否 | - | 设置滚动方向为水平或竖直方向。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ------- | ---- | ---- | ------------------------------ | +| next | boolean | 是 | - | 是否向下翻页。true表示向下翻页,false表示向上翻页。 | +| direction | Axis | 否 | - | 设置滚动方向为水平或竖直方向。 | ### currentOffset @@ -108,12 +107,11 @@ scroller.currentOffset(): Object 返回当前的滚动偏移量。 +**返回值:** -- 返回值 - | 类型 | 描述 | - | ---------------------------------------- | ---------------------------------------- | - | {
xOffset: number,
yOffset: number
} | xOffset: 水平滑动偏移;
yOffset: 竖直滑动偏移。 | - +| 类型 | 描述 | +| ---------------------------------------- | ---------------------------------------- | +| {
xOffset: number,
yOffset: number
} | xOffset: 水平滑动偏移;
yOffset: 竖直滑动偏移。 | ### scrollToIndex @@ -123,19 +121,19 @@ scroller.scrollToIndex(value: number): void 滑动到指定Index。 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 仅支持list组件。 +> **说明:** +> 仅支持list组件。 +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ------ | ---- | ---- | ----------------- | - | value | number | 是 | - | 要滑动到的列表项在列表中的索引值。 | - +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | ----------------- | +| value | number | 是 | - | 要滑动到的列表项在列表中的索引值。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ScrollExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md index b9c0fbfb166fab6f2c22f60630af11cda0a18a40..ad63e70f0071984962b83b110df8e9a78c033929 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md @@ -1,11 +1,11 @@ # SideBarContainer -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供侧边栏可以显示和隐藏的侧边栏容器,通过子组件定义侧边栏和内容区,第一个子组件表示侧边栏,第二个子组件表示内容区。 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,50 +21,53 @@ SideBarContainer( type?: SideBarContainerType ) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | type | SideBarContainerType | 否 | SideBarContainerType.Embed | 设置侧边栏的显示类型。 | +**参数:** -- SideBarContainerType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Embed | 侧边栏嵌入到组件内,侧边栏和内容区并列显示。 | - | Overlay | 侧边栏浮在内容区上面。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---- | -------------------- | ---- | -------------------------- | ----------- | +| type | SideBarContainerType | 否 | SideBarContainerType.Embed | 设置侧边栏的显示类型。 | + +## SideBarContainerType枚举说明 + +| 名称 | 描述 | +| ------- | ---------------------- | +| Embed | 侧边栏嵌入到组件内,侧边栏和内容区并列显示。 | +| Overlay | 侧边栏浮在内容区上面。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| showSideBar | boolean | true | 设置是否显示侧边栏。 | -| controlButton | ButtonStyle | - | 设置侧边栏控制按钮的属性。 | -| showControlButton | boolean | true | 设置是否显示控制按钮。 | -| sideBarWidth | number | 200 | 设置侧边栏的宽度。 | -| minSideBarWidth | number | 200 | 设置侧边栏最小宽度。 | -| maxSideBarWidth | number | 280 | 设置侧边栏最大宽度。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------- | ----------- | ---- | ------------- | +| showSideBar | boolean | true | 设置是否显示侧边栏。 | +| controlButton | ButtonStyle | - | 设置侧边栏控制按钮的属性。 | +| showControlButton | boolean | true | 设置是否显示控制按钮。 | +| sideBarWidth | number | 200 | 设置侧边栏的宽度。 | +| minSideBarWidth | number | 200 | 设置侧边栏最小宽度。 | +| maxSideBarWidth | number | 280 | 设置侧边栏最大宽度。 | -- ButtonStyle对象说明 - | 名称 | 参数类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | left | number | 否 | 16 | 设置侧边栏控制按钮距离容器左界限的间距。 | - | top | number | 否 | 48 | 设置侧边栏控制按钮距离容器上界限的间距。 | - | width | number | 否 | 32 | 设置侧边栏控制按钮的宽度。 | - | height | number | 否 | 32 | 设置侧边栏控制按钮的高度。 | - | icons | {
shown: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
hidden: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
switching?: string \| PixelMap \| [Resource](../../ui/ts-types.md)
} | 否 | - | 设置侧边栏控制按钮的图标:

- shown: 设置侧边栏显示时控制按钮的图标。
- hidden: 设置侧边栏隐藏时控制按钮的图标。
- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 | +## ButtonStyle对象说明 +| 名称 | 参数类型 | 必填 | 默认值 | 描述 | +| ------ | ---------------------------------------- | ---- | ---- | ---------------------------------------- | +| left | number | 否 | 16 | 设置侧边栏控制按钮距离容器左界限的间距。 | +| top | number | 否 | 48 | 设置侧边栏控制按钮距离容器上界限的间距。 | +| width | number | 否 | 32 | 设置侧边栏控制按钮的宽度。 | +| height | number | 否 | 32 | 设置侧边栏控制按钮的高度。 | +| icons | {
shown: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
hidden: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
switching?: string \| PixelMap \| [Resource](../../ui/ts-types.md)
} | 否 | - | 设置侧边栏控制按钮的图标:

- shown: 设置侧边栏显示时控制按钮的图标。
- hidden: 设置侧边栏隐藏时控制按钮的图标。
- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange(callback: (value: boolen) => void) | 当侧边栏的状态在显示和隐藏之间切换时触发回调。

value的true表示显示,false表示隐藏。| +| 名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | +| onChange(callback: (value: boolen) => void) | 当侧边栏的状态在显示和隐藏之间切换时触发回调。

value的true表示显示,false表示隐藏。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct SideBarContainerExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-stack.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-stack.md index 16691f323bce9ecfc053bf025313c45ec141eeee..ecb65fa1519079ac116b944440a23723c393b4c2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-stack.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-stack.md @@ -1,11 +1,11 @@ # Stack -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 堆叠容器,子组件按照顺序依次入栈,后一个子组件覆盖前一个子组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,15 +21,16 @@ Stack(value:{alignContent?: Alignment}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | alignContent | [Alignment](ts-appendix-enums.md#alignment枚举说明) | 否 | Center | 设置子组件在容器内的对齐方式。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------------ | ---------------------------------------- | ---- | ------ | --------------- | +| alignContent | [Alignment](ts-appendix-enums.md#alignment枚举说明) | 否 | Center | 设置子组件在容器内的对齐方式。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct StackExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md index 0a44ddc144d2b368ce4d315bd94c2070e9376aea..6901f5234f9c9e765f2d470db93e19b0389085fd 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md @@ -20,11 +20,11 @@ Swiper(value:{controller?: SwiperController}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | ------------------------------------- | ---- | ---- | -------------------- | - | controller | [SwiperController](#swipercontroller) | 否 | null | 给组件绑定一个控制器,用来控制组件翻页。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ---------- | ------------------------------------- | ---- | ---- | -------------------- | +| controller | [SwiperController](#swipercontroller) | 否 | null | 给组件绑定一个控制器,用来控制组件翻页。 | ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md index 6486c97a25964c9f1e6f10f72f95a77be28c6d5d..27be563ca2377757b948f64c753aac53d4c2fb02 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md @@ -1,11 +1,11 @@ # TabContent -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 仅在Tabs中使用,对应一个切换页签的内容视图。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -28,17 +28,18 @@ TabContent() | 名称 | 参数类型 | 默认值 | 描述 | | ------ | ---------------------------------------- | ---- | ---------------------------------------- | -| tabBar | string \| {
icon?: string,
text?: string
}
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器,内部可以传入组件(API8版本以上适用)。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如果icon采用svg格式图源,则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源,icon大小则是svg本身内置的宽高属性值大小。 | +| tabBar | string \| {
icon?: string,
text?: string
}
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器,内部可以传入组件(API8版本以上适用)。
>  **说明:**
> 如果icon采用svg格式图源,则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源,icon大小则是svg本身内置的宽高属性值大小。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> - TabContent组件不支持设置通用宽度属性,其宽度默认撑满Tabs父组件。 +> **说明:** +> - TabContent组件不支持设置通用宽度属性,其宽度默认撑满Tabs父组件。 > -> - TabContent组件不支持设置通用高度属性,其高度由Tabs父组件高度与TabBar组件高度决定。 +> - TabContent组件不支持设置通用高度属性,其高度由Tabs父组件高度与TabBar组件高度决定。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TabContentExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md index dc4ebb5e6880bf743b284ffdbb644f36a7d1f1f3..6f09309688187492abfcec94156b3a3d9b9601ff 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md @@ -1,11 +1,11 @@ # Tabs -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 一种可以通过页签进行内容视图切换的容器组件,每个页签对应一个内容视图。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,45 +21,46 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsController](#tabscontroller)}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | barPosition | BarPosition | 否 | BarPosition.Start | 指定页签位置来创建Tabs容器组件。 | - | index | number | 否 | 0 | 指定初次初始页签索引。 | - | controller | [TabsController](#tabscontroller) | 否 | - | 设置Tabs控制器。 | +**参数:** -- BarPosition枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Start | vertical属性方法设置为true时,页签位于容器左侧;vertical属性方法设置为false时,页签位于容器顶部。 | - | End | vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----------- | --------------------------------- | ---- | ----------------- | ------------------ | +| barPosition | BarPosition | 否 | BarPosition.Start | 指定页签位置来创建Tabs容器组件。 | +| index | number | 否 | 0 | 指定初次初始页签索引。 | +| controller | [TabsController](#tabscontroller) | 否 | - | 设置Tabs控制器。 | +## BarPosition枚举说明 + +| 名称 | 描述 | +| ----- | ---------------------------------------- | +| Start | vertical属性方法设置为true时,页签位于容器左侧;vertical属性方法设置为false时,页签位于容器顶部。 | +| End | vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。 | ## 属性 不支持触摸热区设置。 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| vertical | boolean | 是否为纵向Tab,默认为false。 | 是否为纵向Tab,默认为false。 | -| scrollable | boolean | 是否可以通过左右滑动进行页面切换,默认为true。 | 是否可以通过左右滑动进行页面切换,默认为true。 | -| barMode | BarMode | TabBar布局模式。 | TabBar布局模式。 | -| barWidth | number | TabBar的宽度值,不设置时使用系统主题中的默认值。 | TabBar的宽度值,不设置时使用系统主题中的默认值。 | -| barHeight | number | TabBar的高度值,不设置时使用系统主题中的默认值。 | TabBar的高度值,不设置时使用系统主题中的默认值**。** | -| animationDuration | number | 200 | TabContent滑动动画时长。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------- | ------- | --------------------------- | ------------------------------- | +| vertical | boolean | 是否为纵向Tab,默认为false。 | 是否为纵向Tab,默认为false。 | +| scrollable | boolean | 是否可以通过左右滑动进行页面切换,默认为true。 | 是否可以通过左右滑动进行页面切换,默认为true。 | +| barMode | BarMode | TabBar布局模式。 | TabBar布局模式。 | +| barWidth | number | TabBar的宽度值,不设置时使用系统主题中的默认值。 | TabBar的宽度值,不设置时使用系统主题中的默认值。 | +| barHeight | number | TabBar的高度值,不设置时使用系统主题中的默认值。 | TabBar的高度值,不设置时使用系统主题中的默认值**。** | +| animationDuration | number | 200 | TabContent滑动动画时长。 | -- BarMode枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Scrollable | TabBar使用实际布局宽度, 超过总长度后可滑动。 | - | Fixed | 所有TabBar平均分配宽度。 | +## BarMode枚举说明 +| 名称 | 描述 | +| ---------- | ------------------------------- | +| Scrollable | TabBar使用实际布局宽度, 超过总长度后可滑动。 | +| Fixed | 所有TabBar平均分配宽度。 | ## 事件 -| 名称 | 功能描述 | -| -------- | -------- | -| onChange(callback: (index: number) => void) | Tab页签切换后触发的事件。 | +| 名称 | 功能描述 | +| ---------------------------------------- | -------------- | +| onChange(callback: (index: number) => void) | Tab页签切换后触发的事件。 | ## TabsController @@ -78,15 +79,16 @@ changeIndex(value: number): void 控制Tabs切换到指定页签。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | value | number | 是 | - | 页签在Tabs里的索引值,索引值从0开始。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ----- | ------ | ---- | ---- | --------------------- | +| value | number | 是 | - | 页签在Tabs里的索引值,索引值从0开始。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TabsExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md index c2e660b62c106a8337592bfc21de67bb9b6faa9d..1db4f4378afc8816facaae96a2606e5b1488a10d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-circle.md @@ -1,11 +1,11 @@ # Circle -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 圆形绘制组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,29 +21,25 @@ Circle(options?: {width: Length, height: Length}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | options | Object | 否 | - | 见options参数说明。 | - -- options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | Length | 是 | - | 宽度。 | - | height | Length | 是 | - | 高度。 | +**options参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | ------ | ---- | ---- | ---- | +| width | Length | 是 | - | 宽度。 | +| height | Length | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 圆所在矩形的宽度。 | -| height | Length | 0 | 否 | 圆所在矩形的高度。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ------ | ------ | ---- | ---- | --------- | +| width | Length | 0 | 否 | 圆所在矩形的宽度。 | +| height | Length | 0 | 否 | 圆所在矩形的高度。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct CircleExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md index 322800fca201305e89e4c767c2fa142af3bb49a3..36d8040c657a83c3c36a00bdb40ada585d9cbf8f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-ellipse.md @@ -1,7 +1,8 @@ # Ellipse -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 椭圆绘制组件。 @@ -21,29 +22,25 @@ ellipse(options?: {width: Length, height: Length}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | options | Object | 否 | - | 见options参数说明。 | - -- options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | Length | 是 | - | 宽度。 | - | height | Length | 是 | - | 高度。 | +**options参数说明:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | ------ | ---- | ---- | ---- | +| width | Length | 是 | - | 宽度。 | +| height | Length | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 椭圆所在矩形的宽度。 | -| height | Length | 0 | 否 | 椭圆所在矩形的高度。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ------ | ------ | ---- | ---- | ---------- | +| width | Length | 0 | 否 | 椭圆所在矩形的宽度。 | +| height | Length | 0 | 否 | 椭圆所在矩形的高度。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct EllipseExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md index dd0565e1a35a6a5bfe6795454661260316f4e26a..b5f80f172d4d1f459d31b8bec542396a9b506bb5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md @@ -1,11 +1,11 @@ # Line -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 直线绘制组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,31 +21,27 @@ Line(options?: {width: Length, height: Length}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | options | Object | 否 | - | 见options参数说明。 | - -- options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | Length | 是 | - | 宽度。 | - | height | Length | 是 | - | 高度。 | +**options参数说明:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | ------ | ---- | ---- | ---- | +| width | Length | 是 | - | 宽度。 | +| height | Length | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 直线所在矩形的宽度。 | -| height | Length | 0 | 否 | 直线所在矩形的高度。 | -| startPoint | Point | [0, 0] | 是 | 直线起点坐标(相对坐标)。 | -| endPoint | Point | [0, 0] | 是 | 直线终点坐标(相对坐标)。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ---------- | ------ | ----------- | ---- | ------------- | +| width | Length | 0 | 否 | 直线所在矩形的宽度。 | +| height | Length | 0 | 否 | 直线所在矩形的高度。 | +| startPoint | Point | [0, 0] | 是 | 直线起点坐标(相对坐标)。 | +| endPoint | Point | [0, 0] | 是 | 直线终点坐标(相对坐标)。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct LineExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md index 0e9d0e33f4c34b37454ca8b8263298b0856984f0..b1677e23df60821240c9af3a159e2d6355adc550 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-path.md @@ -16,14 +16,13 @@ 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 | 否 | '' | 路径绘制的命令字符串。 | ## 属性 @@ -63,7 +62,8 @@ Path(value?: { width?: number | string, height?: number | string, commands?: str ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PathExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polygon.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polygon.md index fc5a45c6886e66b0b4c49e4819f467cc593672df..6e921a4dd227e8f539f6144e58e4da8e1bb3d1d1 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polygon.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polygon.md @@ -1,11 +1,11 @@ # Polygon -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 多边形绘制组件。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -21,30 +21,26 @@ Polygon(value:{options?: {width: Length, height: Length}}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | options | Object | 否 | - | 见见options参数说明。 | - -- options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | Length | 是 | - | 宽度。 | - | height | Length | 是 | - | 高度。 | +**options参数说明:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | ------ | ---- | ---- | ---- | +| width | Length | 是 | - | 宽度。 | +| height | Length | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 多边形所在矩形的宽度。 | -| height | Length | 0 | 否 | 多边形所在矩形的高度。 | -| points | Array<Point> | - | 是 | 多边形的顶点坐标列表。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ------ | ------------------ | ---- | ---- | ----------- | +| width | Length | 0 | 否 | 多边形所在矩形的宽度。 | +| height | Length | 0 | 否 | 多边形所在矩形的高度。 | +| points | Array<Point> | - | 是 | 多边形的顶点坐标列表。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PolygonExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polyline.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polyline.md index cb6add47d5a1c90442db199b8e172954905237c5..37b72ec5200810550b290fd79ed67abf601b92ba 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polyline.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-polyline.md @@ -1,7 +1,8 @@ # Polyline -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 折线绘制组件。 @@ -21,30 +22,26 @@ Polyline(options?: {width: Length, height: Length}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | options | Object | 否 | - | 见options参数说明。 | - -- options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | Length | 是 | - | 宽度。 | - | height | Length | 是 | - | 高度。 | +**options参数说明:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | ------ | ---- | ---- | ---- | +| width | Length | 是 | - | 宽度。 | +| height | Length | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 折线所在矩形的宽度。 | -| height | Length | 0 | 否 | 折线所在矩形的高度。 | -| points | Array<Point> | - | 是 | 折线经过坐标点列表。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ------ | ------------------ | ---- | ---- | ---------- | +| width | Length | 0 | 否 | 折线所在矩形的宽度。 | +| height | Length | 0 | 否 | 折线所在矩形的高度。 | +| points | Array<Point> | - | 是 | 折线经过坐标点列表。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PolylineExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-rect.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-rect.md index be2e35cf3ed10699a115fef900de6e29c2609b29..aaf992b52b8af25b7b99a8e822cd23d29d28fb4e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-rect.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-rect.md @@ -1,7 +1,8 @@ # Rect -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 矩形绘制组件。 @@ -21,35 +22,31 @@ Rect(value:{options?: {width: Length,height: Length,radius?: Length | Array<Length>} | {width: Length,height: Length,radiusWidth?: Length,radiusHeight?: Length}}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | options | Object | 否 | - | 见options参数说明。 | - -- options参数说明 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | width | Length | 是 | - | 宽度。 | - | height | Length | 是 | - | 高度。 | - | radius | Length \| Array<Length> | 否 | 0 | 圆角半径,支持分别设置四个角的圆角度数。 | - | radiusWidth | Length | 否 | 0 | 圆角宽度。 | - | radiusHeight | Length | 否 | 0 | 圆角高度。 | +**options参数说明:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------------ | --------------------------------------- | ---- | ---- | -------------------- | +| width | Length | 是 | - | 宽度。 | +| height | Length | 是 | - | 高度。 | +| radius | Length \| Array<Length> | 否 | 0 | 圆角半径,支持分别设置四个角的圆角度数。 | +| radiusWidth | Length | 否 | 0 | 圆角宽度。 | +| radiusHeight | Length | 否 | 0 | 圆角高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 宽度。 | -| height | Length | 0 | 否 | 高度。 | -| radiusWidth | Length | 0 | 否 | 圆角的宽度,仅设置宽时宽高一致。 | -| radiusHeight | Length | 0 | 否 | 圆角的高度,仅设置高时宽高一致。 | -| radius | Length \| Array<Length> | 0 | 否 | 圆角大小。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ------------ | --------------------------------------- | ---- | ---- | ---------------- | +| width | Length | 0 | 否 | 宽度。 | +| height | Length | 0 | 否 | 高度。 | +| radiusWidth | Length | 0 | 否 | 圆角的宽度,仅设置宽时宽高一致。 | +| radiusHeight | Length | 0 | 否 | 圆角的高度,仅设置高时宽高一致。 | +| radius | Length \| Array<Length> | 0 | 否 | 圆角大小。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct RectExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-shape.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-shape.md index 7c3e80fe8db461f185e254d9e7b22ab284aa7697..4a56238b30a5832e9f0405fb2bb169a0b090a3f0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-shape.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-shape.md @@ -1,17 +1,15 @@ # Shape -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 绘制组件的父组件,父组件中会描述所有绘制组件均支持的通用属性。 - 1、绘制组件使用Shape作为父组件,实现类似SVG的效果。 - 2、绘制组件单独使用,用于在页面上绘制指定的图形。 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -27,39 +25,40 @@ Shape(value:{target?: PixelMap}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | target | PixelMap | 否 | null | 绘制目标,可将图形绘制在指定的PixelMap对象中,若未设置,则在当前绘制目标中进行绘制。 | +**参数:** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | -------- | ---- | ---- | ---------------------------------------- | +| target | PixelMap | 否 | null | 绘制目标,可将图形绘制在指定的PixelMap对象中,若未设置,则在当前绘制目标中进行绘制。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| viewPort | {
x: Length,
y: Length,
width: Length,
height: Length
} | - | 是 | 形状的视口。 | -| fill | Color | Black | 否 | 填充颜色。 | -| stroke | Color | - | 否 | 边框颜色。 | -| strokeDashArray | Array<Length> | [] | 否 | 设置边框的间隙。 | -| strokeDashOffset | Length | 0 | 否 | 边框绘制起点的偏移量。 | -| strokeLineCap | [LineCapStyle](ts-appendix-enums.md#LineCapStyle枚举说明) | LineCapStyle.Butt | 否 | 路径端点绘制样式。 | -| strokeLineJoin | LineJoinStyle | LineJoinStyle.Miter | 否 | 边框拐角绘制样式。 | -| strokeMiterLimit | number | 4 | 否 | 锐角绘制成斜角的极限值。 | -| strokeOpacity | number | 1 | 否 | 设置边框的不透明度。 | -| strokeWidth | Length | 1 | 否 | 设置边框的宽度。 | -| antiAlias | boolean | true | 否 | 是否开启抗锯齿。 | - -- LineJoinStyle枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Bevel | 使用斜角连接路径段。 | - | Miter | 使用尖角连接路径段。 | - | Round | 使用圆角连接路径段。 | - +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ---------------- | ---------------------------------------- | ------------------- | ---- | ------------ | +| viewPort | {
x: Length,
y: Length,
width: Length,
height: Length
} | - | 是 | 形状的视口。 | +| fill | Color | Black | 否 | 填充颜色。 | +| stroke | Color | - | 否 | 边框颜色。 | +| strokeDashArray | Array<Length> | [] | 否 | 设置边框的间隙。 | +| strokeDashOffset | Length | 0 | 否 | 边框绘制起点的偏移量。 | +| strokeLineCap | [LineCapStyle](ts-appendix-enums.md#LineCapStyle枚举说明) | LineCapStyle.Butt | 否 | 路径端点绘制样式。 | +| strokeLineJoin | LineJoinStyle | LineJoinStyle.Miter | 否 | 边框拐角绘制样式。 | +| strokeMiterLimit | number | 4 | 否 | 锐角绘制成斜角的极限值。 | +| strokeOpacity | number | 1 | 否 | 设置边框的不透明度。 | +| strokeWidth | Length | 1 | 否 | 设置边框的宽度。 | +| antiAlias | boolean | true | 否 | 是否开启抗锯齿。 | + +## LineJoinStyle枚举说明 + +| 名称 | 描述 | +| ----- | ---------- | +| Bevel | 使用斜角连接路径段。 | +| Miter | 使用尖角连接路径段。 | +| Round | 使用圆角连接路径段。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ShapeExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md b/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md index 9b2c8200c3c62f8472861e88590fd3fb47866e0f..8c1d10aed8ffec034003a4b1feb6a47bffb08d7f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-explicit-animation.md @@ -1,36 +1,38 @@ # 显式动画 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -| 接口名称 | 功能描述 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | +| 接口名称 | 功能描述 | +| ---------------------------------------- | ---------------------------------------- | | animateTo(value: [AnimationOptions](#animationoptions对象说明), event: ()=> void) : void | 提供全局animateTo显式动画接口来指定由于闭包代码导致的状态变化插入过渡动效。
event指定显示动效的闭包函数,在闭包函数中导致的状态变化系统会自动插入过渡动画。 | ## 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 | 动效播放完成回调。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct AnimateToExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md b/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md index 8d7f9b9f75892f0c4cc4e83bf5bc6e28d82615c4..25a017df72ff01f7cb1fda311c7f30f14e9146b9 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-interpolation-calculation.md @@ -1,6 +1,6 @@ # 插值计算 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md b/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md index fa9ecb8c49bc37ad43f20fabc6f14b77718768a6..40d89097abf49f7a49ec24b5e49387c645d66c86 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-matrix-transformation.md @@ -1,6 +1,6 @@ # 矩阵变换 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md index bd97f739ccbae22648af5b99e7f7d363fed9a7c6..b7bf5b90c356be7eab397976bce19c41d00a060d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-media-components-video.md @@ -1,6 +1,6 @@ # Video -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 视频播放组件。 @@ -33,7 +33,7 @@ Video(value: VideoOptions) | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ------------------- | ---------------------------------------- | ---- | ---------------------------------------- | ---------------------------------------- | | src | string \| [Resource](../../ui/ts-types.md) | 否 | - | 视频播放源的路径,支持本地视频路径和网络路径。
支持在resources下面的video或rawfile文件夹里放置媒体资源。
支持dataability://的路径前缀,用于访问通过Data Ability提供的视频路径,具体路径信息详见[Data Ability说明](../../ability/fa-dataability.md)。 | - | currentProgressRate | number \| PlaybackSpeed8+ | 否 | 1.0 \| PlaybackSpeed.
Speed_Forward_1_00_X | 视频播放倍速。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> number取值仅支持:0.75,1.0,1.25,1.75,2.0。
| + | currentProgressRate | number \| PlaybackSpeed8+ | 否 | 1.0 \| PlaybackSpeed.
Speed_Forward_1_00_X | 视频播放倍速。
>  **说明:**
> number取值仅支持:0.75,1.0,1.25,1.75,2.0。
| | previewUri | string \| PixelMap8+ \| [Resource](../../ui/ts-types.md) | 否 | - | 预览图片的路径。 | | controller | [VideoController](#videocontroller) | 否 | - | 控制器。 | @@ -155,7 +155,8 @@ setCurrentTime(value: number, seekMode: SeekMode) ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct VideoCreateComponent { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md index 07d48cb35b8d26ed9ed9cb3d16659799e8e25506..e5e4e723fb00b7a44c4656b23b4125e39edaf8df 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-action-sheet.md @@ -1,6 +1,6 @@ # 列表选择弹窗 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -42,7 +42,8 @@ show(options: { paramObject1}) ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ActionSheetExapmle { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md index 2f55b32db3bfe3d1873065876243b2f308702d49..57162b87f0ffa886dff0c4cb184ebc7dfac05844 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md @@ -1,6 +1,6 @@ # 警告弹窗 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -41,7 +41,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct AlertDialogExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md index 26a07679a32099d18d50cc43dac30cc14b288256..4608aba9dc8edc10aca85072454448606546cd61 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md @@ -1,6 +1,6 @@ # 自定义弹窗 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md index 10a9a68cda53c73b82ce1dac80ad4044c7acaaf9..98663cb9bf0387b0cf266122cf76093e2c81eb50 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md @@ -1,6 +1,6 @@ # 日期滑动选择器弹窗 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 根据指定范围的Date创建可以选择日期的滑动选择器,展示在弹窗上。 @@ -29,7 +29,8 @@ show(options?: DatePickerDialogOptions) ## 示例 ### 日期滑动选择器(显示农历)示例 -``` +```ts +// xxx.ets @Entry @Component struct DatePickerDialogExample01 { @@ -62,7 +63,8 @@ struct DatePickerDialogExample01 { } ``` ### 日期滑动选择器(不显示农历)示例 -``` +```ts +// xxx.ets @Entry @Component struct DatePickerDialogExample02 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md index df97249f6d38576b79f604df4aab7d277c7118f9..3e832dee2c127cdec7d5160e4cc9737a5aec885d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-menu.md @@ -1,7 +1,8 @@ # 菜单 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## ContextMenu.close @@ -9,31 +10,32 @@ close(): void 可以通过该方法在页面范围内关闭通过[bindContextMenu](./ts-universal-attributes-menu.md#属性)给组件绑定的菜单。 -- 示例 - ``` - @Entry - @Component - struct Index { - @Builder MenuBuilder(){ - Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { - Text('close') - .fontSize(30) - .fontWeight(FontWeight.Bold) - .onClick(() => { - ContextMenu.close(); - }) - }.height(400) - .backgroundColor(Color.Pink) - - } - build() { - Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.Start }) { - Column(){ - Text("Text") - }.bindContextMenu(this.MenuBuilder, ResponseType.LongPress) - } - .width('100%') - .height('100%') +**示例:** + +``` +@Entry +@Component +struct Index { + @Builder MenuBuilder(){ + Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) { + Text('close') + .fontSize(30) + .fontWeight(FontWeight.Bold) + .onClick(() => { + ContextMenu.close(); + }) + }.height(400) + .backgroundColor(Color.Pink) + + } + build() { + Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.Start }) { + Column(){ + Text("Text") + }.bindContextMenu(this.MenuBuilder, ResponseType.LongPress) } + .width('100%') + .height('100%') } - ``` +} +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md index b9c0e9cd7a1a410f2509f6ceb719820272d1c90f..21085f27e61f40bed7568fae682e820dad77cb9f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md @@ -1,6 +1,6 @@ # 文本滑动选择器弹窗 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 根据指定的选择范围创建文本选择器,展示在弹窗上。 @@ -33,7 +33,8 @@ show(options: TextPickerDialogOptions) ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TextPickerDialogExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md index 073e84113a50767dab0a84a294b0ceb45e4faa91..2917d91350b4fd82e62f3a2c1092827f452f7c2d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-timepicker-dialog.md @@ -1,6 +1,6 @@ # 时间滑动选择器弹窗 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 默认以00:00至23:59的时间区间创建滑动选择器,展示在弹窗上。 @@ -27,7 +27,8 @@ show(options?: TimePickerDialogOptions) ## 示例 ### 时间滑动选择器(24小时制)示例 -``` +```ts +// xxx.ets @Entry @Component struct TimePickerDialogExample01 { @@ -55,7 +56,8 @@ struct TimePickerDialogExample01 { } ``` ### 时间滑动选择器(12小时制)示例 -``` +```ts +// xxx.ets @Entry @Component struct TimePickerDialogExample02 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md b/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md index 82a6b6a35aa076ddd43098bb09048e7405871ec0..022e2efe6d9466d14d21ec81d0d3dbbeeafefd57 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md @@ -1,6 +1,6 @@ # 路径动画 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -11,12 +11,13 @@ | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| motionPath | {
path: string,
from?: number,
to?: number,
rotatable?: boolean
}
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> path中支持通过start和end进行起点和终点的替代,如:

> 'Mstart.x start.y L50 50 Lend.x end.y Z'。 | {
"",
0.0,
1.0,
false
} | 设置组件的运动路径,入参说明如下:
- path:位移动画的运动路径,使用svg路径字符串。
- from:运动路径的起点,默认为0.0。
- to:运动路径的终点,默认为1.0。
- rotatable:是否跟随路径进行旋转。 | +| motionPath | {
path: string,
from?: number,
to?: number,
rotatable?: boolean
}
>  **说明:**
> path中支持通过start和end进行起点和终点的替代,如:

> 'Mstart.x start.y L50 50 Lend.x end.y Z'。 | {
"",
0.0,
1.0,
false
} | 设置组件的运动路径,入参说明如下:
- path:位移动画的运动路径,使用svg路径字符串。
- from:运动路径的起点,默认为0.0。
- to:运动路径的终点,默认为1.0。
- rotatable:是否跟随路径进行旋转。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct MotionPathExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md b/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md index 065c59e0d43cf97c45b5d8aac131805a64b1bb1d..f62674077b93bb96247757fbbdd6d202fdbd3e39 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-offscreencanvasrenderingcontext2d.md @@ -1,6 +1,6 @@ # OffscreenCanvasRenderingContext2D对象 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从 API Version 8 开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -30,7 +30,7 @@ OffscreenCanvasRenderingContext2D(width: number, height: number, setting: Render | [lineJoin](#linejoin) | string | 'miter' | 指定线段间相交的交点样式,可选值为:
- 'round':在线段相连处绘制一个扇形,扇形的圆角半径是线段的宽度。
- 'bevel':在线段相连处使用三角形为底填充, 每个部分矩形拐角独立。
- 'miter':在相连部分的外边缘处进行延伸,使其相交于一点,形成一个菱形区域,该属性可以通过设置miterLimit属性展现效果。 | | [miterLimit](#miterlimit) | number | 10 | 设置斜接面限制值,该值指定了线条相交处内角和外角的距离。 | | [font](#font) | string | 'normal normal 14px sans-serif' | 设置文本绘制中的字体样式。
语法:ctx.font='font-size font-family'
- font-size(可选),指定字号和行高,单位只支持px。
- font-family(可选),指定字体系列。
语法:ctx.font='font-style font-weight font-size font-family'
- font-style(可选),用于指定字体样式,支持如下几种样式:'normal', 'italic'。
- font-weight(可选),用于指定字体的粗细,支持如下几种类型:'normal', 'bold', 'bolder', 'lighter', 100, 200, 300, 400, 500, 600, 700, 800, 900。
- font-size(可选),指定字号和行高,单位只支持px。
- font-family(可选),指定字体系列,支持如下几种类型:'sans-serif', 'serif', 'monospace'。 | -| [textAlign](#textalign) | string | 'left' | 设置文本绘制中的文本对齐方式,可选值为:
- 'left':文本左对齐。
- 'right':文本右对齐。
- 'center':文本居中对齐。
- 'start':文本对齐界线开始的地方。
- 'end':文本对齐界线结束的地方。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ltr布局模式下start和left一致,rtl布局模式下start和right一致·。 | +| [textAlign](#textalign) | string | 'left' | 设置文本绘制中的文本对齐方式,可选值为:
- 'left':文本左对齐。
- 'right':文本右对齐。
- 'center':文本居中对齐。
- 'start':文本对齐界线开始的地方。
- 'end':文本对齐界线结束的地方。
>  **说明:**
> ltr布局模式下start和left一致,rtl布局模式下start和right一致·。 | | [textBaseline](#textbaseline) | string | 'alphabetic' | 设置文本绘制中的水平对齐方式,可选值为:
- 'alphabetic':文本基线是标准的字母基线。
- 'top':文本基线在文本块的顶部。
- 'hanging':文本基线是悬挂基线。
- 'middle':文本基线在文本块的中间。
- 'ideographic':文字基线是表意字基线;如果字符本身超出了alphabetic基线,那么ideograhpic基线位置在字符本身的底部。
- 'bottom':文本基线在文本块的底部。 与ideographic基线的区别在于ideographic 基线不需要考虑下行字母。 | | [globalAlpha](#globalalpha) | number | - | 设置透明度,0.0为完全透明,1.0为完全不透明。 | | [lineDashOffset](#linedashoffset) | number | 0.0 | 设置画布的虚线偏移量,精度为float。 | @@ -42,13 +42,14 @@ OffscreenCanvasRenderingContext2D(width: number, height: number, setting: Render | [imageSmoothingEnabled](#imagesmoothingenabled) | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整,true为启用,false为不启用。 | | imageSmoothingQuality | string | 'low' | 用于设置图像平滑度,支持如下三种类型:'low', 'medium', 'high'。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > <color>类型格式为 'rgb(255, 255, 255)','rgba(255, 255, 255, 1.0)','\#FFFFFF'。 ### fillStyle -``` +```ts +// xxx.ets @Entry @Component struct FillStyleExample { @@ -80,7 +81,8 @@ struct FillStyleExample { ### lineWidth -``` +```ts +// xxx.ets @Entry @Component struct LineWidthExample { @@ -112,7 +114,8 @@ struct LineWidthExample { ### strokeStyle -``` +```ts +// xxx.ets @Entry @Component struct StrokeStyleExample { @@ -146,7 +149,8 @@ struct StrokeStyleExample { ### lineCap -``` +```ts +// xxx.ets @Entry @Component struct LineCapExample { @@ -182,7 +186,8 @@ struct LineCapExample { ### lineJoin -``` +```ts +// xxx.ets @Entry @Component struct LineJoinExample { @@ -219,7 +224,8 @@ struct LineJoinExample { ### miterLimit -``` +```ts +// xxx.ets @Entry @Component struct MiterLimit { @@ -256,7 +262,8 @@ struct MiterLimit { ### font -``` +```ts +// xxx.ets @Entry @Component struct Fonts { @@ -288,7 +295,8 @@ struct Fonts { ### textAlign -``` +```ts +// xxx.ets @Entry @Component struct CanvasExample { @@ -335,7 +343,8 @@ struct CanvasExample { ### textBaseline -``` +```ts +// xxx.ets @Entry @Component struct TextBaseline { @@ -382,7 +391,8 @@ struct TextBaseline { ### globalAlpha -``` +```ts +// xxx.ets @Entry @Component struct GlobalAlpha { @@ -417,7 +427,8 @@ struct GlobalAlpha { ### lineDashOffset -``` +```ts +// xxx.ets @Entry @Component struct LineDashOffset { @@ -464,7 +475,8 @@ struct LineDashOffset { | copy | 显示新绘制内容而忽略现有绘制内容。 | | xor | 使用异或操作对新绘制内容与现有绘制内容进行融合。 | -``` +```ts +// xxx.ets @Entry @Component struct GlobalCompositeOperation { @@ -504,7 +516,8 @@ struct GlobalCompositeOperation { ### shadowBlur -``` +```ts +// xxx.ets @Entry @Component struct ShadowBlur { @@ -538,7 +551,8 @@ struct ShadowBlur { ### shadowColor -``` +```ts +// xxx.ets @Entry @Component struct ShadowColor { @@ -573,7 +587,8 @@ struct ShadowColor { ### shadowOffsetX -``` +```ts +// xxx.ets @Entry @Component struct ShadowOffsetX { @@ -608,7 +623,8 @@ struct ShadowOffsetX { ### shadowOffsetY -``` +```ts +// xxx.ets @Entry @Component struct ShadowOffsetY { @@ -643,7 +659,8 @@ struct ShadowOffsetY { ### imageSmoothingEnabled -``` +```ts +// xxx.ets @Entry @Component struct ImageSmoothingEnabled { @@ -1648,7 +1665,7 @@ transform(scaleX: number, skewX: number, skewY: number, scaleY: number, translat transform方法对应一个变换矩阵,想对一个图形进行变化的时候,只要设置此变换矩阵相应的参数,对图形的各个定点的坐标分别乘以这个矩阵,就能得到新的定点的坐标。矩阵变换效果可叠加。 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 变换后的坐标计算方式(x和y为变换前坐标,x'和y'为变换后坐标): > > - x' = scaleX \* x + skewY \* y + translateX diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-page-transition-animation.md b/zh-cn/application-dev/reference/arkui-ts/ts-page-transition-animation.md index 6c2933272d3a0e90b99bf3eb687cc736fa4a113a..1c7595fe804ee158e8f87dc050835f8758df2c3b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-page-transition-animation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-page-transition-animation.md @@ -1,6 +1,6 @@ # 页面间转场 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-component.md b/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-component.md index cf0b35935cccc4d96d4b21a723664ba2e2b5ddd7..15650d25328004d44a47b8cafb8bc4cc06e11ae9 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-component.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-component.md @@ -1,6 +1,6 @@ # 组件内转场 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -16,7 +16,7 @@ - transition入参说明 | 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | type | TransitionType | TransitionType.All | 否 | 默认包括组件新增和删除。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 不指定Type时说明插入删除使用同一种效果。 | + | type | TransitionType | TransitionType.All | 否 | 默认包括组件新增和删除。
>  **说明:**
> 不指定Type时说明插入删除使用同一种效果。 | | opacity | number | 1 | 否 | 设置组件转场时的透明度效果,为插入时起点和删除时终点的值。 | | translate | {
x? : number,
y? : number,
z? : number
} | - | 否 | 设置组件转场时的平移效果,为插入时起点和删除时终点的值。 | | scale | {
x? : number,
y? : number,
z? : number,
centerX? : number,
centerY? : number
} | - | 否 | 设置组件转场时的缩放效果,为插入时起点和删除时终点的值。 | @@ -34,7 +34,8 @@ 示例功能通过一个Button控制第二个Button的出现和消失,并通过transition配置第二个Button出现和消失的过场动画。 -``` +```ts +// xxx.ets @Entry @Component struct TransitionExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-shared-elements.md b/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-shared-elements.md index 57ebdcd0567bb63066f95db82d19910bae33c75c..06e889473736a080f28dc92523efcbea2d0f6099 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-shared-elements.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-shared-elements.md @@ -1,6 +1,6 @@ # 共享元素转场 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -25,7 +25,8 @@ 示例功能为两个页面,共享元素转场页面图片点击后转场至页面B的图片。 -``` +```ts +// xxx.ets @Entry @Component struct SharedTransitionExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md index 12b9c249fc0b3488240d5dcac36766867b0daa96..123824d1a5deba3e49c73e5986e905dde35956db 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md @@ -1,6 +1,6 @@ # 背景设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -33,7 +33,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct BackgroundExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md index add589fa8e92a1946bfbbb4d232e8bc1226a5970..d5a4caf31865e7f87f4f7c370d787bc96cd5f516 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-border.md @@ -1,6 +1,6 @@ # 边框设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -34,7 +34,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct BorderExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md index 2f62426bd2ff18c88ae86ba0ab58eeddd93fd99d..f4f688c4c3920a669da4b41e4ecbc39bceab8c96 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-click.md @@ -1,6 +1,6 @@ # 点击控制 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -19,7 +19,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TouchAbleExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md index b3939fe73d40d7bdc9aa1616497cd14829ef412d..3c891de4cdd5a799a6301fb0fb654332c07116dc 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-enable.md @@ -1,6 +1,6 @@ # 禁用控制 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -19,7 +19,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct EnabledExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-flex-layout.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-flex-layout.md index ae6ce5b46ecfba98a33c852e996d3050552454aa..9cb57983343423c9e5b4376d00dc7fc4489d4d1e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-flex-layout.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-flex-layout.md @@ -1,6 +1,6 @@ # Flex布局 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > - 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 > > - 仅当父组件是Flex组件时生效。 @@ -24,7 +24,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct FlexExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md index e6ed56978e3cbcb1fe41101ece127d0f09b40cce..0748f2a9cd61aa6c5bd468fbc6a74d11958a2ac0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md @@ -1,6 +1,6 @@ # 焦点控制 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -15,13 +15,14 @@ | -------- | -------- | -------- | -------- | | focusable | boolean | false | 设置当前组件是否可以获焦。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 支持焦点控制的组件:Button、Text、Image、List、Grid。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct FocusableExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md index bfa90330fb746ec3a6bbd76371c1963bd0fe6b77..e71af0022d870bb9b803f9cdf952be61c37ae345 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-gradient-color.md @@ -1,6 +1,6 @@ # 颜色渐变 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -37,7 +37,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ColorGradientExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-grid.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-grid.md index 6237d39f4e76c11657955fea6fb7fe6e6f136aa5..47a956ac210309c8dce276dc83ab8b228fadcaed 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-grid.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-grid.md @@ -1,6 +1,6 @@ # 栅格设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > - 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 > > - 栅格布局的列宽、列间距由距离最近的GridContainer父组件决定。使用栅格属性的组件树上至少需要有1个GridContainer容器组件。 @@ -17,13 +17,14 @@ | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | | useSizeType | {
xs?: number \| { span: number, offset: number },
sm?: number \| { span: number, offset: number },
md?: number \| { span: number, offset: number },
lg?: number \| { span: number, offset: number }
} | - | 设置在特定设备宽度类型下的占用列数和偏移列数,span: 占用列数; offset: 偏移列数。
当值为number类型时,仅设置列数, 当格式如{"span": 1, "offset": 0}时,指同时设置占用列数与偏移列数。
- xs: 指设备宽度类型为SizeType.XS时的占用列数和偏移列数。
- sm: 指设备宽度类型为SizeType.SM时的占用列数和偏移列数。
- md: 指设备宽度类型为SizeType.MD时的占用列数和偏移列数。
- lg: 指设备宽度类型为SizeType.LG时的占用列数和偏移列数。 | -| gridSpan | number | 1 | 默认占用列数,指useSizeType属性没有设置对应尺寸的列数(span)时,占用的栅格列数。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 设置了栅格span属性,组件的宽度由栅格布局决定。 | -| gridOffset | number | 0 | 默认偏移列数,指useSizeType属性没有设置对应尺寸的偏移(offset)时, 当前组件沿着父组件Start方向,偏移的列数,也就是当前组件位于第n列。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> -配置该属性后,当前组件在父组件水平方向的布局不再跟随父组件原有的布局方式,而是沿着父组件的Start方向偏移一定位移。
> -偏移位移 = (列宽 + 间距)\* 列数。
> -设置了偏移(gridOffset)的组件之后的兄弟组件会根据该组件进行相对布局,类似相对布局。 | +| gridSpan | number | 1 | 默认占用列数,指useSizeType属性没有设置对应尺寸的列数(span)时,占用的栅格列数。
>  **说明:**
> 设置了栅格span属性,组件的宽度由栅格布局决定。 | +| gridOffset | number | 0 | 默认偏移列数,指useSizeType属性没有设置对应尺寸的偏移(offset)时, 当前组件沿着父组件Start方向,偏移的列数,也就是当前组件位于第n列。
>  **说明:**
> -配置该属性后,当前组件在父组件水平方向的布局不再跟随父组件原有的布局方式,而是沿着父组件的Start方向偏移一定位移。
> -偏移位移 = (列宽 + 间距)\* 列数。
> -设置了偏移(gridOffset)的组件之后的兄弟组件会根据该组件进行相对布局,类似相对布局。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct GridContainerExample1 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md index 796b92a921c929133d6c1f9adec13f2b0f78dcce..5ff1536cc78f199d202aa3bcb207df5656930f42 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-hover-effect.md @@ -1,6 +1,6 @@ # 悬浮态效果 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -26,7 +26,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct HoverExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md index 8e67fd5f1e9f076ac59c5f50f977626173be5675..dbb474ba4289020a0c0676bb040b5ae2ff6ee529 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-image-effect.md @@ -1,6 +1,6 @@ # 图像效果 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -29,7 +29,8 @@ ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ImageEffectsExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md index 7f267aac3beda6f6a373fb0183922e512f3657c8..23a1f4329db73c2f9b262e2f56f49239d331df8c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-layout-constraints.md @@ -1,6 +1,6 @@ # 布局约束 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> **说明:** > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -15,12 +15,13 @@ | 名称 | 参数说明 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | | aspectRatio | number | - | 指定当前组件的宽高比。 | -| displayPriority | number | - | 设置当前组件在布局容器中显示的优先级,当父容器空间不足时,低优先级的组件会被隐藏。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 仅在Row/Column/Flex(单行)容器组件中生效。 | +| displayPriority | number | - | 设置当前组件在布局容器中显示的优先级,当父容器空间不足时,低优先级的组件会被隐藏。
>  **说明:**
> 仅在Row/Column/Flex(单行)容器组件中生效。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct AspectRatioExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md index ac65f17a241863ab26b65f9c4a0c217e38d5826f..34af6dbbc7333150cc4e0dd1e53087e9132c663a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-location.md @@ -1,7 +1,8 @@ # 位置设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,26 +13,26 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| align | [Alignment](ts-appendix-enums.md#alignment枚举说明) | Center | 设置元素内容的对齐方式,只有当设置的width和height大小超过元素本身内容大小时生效。 | -| direction | Direction | Auto | 设置元素水平方向的布局,可选值参照Direction枚举说明。 | -| position | {
x: Length,
y: Length
} | - | 使用绝对定位,设置元素锚点相对于父容器顶部起点偏移位置。在布局容器中,设置该属性不影响父容器布局,仅在绘制时进行位置调整。 | -| markAnchor | {
x: Length,
y: Length
} | {
x: 0,
y: 0
} | 设置元素在位置定位时的锚点,以元素顶部起点作为基准点进行偏移。 | -| offset | {
x: Length,
y: Length
} | {
x: 0,
y: 0
} | 相对布局完成位置坐标偏移量,设置该属性,不影响父容器布局,仅在绘制时进行位置调整。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------- | ---------------------------------------- | ------------------------------------ | ---------------------------------------- | +| align | [Alignment](ts-appendix-enums.md#alignment枚举说明) | Center | 设置元素内容的对齐方式,只有当设置的width和height大小超过元素本身内容大小时生效。 | +| direction | Direction | Auto | 设置元素水平方向的布局,可选值参照Direction枚举说明。 | +| position | {
x: Length,
y: Length
} | - | 使用绝对定位,设置元素锚点相对于父容器顶部起点偏移位置。在布局容器中,设置该属性不影响父容器布局,仅在绘制时进行位置调整。 | +| markAnchor | {
x: Length,
y: Length
} | {
x: 0,
y: 0
} | 设置元素在位置定位时的锚点,以元素顶部起点作为基准点进行偏移。 | +| offset | {
x: Length,
y: Length
} | {
x: 0,
y: 0
} | 相对布局完成位置坐标偏移量,设置该属性,不影响父容器布局,仅在绘制时进行位置调整。 | +## Direction枚举说明 -- Direction枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Ltr | 元素从左到右布局。 | - | Rtl | 元素从右到左布局。 | - | Auto | 使用系统默认布局方向。 | - +| 名称 | 描述 | +| ---- | ----------- | +| Ltr | 元素从左到右布局。 | +| Rtl | 元素从右到左布局。 | +| Auto | 使用系统默认布局方向。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PositionExample { @@ -64,7 +65,8 @@ struct PositionExample { ![zh-cn_image_0000001174264368](figures/zh-cn_image_0000001174264368.gif) -``` +```ts +// xxx.ets @Entry @Component struct PositionExample2 { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md index 71c1273bb276dca02d9708a0bbd85601c98f1a31..3c15bdf0786afe6f1bede9a05f815c726e8272b5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-menu.md @@ -1,7 +1,8 @@ # Menu控制 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,29 +13,31 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| bindMenu | Array8+ | - | 给组件绑定菜单,点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 | -| bindContextMenu8+ | content: [CustomBuilder](../../ui/ts-types.md)
responseType: ResponseType | - | 给组件绑定菜单,触发方式为长按或者右键点击,弹出菜单项需要自定义。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------------------------- | ---------------------------------------- | ---- | ---------------------------------- | +| bindMenu | Array8+ | - | 给组件绑定菜单,点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 | +| bindContextMenu8+ | content: [CustomBuilder](../../ui/ts-types.md)
responseType: ResponseType | - | 给组件绑定菜单,触发方式为长按或者右键点击,弹出菜单项需要自定义。 | +## MenuItem -- MenuItem - | 名称 | 类型 | 描述 | - | -------- | -------- | -------- | - | value | string | 菜单项文本。 | - | action | () => void | 点击菜单项的事件回调。 | +| 名称 | 类型 | 描述 | +| ------ | ----------------------- | ----------- | +| value | string | 菜单项文本。 | +| action | () => void | 点击菜单项的事件回调。 | -- ResponseType8+ - | 参数值 | 描述 | - | -------- | -------- | - | LongPress | 通过长按触发菜单弹出。 | - | RightClick | 通过鼠标右键触发菜单弹出。 | +## ResponseType8+ + +| 参数值 | 描述 | +| ---------- | ------------- | +| LongPress | 通过长按触发菜单弹出。 | +| RightClick | 通过鼠标右键触发菜单弹出。 | ## 示例 #### 普通菜单 -``` +```ts +// xxx.ets @Entry @Component struct MenuExample { @@ -116,7 +119,8 @@ struct MenuExample { #### 菜单(右键触发显示) -``` +```ts +// xxx.ets @Entry @Component struct ContextMenuExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md index bba65d744a27c56232b24f55b1fb46b29709d666..44e5d0785420e0b501daee22dcb22b20ad1a548f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-opacity.md @@ -1,11 +1,11 @@ # 透明度设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 设置组件的透明度。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 + ## 权限列表 @@ -15,14 +15,15 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| opacity | number | 1 | 元素的不透明度,取值范围为0到1,1表示为不透明,0表示为完全透明。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------- | ------ | ---- | ---------------------------------- | +| opacity | number | 1 | 元素的不透明度,取值范围为0到1,1表示为不透明,0表示为完全透明。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct OpacityExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md index 45b00a1bdafd5018100d506adf76cf217180106f..9907f1f26810a35295e430592f344384f55a3195 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-overlay.md @@ -1,7 +1,8 @@ # 浮层 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,14 +13,15 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------- | ---------------------------------------- | ---------------------------------------- | ------------------------ | | overlay | title: string,
options: {
align?: [Alignment](ts-appendix-enums.md#alignment枚举说明),
offset?: {x: number, y: number}
} | {
align: Alignment.Center,
offset: {0, 0}
} | 在当前组件上,增加遮罩文本,布局与当前组件相同。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct OverlayExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md index 02941dc6bccbf1e0c8429e1aa69b0a22f2d30d43..44c2a17684ecdd23ab19b72b29f4699d354b8f1a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-polymorphic-style.md @@ -1,7 +1,7 @@ # 多态样式 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 设置组件不同状态下的样式。 @@ -14,21 +14,22 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| stateStyles | StateStyles | - | 设置组件不同状态的样式。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------- | ----------- | ---- | ------------ | +| stateStyles | StateStyles | - | 设置组件不同状态的样式。 | -- StateStyles接口说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | normal | ()=>void | 否 | - | 组件无状态时的样式。 | - | pressed | ()=>void | 否 | - | 组件按下状态的样式。 | - | disabled | ()=>void | 否 | - | 组件禁用状态的样式。 | +## StateStyles接口说明 +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| -------- | ----------- | ---- | ---- | ---------- | +| normal | ()=>void | 否 | - | 组件无状态时的样式。 | +| pressed | ()=>void | 否 | - | 组件按下状态的样式。 | +| disabled | ()=>void | 否 | - | 组件禁用状态的样式。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct StyleExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md index a26b8137956befec8e1153e987e4fb49998f88c4..1cadac8e50e9e6865e7e4c40e6da6c0ad50d8d95 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-popup.md @@ -1,7 +1,8 @@ # Popup控制 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,47 +13,49 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| bindPopup | show: boolean,
popup: PopupOptions\| CustomPopupOptions | - | 给组件绑定Popup,点击弹出弹窗。
show: 创建页面弹窗提示是否默认显示,默认值为false。
popup: 配置当前弹窗提示的参数。 | - - -- PopupOptions类型接口说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | message | string | 是 | - | 弹窗信息内容。 | - | placementOnTop | boolean | 否 | false | 是否在组件上方显示,默认值为false。 | - | primaryButton | {
value: string,
action: () => void
} | 否 | - | 第一个按钮。
value: 弹窗里主按钮的文本。
action: 点击主按钮的回调函数。 | - | secondaryButton | {
value: string,
action: () => void
} | 否 | - | 第二个按钮。
value: 弹窗里辅助按钮的文本。
action: 点击辅助按钮的回调函数。 | - | onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调,参数isVisible为弹窗当前的显示状态。 | - -- CustomPopupOptions8+类型接口说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | builder | () => any | 是 | - | 提示气泡内容的构造器。 | - | placement | Placement | 否 | Placement.Bottom | 气泡组件优先显示的位置,当前位置显示不下时,会自动调整位置。 | - | maskColor | [Color](../../ui/ts-types.md#颜色类型) | 否 | - | 提示气泡遮障层的颜色。 | - | popupColor | [Color](../../ui/ts-types.md#颜色类型) | 否 | - | 提示气泡的颜色。 | - | enableArrow | boolean | 否 | true | 是否显示箭头,只有上、下方向的气泡会显示箭头。 | - | autoCancel | boolean | 否 | true | 页面有操作时,是否自动关闭气泡 | - | onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调,参数为弹窗当前的显示状态。 | - -- Placement8+枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Left | 气泡提示位于组件左侧。 | - | Right | 气泡提示位于组件右侧。 | - | Top | 气泡提示位于组件上侧。 | - | Bottom | 气泡提示位于组件下侧。 | - | TopLeft | 气泡提示位于组件左上角。 | - | TopRight | 气泡提示位于组件右上角。 | - | BottomLeft | 气泡提示位于组件左下角。 | - | BottomRight | 气泡提示位于组件右下角。 | - +| 名称 | 参数类型 | 默认值 | 描述 | +| --------- | ---------------------------------------- | ---- | ---------------------------------------- | +| bindPopup | show: boolean,
popup: PopupOptions\| CustomPopupOptions | - | 给组件绑定Popup,点击弹出弹窗。
show: 创建页面弹窗提示是否默认显示,默认值为false。
popup: 配置当前弹窗提示的参数。 | + +## PopupOptions类型接口说明 + +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| --------------- | ---------------------------------------- | ---- | ----- | ---------------------------------------- | +| message | string | 是 | - | 弹窗信息内容。 | +| placementOnTop | boolean | 否 | false | 是否在组件上方显示,默认值为false。 | +| primaryButton | {
value: string,
action: () => void
} | 否 | - | 第一个按钮。
value: 弹窗里主按钮的文本。
action: 点击主按钮的回调函数。 | +| secondaryButton | {
value: string,
action: () => void
} | 否 | - | 第二个按钮。
value: 弹窗里辅助按钮的文本。
action: 点击辅助按钮的回调函数。 | +| onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调,参数isVisible为弹窗当前的显示状态。 | + +## CustomPopupOptions8+类型接口说明 + +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| ------------- | ---------------------------------------- | ---- | ---------------- | ------------------------------ | +| builder | () => any | 是 | - | 提示气泡内容的构造器。 | +| placement | Placement | 否 | Placement.Bottom | 气泡组件优先显示的位置,当前位置显示不下时,会自动调整位置。 | +| maskColor | [Color](../../ui/ts-types.md#颜色类型) | 否 | - | 提示气泡遮障层的颜色。 | +| popupColor | [Color](../../ui/ts-types.md#颜色类型) | 否 | - | 提示气泡的颜色。 | +| enableArrow | boolean | 否 | true | 是否显示箭头,只有上、下方向的气泡会显示箭头。 | +| autoCancel | boolean | 否 | true | 页面有操作时,是否自动关闭气泡 | +| onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调,参数为弹窗当前的显示状态。 | + +## Placement8+枚举说明 + +| 名称 | 描述 | +| ----------- | ------------ | +| Left | 气泡提示位于组件左侧。 | +| Right | 气泡提示位于组件右侧。 | +| Top | 气泡提示位于组件上侧。 | +| Bottom | 气泡提示位于组件下侧。 | +| TopLeft | 气泡提示位于组件左上角。 | +| TopRight | 气泡提示位于组件右上角。 | +| BottomLeft | 气泡提示位于组件左下角。 | +| BottomRight | 气泡提示位于组件右下角。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct PopupExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md index cb6e258fb771a93e1ea13c04f5f70c55ae477ac7..eec98e9ba2cf6dadcdcd077c42f9b9bb5ae2e1f4 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-size.md @@ -1,7 +1,8 @@ # 尺寸设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,20 +13,21 @@ ## 属性 -| 名称 | 参数说明 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| width | Length | - | 设置组件自身的宽度,缺省时使用元素自身内容需要的宽度。 | -| height | Length | - | 设置组件自身的高度,缺省时使用元素自身内容需要的高度。 | -| size | {
width?: Length,
height?: Length
} | - | 设置高宽尺寸。 | -| padding | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
} \| Length | 0 | 设置内边距属性。
参数为Length类型时,四个方向内边距同时生效。 | -| margin | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
}
\| Length | 0 | 设置外边距属性。
参数为Length类型时,四个方向外边距同时生效。 | -| constraintSize | {
minWidth?: Length,
maxWidth?: Length,
minHeight?: Length,
maxHeight?: Length
} | {
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity
} | 设置约束尺寸,组件布局时,进行尺寸范围限制。 | -| layoutWeight | number | 0 | 容器尺寸确定时,元素与兄弟节点主轴布局尺寸按照权重进行分配,忽略本身尺寸设置。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 仅在Row/Column/Flex布局中生效。 | +| 名称 | 参数说明 | 默认值 | 描述 | +| -------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| width | Length | - | 设置组件自身的宽度,缺省时使用元素自身内容需要的宽度。 | +| height | Length | - | 设置组件自身的高度,缺省时使用元素自身内容需要的高度。 | +| size | {
width?: Length,
height?: Length
} | - | 设置高宽尺寸。 | +| padding | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
} \| Length | 0 | 设置内边距属性。
参数为Length类型时,四个方向内边距同时生效。 | +| margin | {
top?: Length,
right?: Length,
bottom?: Length,
left?: Length
}
\| Length | 0 | 设置外边距属性。
参数为Length类型时,四个方向外边距同时生效。 | +| constraintSize | {
minWidth?: Length,
maxWidth?: Length,
minHeight?: Length,
maxHeight?: Length
} | {
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity
} | 设置约束尺寸,组件布局时,进行尺寸范围限制。 | +| layoutWeight | number | 0 | 容器尺寸确定时,元素与兄弟节点主轴布局尺寸按照权重进行分配,忽略本身尺寸设置。
>  **说明:**
> 仅在Row/Column/Flex布局中生效。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct SizeExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md index 920f40215e0a787c69bfad314c5d21d9989af9c0..be06da35986b7c6b065497bbfd8c5317fee93739 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-text-style.md @@ -1,7 +1,8 @@ # 文本样式设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 针对包含文本元素的组件,设置文本样式。 @@ -15,36 +16,36 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| fontColor | Color | - | 设置文本颜色。 | -| fontSize | Length | - | 设置文本尺寸,Length为number类型时,使用fp单位。 | -| fontStyle | FontStyle | FontStyle.Normal | 设置文本的字体样式。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------- | ------------------------ | --------------------------- | ---------------------------------------- | +| fontColor | Color | - | 设置文本颜色。 | +| fontSize | Length | - | 设置文本尺寸,Length为number类型时,使用fp单位。 | +| fontStyle | FontStyle | FontStyle.Normal | 设置文本的字体样式。 | | fontWeight | number \|FontWeight | FontWeight.FontWeightNormal | 设置文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。
提供常用枚举值,参考:FontWeight枚举说明。 | -| fontFamily | string | - | 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial, sans-serif'。 | +| fontFamily | string | - | 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial, sans-serif'。 | +## FontStyle枚举说明 -- FontStyle枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Normal | 标准的字体样式。 | - | Italic | 斜体的字体样式。 | +| 名称 | 描述 | +| ------ | -------- | +| Normal | 标准的字体样式。 | +| Italic | 斜体的字体样式。 | +## FontWeight枚举说明 -- FontWeight枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Lighter | 字体较细。 | - | Normal | 字体粗细正常。 | - | Regular | 字体粗细正常。 | - | Medium | 字体粗细适中。 | - | Bold | 字体较粗。 | - | Bolder | 字体非常粗。 | - +| 名称 | 描述 | +| ------- | ------- | +| Lighter | 字体较细。 | +| Normal | 字体粗细正常。 | +| Regular | 字体粗细正常。 | +| Medium | 字体粗细适中。 | +| Bold | 字体较粗。 | +| Bolder | 字体非常粗。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct TextStyleExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md index 2af9b5be1fb516d1c58c40c7f4e949a6f9b0a6a7..2043171acbda94af034e0b4bac847e9a902ea05a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-touch-target.md @@ -1,7 +1,8 @@ # 触摸热区设置 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 适用于支持通用点击事件、通用触摸事件、通用手势处理的组件。 @@ -15,26 +16,28 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| responseRegion | Array<Rectangle> \| Rectangle | {
x:0,
y:0,
width:'100%',
height:'100%'
} | 设置一个或多个触摸热区,包括位置和大小。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> -百分比是相对于组件本身来度量的。
> -x和y可以设置正负值百分比。当x设置为'100%'时表示热区往右偏移组件本身宽度大小,当x设置为'-100%'时表示热区往左偏移组件本身宽度大小。当y设置为'100%'时表示热区往下偏移组件本身高度大小,当y设置为'-100%'时表示热区往上偏移组件本身高度大小。
> -width和height只能设置正值百分比。width:'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp,那么'100%'表示热区宽度也为100vp。height:'100%'表示热区高度设置为该组件本身的高度。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| -------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| responseRegion | Array<Rectangle> \| Rectangle | {
x:0,
y:0,
width:'100%',
height:'100%'
} | 设置一个或多个触摸热区,包括位置和大小。
>  **说明:**
> -百分比是相对于组件本身来度量的。
> -x和y可以设置正负值百分比。当x设置为'100%'时表示热区往右偏移组件本身宽度大小,当x设置为'-100%'时表示热区往左偏移组件本身宽度大小。当y设置为'100%'时表示热区往下偏移组件本身高度大小,当y设置为'-100%'时表示热区往上偏移组件本身高度大小。
> -width和height只能设置正值百分比。width:'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp,那么'100%'表示热区宽度也为100vp。height:'100%'表示热区高度设置为该组件本身的高度。 | ### Rectangle对象说明 - | 名称 | 类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | x | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。 | - | y | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。 | - | width | Length | 否 | 100% | 触摸热区范围的宽度。 | - | height | Length | 否 | 100% | 触摸热区范围的高度。 | +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ------ | ---- | ---- | ------------------ | +| x | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。 | +| y | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。 | +| width | Length | 否 | 100% | 触摸热区范围的宽度。 | +| height | Length | 否 | 100% | 触摸热区范围的高度。 | - > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** - > 当x和y都设置为正值时,表示组件的触摸热区的范围整体往组件本身右下角偏移,偏移的大小可通过数值来设置。 + > **说明:** + > + > 当x和y都设置为正值时,表示组件的触摸热区的范围整体往组件本身右下角偏移,偏移的大小可通过数值来设置。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ResponseRegionExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md index 78e95635f49d05622b97de4dc09816b34a24711a..a2ec21c5dee915412b71613772d90ee9bce6fb83 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-transformation.md @@ -1,7 +1,8 @@ # 图形变换 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,12 +13,12 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| rotate | {
x?: number,
y?: number,
z?: number,
angle?: Angle,
centerX?: Length,
centerY?: Length
} | {
x: 0,
y: 0,
z: 0,
angle: 0,
centerX: '50%',
centerY: '50%'
} | (x, y, z)指定一个矢量,表示旋转轴,正角度为顺时针转动,负角度为逆时针转动,默认值为0,同时可以通过centerX和centerY设置旋转的中心点。 | -| translate | {
x?: Length,
y?: Length,
z? : Length
} | {
x: 0,
y: 0,
z: 0
} | 可以分别设置X轴、Y轴、Z轴的平移距离,距离的正负控制平移的方向,默认值为0。 | -| scale | {
x?: number,
y?: number,
z?: number,
centerX?: Length,
centerY?: Length
} | {
x: 1,
y: 1,
z: 1,
centerX:'50%',
centerY:'50%'
} | 可以分别设置X轴、Y轴、Z轴的缩放比例,默认值为1,同时可以通过centerX和centerY设置缩放的中心点。 | -| transform | matrix: Matrix4 | - | 设置当前组件的变换矩阵。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| --------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| rotate | {
x?: number,
y?: number,
z?: number,
angle?: Angle,
centerX?: Length,
centerY?: Length
} | {
x: 0,
y: 0,
z: 0,
angle: 0,
centerX: '50%',
centerY: '50%'
} | (x, y, z)指定一个矢量,表示旋转轴,正角度为顺时针转动,负角度为逆时针转动,默认值为0,同时可以通过centerX和centerY设置旋转的中心点。 | +| translate | {
x?: Length,
y?: Length,
z? : Length
} | {
x: 0,
y: 0,
z: 0
} | 可以分别设置X轴、Y轴、Z轴的平移距离,距离的正负控制平移的方向,默认值为0。 | +| scale | {
x?: number,
y?: number,
z?: number,
centerX?: Length,
centerY?: Length
} | {
x: 1,
y: 1,
z: 1,
centerX:'50%',
centerY:'50%'
} | 可以分别设置X轴、Y轴、Z轴的缩放比例,默认值为1,同时可以通过centerX和centerY设置缩放的中心点。 | +| transform | matrix: Matrix4 | - | 设置当前组件的变换矩阵。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md index 81aee8bf9c665433b40692aec2413d21ef307fbb..382b62cd008df59538d349180db0356ca25752b8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-visibility.md @@ -1,7 +1,8 @@ # 显隐控制 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,22 +13,22 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------- | ---------- | ------------------ | ------------ | | visibility | Visibility | Visibility.Visible | 控制当前组件显示或隐藏。 | +## Visibility枚举说明 -- Visibility枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Hidden | 隐藏,但参与布局进行占位。 | - | Visible | 显示。 | - | None | 隐藏,但不参与布局,不进行占位。 | - +| 名称 | 描述 | +| ------- | ---------------- | +| Hidden | 隐藏,但参与布局进行占位。 | +| Visible | 显示。 | +| None | 隐藏,但不参与布局,不进行占位。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct VisibilityExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md index 00b052581dc316917ef8f27efcaec8b86eebbd2f..ef1cefcaf1bf94a564bf9ff97dc8d7a1153bb523 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-z-order.md @@ -1,7 +1,8 @@ # Z序控制 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -12,14 +13,15 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系,z值越大,显示层级越高。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ------ | ------ | ---- | ---------------------------- | +| zIndex | number | 0 | 同一容器中兄弟组件显示层级关系,z值越大,显示层级越高。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct ZIndexExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md index 61fd9b2820f6146677c5b16808ed70c8acb3cd66..b1bdbfba1a1595952094d573e1f452b0c2c8dd9e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-component-area-change-event.md @@ -1,7 +1,8 @@ # 组件区域变化事件 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -11,14 +12,15 @@ ## 事件 -| 名称 | 支持冒泡 | 功能描述 | -| -------- | -------- | -------- | -| 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)介绍。 | ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct AreaExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md index 54b6b01f3ede7ddaf4c2ed815b2e72ecc35026a0..a137bed6d4aded55d05080b08904b61f07c42e61 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md @@ -1,6 +1,7 @@ # 点击事件 > **说明:** +> > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -26,8 +27,8 @@ | timestamp | number | 事件时间戳。 | ## EventTarget8+对象说明 -| 名称 | 参数类型 | 描述 | -| ---- | ----------------- | ---------- | +| 名称 | 参数类型 | 描述 | +| ---- | ------------------ | ---------- | | area | [Area](#area8对象说明) | 目标元素的区域信息。 | ## Area8+对象说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md index 154a2c0ec7e4f6aca9c77fe86987e1394cb718a7..24db7913bea564444f29029690fbcad9d6493b3f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md @@ -1,6 +1,7 @@ # 拖拽事件 > **说明:** +> > 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md index cdcabb4b2d4b75a11d0c284074475e447be47ece..13a48a0c8056a466fa9e5bfd2e5fdd7eb9dcbefe 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-key.md @@ -3,6 +3,7 @@ 按键事件指组件与键盘、遥控器等按键设备交互时触发的事件。 > **说明:** +> > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -20,22 +21,23 @@ ## KeyEvent对象说明 -- 属性 - | 属性名称 | 类型 | 描述 | - | ------------------------------------- | --------------------------- | -------------------------- | - | type | [KeyType](#keytype枚举说明) | 按键的类型。 | - | [keyCode](../apis/js-apis-keycode.md) | number | 按键的键码。 | - | keyText | string | 按键的键值。 | - | keySource | [KeySource](#keysource枚举说明) | 触发当前按键的输入设备类型。 | - | deviceId | number | 触发当前按键的输入设备ID。 | - | metaKey | number | 按键发生时元键的状态,1表示按压态,0表示未按压态。 | - | timestamp | number | 按键发生时的时间戳。 | - - -- 接口 - | 接口名称 | 功能描述 | - | ---------------------------- | --------- | - | stopPropagation(): void | 阻塞事件冒泡传递。 | +### 属性 + +| 属性名称 | 类型 | 描述 | +| ------------------------------------- | --------------------------- | -------------------------- | +| type | [KeyType](#keytype枚举说明) | 按键的类型。 | +| [keyCode](../apis/js-apis-keycode.md) | number | 按键的键码。 | +| keyText | string | 按键的键值。 | +| keySource | [KeySource](#keysource枚举说明) | 触发当前按键的输入设备类型。 | +| deviceId | number | 触发当前按键的输入设备ID。 | +| metaKey | number | 按键发生时元键的状态,1表示按压态,0表示未按压态。 | +| timestamp | number | 按键发生时的时间戳。 | + +### 接口 + +| 接口名称 | 功能描述 | +| ---------------------------- | --------- | +| stopPropagation(): void | 阻塞事件冒泡传递。 | ## KeyType枚举说明 | 名称 | 描述 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md index 417b6c0611f7827d2b71a95c31ee4df25f71d4e2..41f987afdd5e8030d1d720081ef6e3d6491c91d3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-show-hide.md @@ -1,7 +1,8 @@ # 挂载卸载事件 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -11,10 +12,10 @@ ## 事件 -| 名称 | 支持冒泡 | 功能描述 | -| -------- | -------- | -------- | -| onAppear(callback: () => void) | 否 | 组件挂载显示时触发此回调。 | -| onDisappear(callback: () => void) | 否 | 组件卸载消失时触发此回调。 | +| 名称 | 支持冒泡 | 功能描述 | +| ---------------------------------------- | ---- | ------------- | +| onAppear(callback: () => void) | 否 | 组件挂载显示时触发此回调。 | +| onDisappear(callback: () => void) | 否 | 组件卸载消失时触发此回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md index 4745e9e02cb7669f1f7a85fec8428efabf449122..8de6233baf2968474c35b745a46e6a56ddd62238 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-touch.md @@ -1,6 +1,7 @@ # 触摸事件 > **说明:** +> > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 @@ -18,21 +19,21 @@ ## TouchEvent对象说明 -- 属性 - | 属性名称 | 类型 | 描述 | - | ------------------- | ---------------------------------------- | ------------ | - | type | TouchType | 触摸事件的类型。 | - | touches | Array<[TouchObject](#touchobject对象说明)> | 全部手指信息。 | - | changedTouches | Array<[TouchObject](#touchobject对象说明)> | 当前发生变化的手指信息。 | - | timestamp | number | 事件时间戳。 | - | target8+ | [EventTarget](ts-universal-events-click.md#eventtarget8对象说明) | 被触摸元素对象。 | +### 属性 +| 属性名称 | 类型 | 描述 | +| ------------------- | ---------------------------------------- | ------------ | +| type | TouchType | 触摸事件的类型。 | +| touches | Array<[TouchObject](#touchobject对象说明)> | 全部手指信息。 | +| changedTouches | Array<[TouchObject](#touchobject对象说明)> | 当前发生变化的手指信息。 | +| timestamp | number | 事件时间戳。 | +| target8+ | [EventTarget](ts-universal-events-click.md#eventtarget8对象说明) | 被触摸元素对象。 | -- 接口 - | 接口名称 | 功能描述 | - | ---------------------- | ------- | - | stopPropagation():void | 阻塞事件冒泡。 | +### 接口 +| 接口名称 | 功能描述 | +| ---------------------- | ------- | +| stopPropagation():void | 阻塞事件冒泡。 | ## TouchObject对象说明 | 属性名称 | 类型 | 描述 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md index b816e134e544ffbc07b91d9946fb74ec0527e2d4..d2628f18a01ef13f539c61cdf5dfaf8519731edc 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-focus-event.md @@ -1,7 +1,8 @@ # 焦点事件 -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +> **说明:** +> +> 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 权限列表 @@ -11,18 +12,19 @@ ## 事件 -| **名称** | **支持冒泡** | **功能描述** | -| -------- | -------- | -------- | -| onFocus(callback: () => void) | 否 | 当前组件获取焦点时触发的回调。 | -| onBlur(callback:() => void) | 否 | 当前组件失去焦点时触发的回调。 | +| **名称** | **支持冒泡** | **功能描述** | +| ---------------------------------------- | -------- | --------------- | +| onFocus(callback: () => void) | 否 | 当前组件获取焦点时触发的回调。 | +| onBlur(callback:() => void) | 否 | 当前组件失去焦点时触发的回调。 | -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** -> 支持焦点事件的组件:Button、Text、Image、List、Grid。 +> **说明:** +> 支持焦点事件的组件:Button、Text、Image、List、Grid。 ## 示例 -``` +```ts +// xxx.ets @Entry @Component struct FocusEventExample { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md index febe01ccc186e38bb1bebc8a0f1b9524b54227ef..158bafe41994307d23dc4cbd0bca8ff412ad4e8d 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-mouse-key.md @@ -1,6 +1,7 @@ # 鼠标事件 > **说明:** +> > 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。