diff --git a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001236876377.jpg b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001236876377.jpg index b12c5fb6563c7ee9d8dfa7e6af1cfe1dcfa1361c..e5af4f50ebd9bdab6af30219f30fdf948a019a52 100644 Binary files a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001236876377.jpg and b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001236876377.jpg differ diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-appendix-enums.md b/zh-cn/application-dev/reference/arkui-ts/ts-appendix-enums.md index 206340230419dda2809cc5210bc23d261308c9db..62db1a023a01f369b6fa4d4421aecda83a79f840 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-appendix-enums.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-appendix-enums.md @@ -2,18 +2,19 @@ ## Color -| 颜色名称 | 颜色值 | 颜色示意 | -| ------------------------ | -------- | ------------------------------------------------------------ | -| Black | 0x000000 | ![zh-cn_image_0000001219864153](figures/zh-cn_image_0000001219864153.png) | -| Blue | 0x0000ff | ![zh-cn_image_0000001174104404](figures/zh-cn_image_0000001174104404.png) | -| Brown | 0xa52a2a | ![zh-cn_image_0000001219744201](figures/zh-cn_image_0000001219744201.png) | -| Gray | 0x808080 | ![zh-cn_image_0000001174264376](figures/zh-cn_image_0000001174264376.png) | -| Green | 0x008000 | ![zh-cn_image_0000001174422914](figures/zh-cn_image_0000001174422914.png) | -| Orange | 0xffa500 | ![zh-cn_image_0000001219662661](figures/zh-cn_image_0000001219662661.png) | -| Pink | 0xffc0cb | ![zh-cn_image_0000001219662663](figures/zh-cn_image_0000001219662663.png) | -| Red | 0xff0000 | ![zh-cn_image_0000001219662665](figures/zh-cn_image_0000001219662665.png) | -| White | 0xffffff | ![zh-cn_image_0000001174582866](figures/zh-cn_image_0000001174582866.png) | -| Yellow | 0xffff00 | ![zh-cn_image_0000001174582864](figures/zh-cn_image_0000001174582864.png) | +| 颜色名称 | 颜色值 | 颜色示意 | +| -------- | -------- | ------------------------------------------------------------ | +| Black | 0x000000 | ![zh-cn_image_0000001219864153](figures/zh-cn_image_0000001219864153.png) | +| Blue | 0x0000ff | ![zh-cn_image_0000001174104404](figures/zh-cn_image_0000001174104404.png) | +| Brown | 0xa52a2a | ![zh-cn_image_0000001219744201](figures/zh-cn_image_0000001219744201.png) | +| Gray | 0x808080 | ![zh-cn_image_0000001174264376](figures/zh-cn_image_0000001174264376.png) | +| Green | 0x008000 | ![zh-cn_image_0000001174422914](figures/zh-cn_image_0000001174422914.png) | +| Orange | 0xffa500 | ![zh-cn_image_0000001219662661](figures/zh-cn_image_0000001219662661.png) | +| Pink | 0xffc0cb | ![zh-cn_image_0000001219662663](figures/zh-cn_image_0000001219662663.png) | +| Red | 0xff0000 | ![zh-cn_image_0000001219662665](figures/zh-cn_image_0000001219662665.png) | +| White | 0xffffff | ![zh-cn_image_0000001174582866](figures/zh-cn_image_0000001174582866.png) | +| Yellow | 0xffff00 | ![zh-cn_image_0000001174582864](figures/zh-cn_image_0000001174582864.png) | +| Grey | 0x808080 | ![zh-cn_image_0000001174264376](figures/zh-cn_image_0000001174264376.png) | ## ImageFit @@ -69,6 +70,7 @@ | Press | 鼠标按键按下。 | | Release | 鼠标按键松开。 | | Move | 鼠标移动。 | +| Hover | 鼠标悬停。 | ## Curve @@ -99,10 +101,12 @@ ## FillMode -| 名称 | 描述 | -| -------- | -------------------------------- | -| None | 播放完成后恢复初始状态。 | -| Forwards | 播放完成后保持动画结束时的状态。 | +| 名称 | 描述 | +| --------- | -------------------------------------------------------- | +| None | 播放完成后恢复初始状态。 | +| Forwards | 播放完成后保持动画结束时的状态。 | +| Backwards | 在显示动画之前,为动画延迟指定的时间段应用“开始”属性值。 | +| Both | 应用正向和反向填充模式。 | ## PlayMode 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 712f1619796f55e7e730460806e362b155ec4838..ea8b4a0a7629efee1e72fdc24627659108047ec3 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 @@ -19,13 +19,13 @@ ## 接口 -Blank(min?: Length) +Blank(min?: number | string) **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | ---------------------------- | ---- | ------ | ------------------------------------ | -| min | [Length](ts-types.md#length) | 否 | 0 | 空白填充组件在容器主轴上的最小大小。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | ---------------- | ---- | ------ | ------------------------------------ | +| min | number \| string | 否 | 0 | 空白填充组件在容器主轴上的最小大小。 | ## 属性 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 1ed06ba87e197e56bfe813e880cfabf6766887a5..ff1a8d6ae3af6a29f11db749dec523267e880f80 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 @@ -16,7 +16,7 @@ ## 接口 -Checkbox( name?: string, group?: string ) +Checkbox( options?: {name?: string, group?: string} ) **参数:** 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 218afeda49fc2a840d4d26e9491d2b121ebe8bc2..649e80e27b5cc1b229767dc628437644f52c35fe 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 @@ -16,7 +16,7 @@ ## 接口 -CheckboxGroup( group?: string ) +CheckboxGroup( option?: {group?: string} ) 创建多选框群组,可以控制群组内的Checkbox全选或者不全选,相同group的Checkbox和CheckboxGroup为同一群组。 @@ -35,9 +35,22 @@ CheckboxGroup( group?: string ) ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onChange (callback: (names: Array<string>, status: SelectStatus) => void ) | CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时,触发回调。
- names:群组内所有被选中的多选框名称。
- status:选中状态。 | +## onChange + +onChange (callback: (event: CheckboxGroupResult ) => void ) + +CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时,触发回调。 + +| 名称 | 参数类型 | 必填 | 描述 | +| ----- | ------------------- | ---- | -------------------- | +| event | CheckboxGroupResult | 是 | 选中状态的回调结果。 | + +## CheckboxGroupResult + +| 名称 | 参数类型 | 描述 | +| ------ | ------------------- | -------------- | +| name | Array<string> | checkBox名称。 | +| status | selectStatus | 选中状态。 | ## SelectStatus枚举说明 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 ff2fb565e4a16d9505f8f792c8aa21aad3db1468..cb7fae4c536a2df5ac01e9876f0249671bdc0d1e 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 @@ -22,6 +22,14 @@ DataPanel(options:{values: number[], max?: number, type?: DataPanelType}) | max | number | 否 | 100 | - max大于0,表示数据的最大值。
- max小于等于0,max等于value数组各项的和,按比例显示。 | | type8+ | DataPanelType | 否 | DataPanelType.Circle | 数据面板的类型。 | +## 属性 + +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------- | -------- | ------ | ------------------------------------ | +| closeEffect | boolean | true | 设置是否禁用数据比率图表的特殊效果。 | + + + ## DataPanelType枚举说明 | 名称 | 描述 | 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 dc170aba22056f7a8f723b88c5a1852354a0d81c..3dcd973266b811dc3eb66ea2d659a273f813a853 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 @@ -24,7 +24,7 @@ Divider() | ----------- | --------------------------------------------------------- | ----------------- | ------------------------------------------------------------ | | vertical | boolean | false | 使用水平分割线还是垂直分割线,false: 水平分割线, true:垂直分割线。 | | color | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置分割线颜色。 | -| strokeWidth | [Length](ts-types.md#length) | 1 | 设置分割线宽度。 | +| strokeWidth | number \| string | 1 | 设置分割线宽度。 | | lineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle枚举说明) | LineCapStyle.Butt | 设置分割线条的端点样式。 | 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 91d290bef726e242937dbdae7c9c91403f2f00e3..8b16eb1a5afbee14e4b1e0226762e7761c6b9db6 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 @@ -33,8 +33,8 @@ Gauge(options:{value: number, min?: number, max?: number}) | value | number | 0 | 设置当前数据图表的值。 | | startAngle | number | -150 | 设置起始角度位置,时钟0点为0度,顺时针方向为正角度。 | | endAngle | number | 150 | 设置终止角度位置,时钟0点为0度,顺时针方向为正角度。 | -| colors | Array<ColorStop> | - | 设置图表的颜色,支持分段颜色设置。 | -| strokeWidth | Length | - | 设置环形图表的环形厚度。 | +| colors | Array<any> | - | 设置图表的颜色,支持分段颜色设置。 | +| strokeWidth | [Length](ts-types.md#length) | - | 设置环形图表的环形厚度。 | ## 示例 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 2599fc7c4f042c77d4e0753b31a46280bbee25ea..97ad67174661bc2245e2b17d8279354895464cf7 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 @@ -24,16 +24,16 @@ 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](ts-appendix-enums.md#animationstatus) | Initial | 否 | 默认为初始状态,用于控制播放状态。 | -| duration | number | 1000 | 否 | 单位为毫秒,默认时长为1000ms;duration为0时,不播放图片;值的改变只会在下一次循环开始时生效;当images中设置了单独的duration后,该属性设置无效。 | -| reverse | boolean | false | 否 | 设置播放顺序。false表示从第1张图片播放到最后1张图片; true表示从最后1张图片播放到第1张图片。 | -| fixedSize | boolean | true | 否 | 设置图片大小是否固定为组件大小。 true表示图片大小与组件大小一致,此时设置图片的width 、height 、top 和left属性是无效的。false表示每一张图片的 width 、height 、top和left属性都要单独设置。 | -| preDecode | number | 0 | 否 | 是否启用预解码,默认值为0,即不启用预解码,如该值设为2,则播放当前页时会提前加载后面两张图片至缓存以提升性能。 | -| fillMode | [FillMode](ts-appendix-enums.md#fillmode) | Forwards | 否 | 设置动画开始前和结束后的状态,可选值参见FillMode说明。 | -| iterations | number | 1 | 否 | 默认播放一次,设置为-1时表示无限次播放。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ---------- | ------------------------------------------------------------ | -------- | ---- | ------------------------------------------------------------ | +| images | Array<{
src: string,
width?: number \| string,
height?: number \| string,
top?: number \| string,
left?: number \| string,
duration?: number
}> | [] | 是 | 设置图片帧信息集合。每一帧的帧信息包含图片路径、图片大小、图片位置和图片播放时长信息。详细说明:
- src:图片路径,图片格式为svg,png和jpg。
- width:图片宽度。
- height:图片高度。
- top:图片相对于组件左上角的纵向坐标。
- left:图片相对于组件左上角的横向坐标。
- duration:每一帧图片的播放时长,单位毫秒。 | +| state | [AnimationStatus](ts-appendix-enums.md#animationstatus) | Initial | 否 | 默认为初始状态,用于控制播放状态。 | +| duration | number | 1000 | 否 | 单位为毫秒,默认时长为1000ms。
duration为0时,不播放图片。
值的改变只会在下一次循环开始时生效。
当images中设置了单独的duration后,该属性设置无效。 | +| reverse | boolean | false | 否 | 设置播放顺序。false表示从第1张图片播放到最后1张图片; true表示从最后1张图片播放到第1张图片。 | +| fixedSize | boolean | true | 否 | 设置图片大小是否固定为组件大小。 true表示图片大小与组件大小一致,此时设置图片的width 、height 、top 和left属性是无效的。false表示每一张图片的 width 、height 、top和left属性都要单独设置。 | +| preDecode | number | 0 | 否 | 是否启用预解码,默认值为0,即不启用预解码,如该值设为2,则播放当前页时会提前加载后面两张图片至缓存以提升性能。 | +| fillMode | [FillMode](ts-appendix-enums.md#fillmode) | Forwards | 否 | 设置动画开始前和结束后的状态,可选值参见FillMode说明。 | +| iterations | number | 1 | 否 | 默认播放一次,设置为-1时表示无限次播放。 | ## 事件 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 d2478d5c598daadc3cf85afd41a4c866d3698f9b..6dc417a5b8a9a4cf4ba6de2db3549772b87028b1 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 @@ -32,7 +32,7 @@ Navigation() | subtitle | string | - | 页面副标题。 | | menus | Array8+ | - | 页面右上角菜单。 | | titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 | -| toolBar | {
items:Array<Object> }
\| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | +| toolBar | object\| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | | hideToolBar | boolean | false | 设置隐藏/显示工具栏:
true: 隐藏工具栏。
false: 显示工具栏。 | | hideTitleBar | boolean | false | 隐藏标题栏。 | | hideBackButton | boolean | false | 隐藏返回键。 | 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 c0947c870208178884c7e23bef3d211119ed457c..d2ef15a682a9a44b8c1944105460a1bc10918a54 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 @@ -19,17 +19,18 @@ ## 接口 -Progress(options: {value: number, total?: number, type?: ProgressType}) +Progress(options: {value: number, total?: number, style?: ProgressStyle, type?: ProgressType}) 创建进度组件,用于显示内容加载或操作处理进度。 **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------------ | ---- | ------------------- | -------- | -| value | number | 是 | - | 指定当前进度值。 | -| total | number | 否 | 100 | 指定进度总长。 | -| type | ProgressType | 否 | ProgressType.Linear | 指定进度条样式。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | ------------- | ---- | -------------------- | ---------------- | +| value | number | 是 | - | 指定当前进度值。 | +| total | number | 否 | 100 | 指定进度总长。 | +| type | ProgressType | 否 | ProgressType.Linear | 指定进度条样式。 | +| style | ProgressStyle | 否 | ProgressStyle.Linear | 指定进度条样式。 | ## ProgressType枚举说明 @@ -41,13 +42,23 @@ Progress(options: {value: number, total?: number, type?: ProgressType}) | ScaleRing8+ | 环形有刻度样式,类似时钟刻度形式加载进度。 | | Capsule8+ | 胶囊样式,头尾两端处,进度条由弧形变成直线和直线变成弧形的过程;中段处,进度条正常往右走的过程。 | +## ProgressStyle枚举说明 + +| 名称 | 描述 | +| ---------------------- | ------------------------------------------------------------ | +| Linear | 线性样式。 | +| Ring8+ | 环形无刻度样式,环形圆环逐渐填充完成过程。 | +| Eclipse | 圆形样式,展现类似月圆月缺的进度展示效果,从月牙逐渐到满月的这个过程代表了下载的进度。 | +| ScaleRing8+ | 环形有刻度样式,类似时钟刻度形式加载进度。 | +| Capsule8+ | 胶囊样式,头尾两端处,进度条由弧形变成直线和直线变成弧形的过程;中段处,进度条正常往右走的过程。 | + ## 属性 | 名称 | 参数类型 | 默认值 | 描述 | | ------------------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | | value | number | - | 设置当前进度值。 | | color | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置进度条前景色。 | -| style8+ | {
strokeWidth?: Length,
scaleCount?: number,
scaleWidth?: Length
} | - | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时,刻度粗细为系统默认粗细。 | +| style8+ | {
strokeWidth?: [Length](ts-types.md#length),
scaleCount?: number,
scaleWidth?: [Length](ts-types.md#length)
} | - | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时,刻度粗细为系统默认粗细。 | ## 示例 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 ffc60da4276ad5f7686d0175ebf69934cdbcb0cb..8a1fdafccd28852189054e23d6e8d72600d66f12 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 @@ -19,7 +19,7 @@ ## 接口 -Slider(options:{value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis, reverse?: boolean}) +Slider(options?: {value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis, reverse?: boolean}) **参数:** 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 e9622fb146a2479e8bcf225fd394d55d9fac2827..c2c2c08c45e62cb0e7e879691eb41e4e7c97b0e7 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 @@ -19,13 +19,13 @@ ## 接口 -Span(content: ResourceStr) +Span(content: string | Resource) **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ------ | ---- | ---- | ----- | -| content | [ResourceStr](ts-types.md#resourcestr8) | 是 | - | 文本内容。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ---------------------------------------- | ---- | ------ | ---------- | +| content | string\|[Resource](ts-types.md#resource) | 是 | - | 文本内容。 | ## 属性 @@ -34,7 +34,7 @@ Span(content: ResourceStr) | 名称 | 参数类型 | 默认值 | 描述 | | ---------- | ---------------------------------------- | ---------------------------------------- | -------------- | | decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | {
type: TextDecorationType.None
color:Color.Black
} | 设置文本装饰线样式及其颜色。 | -| letterSpacing | [Length](ts-types.md#length) | - | 设置文本字符间距。 | +| letterSpacing | number\|string | - | 设置文本字符间距。 | | textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | Normal | 设置文本大小写。 | 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 dd5a76bfaec12a36d0008512432ba5bd132be6d7..46310bdef3e2a623b58deda098c1273d814f17e5 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 @@ -19,13 +19,13 @@ ## 接口 -Text(content?: ResourceStr) +Text(content?: string | Resource) **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ------ | ---- | ---- | ---------------------------------------- | -| content | [ResourceStr](ts-types.md#resourcestr8) | 否 | '' | 文本内容。包含子组件Span时不生效,显示Span内容,并且此时text组件的样式不生效。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------- | ------------------------------------------ | ---- | ------ | ------------------------------------------------------------ | +| content | string \| [Resource](ts-types.md#resource) | 否 | '' | 文本内容。包含子组件Span时不生效,显示Span内容,并且此时text组件的样式不生效。 | ## 属性 @@ -36,8 +36,8 @@ Text(content?: ResourceStr) | maxLines | number | Infinity | 设置文本的最大行数。 | | lineHeight | string \| number \| [Resource](ts-types.md#resource) | - | 设置文本的文本行高,设置值不大于0时,不限制文本行高,自适应字体大小,Length为number类型时单位为fp。 | | decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | {
type: TextDecorationType.None,
color:Color.Black
} | 设置文本装饰线样式及其颜色。 | -| baselineOffset | [Length](ts-types.md#length) | - | 设置文本基线的偏移量。 | -| letterSpacing | [Length](ts-types.md#length) | - | 设置文本字符间距。 | +| baselineOffset | number \| string | - | 设置文本基线的偏移量。 | +| letterSpacing | number \| string | - | 设置文本字符间距。 | | minFontSize | number \| string \| [Resource](ts-types.md#resource) | - | 设置文本最小显示字号。 | | maxFontSize | number \| string \| [Resource](ts-types.md#resource) | - | 设置文本最大显示字号。 | | textCase | [TextCase](ts-appendix-enums.md#textcase) | TextCase.Normal | 设置文本大小写。 | 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 3d592169c74fbe68436a04923d6740c9b4163190..6e3b78cf19a4dc2883bba20da0b8d152eb37b370 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 @@ -36,7 +36,7 @@ TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Tex | 名称 | 参数类型 | 默认值 | 描述 | | ------------------------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | | placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder文本颜色。 | -| placeholderFont | {
size?: number,
weight?:number \| [FontWeight](ts-universal-attributes-text-style.md),
family?: string,
style?: [FontStyle](ts-universal-attributes-text-style.md)
} | - | 设置placeholder文本样式:
- size: 设置文本尺寸,Length为number类型时,使用fp单位。
- weight: 设置文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。
- family: 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效,例如:'Arial, sans-serif'。
- style: 设置文本的字体样式。 | +| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式:
- size: 设置文本尺寸,Length为number类型时,使用fp单位。
- weight: 设置文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。
- family: 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效,例如:'Arial, sans-serif'。
- style: 设置文本的字体样式。 | | textAlign | [TextAlign](ts-appendix-enums.md#textalign) | Start | 设置文本水平对齐方式。 | | caretColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置输入框光标颜色。 | | inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | - | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示,不满足的输入被忽略。仅支持单个字符匹配,不支持字符串匹配。例如:^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$,不支持过滤8到10位的强密码。
- value:设置正则表达式。
- error:正则匹配失败时,返回被忽略的内容。 | 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 df999bed501868d5529e6e625be09bbbb173ba50..f76b3fdaaf5dc4cbf91db96a21fe623fec76f60e 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 @@ -37,12 +37,11 @@ TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Te | ----------------------------- | ------------------------------------------------------------ | ----------------- | ------------------------------------------------------------ | | type | InputType | InputType.Normal | 设置输入框类型。 | | placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder颜色。 | -| placeholderFont | {
size?: Length,
weight?: number\|[FontWeight](ts-universal-attributes-text-style.md),
family?: string,
style?: [FontStyle](ts-universal-attributes-text-style.md)
} | - | 设置placeholder文本样式:
- size: 设置文本尺寸,Length为number类型时,使用fp单位。
- weight: 设置文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。
- family: 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial, sans-serif'。
- style: 设置文本的字体样式。 | +| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式:
- size: 设置文本尺寸,Length为number类型时,使用fp单位。
- weight: 设置文本的字体粗细,number类型取值[100, 900],取值间隔为100,默认为400,取值越大,字体越粗。
- family: 设置文本的字体列表。使用多个字体,使用','进行分割,优先级按顺序生效。例如:'Arial, sans-serif'。
- style: 设置文本的字体样式。 | | enterKeyType | EnterKeyType | EnterKeyType.Done | 设置输入法回车键类型。 | | caretColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置输入框光标颜色。 | | maxLength | number | - | 设置文本的最大输入字符数。 | | inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | - | 正则表达式,满足表达式的输入允许显示,不满足正则表达式的输入被忽略。仅支持单个字符匹配,不支持字符串匹配。例如:^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$,8到10位的强密码不支持过滤。
- value:设置正则表达式。
- error:正则匹配失败时,返回被忽略的内容。 | -| showPasswordIcon9+ | boolean | true | 密码输入模式时,密码框末尾的图标是否显示。 | ## EnterKeyType枚举说明 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 ec399310257262a73c410c14b91fb4248c09c472..ec08cb1e6ac5179dc70839685dd1421eb76a4d37 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 @@ -19,7 +19,7 @@ ## 接口 -TextPicker(options: {range: string[]|Resource, selected?: number, value?: string}) +TextPicker(options?: {range: string[]|Resource, selected?: number, value?: string}) 根据range指定的选择范围创建文本选择器。 @@ -33,9 +33,9 @@ TextPicker(options: {range: string[]|Resource, selected?: number, value?: string ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------------- | ------ | ---- | ---------------- | -| defaultPickerItemHeight | Length | - | 默认Picker内容项元素高度。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ----------------------- | -------------- | ------ | -------------------------- | +| defaultPickerItemHeight | number\|string | - | 默认Picker内容项元素高度。 | ## 事件 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 df1a877c05ef010250e75a3f515af8a5233ccebf..ec595bb090c1343a22e045e805a8c7d3ff6b8800 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 @@ -19,7 +19,7 @@ ## 接口 -TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTimerController }) +TextTimer(options?: { isCountDown?: boolean, count?: number, controller?: TextTimerController }) **参数:** 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 634a563c092694e480cf5fe2cbd1bbe2ff391e8d..92370002cac4aa8c4c9b50a62ab2b362e48f102c 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 @@ -19,7 +19,7 @@ ## 接口 -TimePicker(options?: TimePickerOptions) +TimePicker( options?: { selected?: Data }) 默认以00:00至23:59的时间区间创建滑动选择器。 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 9f11de083b79f5efd32d63dbf939119e6994e5e2..c1dce5fd99edd0a7f2a89e2564f76814039eddb1 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 @@ -85,7 +85,7 @@ destroy(name: string): void path: this.animatePath, }) }) - + // @ts-ignore Animator('__lottie_ets') // declare Animator('__lottie_ets') when use lottie Button('load animation') .onClick(() => { 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 dce05090891618aca6d9c19e1130700d869a26da..6452dfd07a1fbc8e6cfd8661fddba16d195e2c5e 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 @@ -40,8 +40,10 @@ AlphabetIndexer(value: {arrayValue: Array<string>, selected: number}) | selectedFont | [Font](ts-types.md#font) | 设置选中项文字样式。 | | popupFont | [Font](ts-types.md#font) | 设置提示弹窗字体样式。 | | font | [Font](ts-types.md#font) | 设置字母索引条默认字体样式。 | -| itemSize | Length | 设置字母索引条字母区域大小,字母区域为正方形,即正方形边长。 | +| itemSize | string \| number | 设置字母索引条字母区域大小,字母区域为正方形,即正方形边长。 | | alignStyle | IndexerAlign | 设置提示弹窗的弹出位置。 | +| selected | number | 设置选中项索引值。 | +| popupPosition | {
x?:[Length](ts-types.md#length)
y?:[Length](ts-types.md#length)
} | 设置弹出窗口相对于索引器条上边框中点的位置。 | ## IndexerAlign枚举说明 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 74c3addbc6da5294890faa601c3e53c5ba523aa4..470174aa5ab238c276262623e3375f1a3805ea81 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 @@ -19,13 +19,13 @@ ## 接口 -Column(value?:{space?: Length}) +Column(value?:{space?: string | number}) **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | --------- | -| space | Length | 否 | 0 | 纵向布局元素间距。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | -------------- | ---- | ------ | ------------------ | +| space | string\|number | 否 | 0 | 纵向布局元素间距。 | ## 属性 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 80cb4fc94288a1754092e241bb2771259e676194..c282a22d3746b08dc37ef2db7ba104bf46488a69 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 @@ -37,8 +37,8 @@ Grid(scroller?: Scroller) | columnsGap | Length | 0 | 用于设置列与列的间距。 | | rowsGap | Length | 0 | 用于设置行与行的间距。 | | scrollBar | [BarState](ts-appendix-enums.md#barstate) | BarState.Off | 设置滚动条状态。 | -| scrollBarColor | string \| number \| Color | - | 设置滚动条的颜色。 | -| scrollBarWidth | Length | - | 设置滚动条的宽度。 | +| scrollBarColor | string \| number \| [Color](ts-appendix-enums.md#color) | - | 设置滚动条的颜色。 | +| scrollBarWidth | string \| number | - | 设置滚动条的宽度。 | | cachedCount | number | 1 | 设置预加载的GridItem的数量。 | | editMode 8+ | boolean | flase | 是否进入编辑模式,进入编辑模式可以拖拽Grid组件内部[GridItem](ts-container-griditem.md)。 | | layoutDirection8+ | GridDirection | GridDirection.Row | 设置布局的主轴方向。 | 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 51e10bb92756b345c0ca2cce102d25ac78229935..00ff348764438a53dd2057d43542017f86300d92 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 @@ -19,16 +19,16 @@ ## 接口 -GridContainer(options?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: Length, margin?: Length}) +GridContainer(options?: { columns?: number | auto, sizeType?: SizeType, gutter?: string|number, margin?: string|number}) **参数:** -| 参数名 | 类型 | 必填 | 默认值 | 说明 | -| -------- | -------------------------- | ---- | ------------- | ---------- | -| columns | number \| 'auto' | 否 | 'auto' | 设置当前布局总列数。 | -| sizeType | SizeType | 否 | SizeType.Auto | 选用设备宽度类型。 | -| gutter | Length | 否 | - | 栅格布局列间距。 | -| margin | Length | 否 | - | 栅格布局两侧间距。 | +| 参数名 | 类型 | 必填 | 默认值 | 说明 | +| -------- | ------------------------ | ---- | ------------- | -------------------- | +| columns | number \| auto | 否 | auto | 设置当前布局总列数。 | +| sizeType | SizeType | 否 | SizeType.Auto | 选用设备宽度类型。 | +| gutter | Length | 否 | - | 栅格布局列间距。 | +| margin | Length | 否 | - | 栅格布局两侧间距。 | ## SizeType枚举说明 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 c1ce2af6874226ccfc67db86269946cf3640546b..94a2f6d117a45bdcd7ba1eb13a1bdd5709435c45 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 @@ -21,13 +21,13 @@ ## 接口 -List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller}) +List(value?:{space?: number | string, initialIndex?: number, scroller?: Scroller}) **参数:** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ------------ | ------ | ---- | ---- | ---------------------------------------- | -| space | Length | 否 | 0 | 列表项间距。 | +| space | number \| string | 否 | 0 | 列表项间距。 | | initialIndex | number | 否 | 0 | 设置当前List初次加载时视口起始位置显示的item,即显示第一个item,如设置的序号超过了最后一个item的序号,则设置不生效。 | | scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | @@ -36,14 +36,13 @@ List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller} | 名称 | 参数类型 | 默认值 | 描述 | | ---------------------------- | ---------------------------------------- | ----------------- | ---------------------------------------- | | listDirection | [Axis](ts-appendix-enums.md#axis) | Vertical | 设置List组件排列方向参照Axis枚举说明。 | -| divider | {
strokeWidth: Length,
color?:[ResourceColor](ts-types.md#resourcecolor8),
startMargin?: Length,
endMargin?: Length
} | - | 用于设置ListItem分割线样式,默认无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin: 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | +| divider | {
strokeWidth: [Length](ts-types.md#length),
color?: [ResourceColor](ts-types.md#resourcecolor8),
startMargin?: [Length](ts-types.md#length),
endMargin?: [Length](ts-types.md#length)
} \| null | - | 用于设置ListItem分割线样式,默认无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin: 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | | scrollBar | [BarState](ts-appendix-enums.md#barstate) | BarState.Off | 设置滚动条状态。 | | cachedCount | number | 1 | 设置预加载的ListItem的数量。 | | editMode | boolean | false | 声明当前List组件是否处于可编辑模式。 | | edgeEffect | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | EdgeEffect.Spring | 滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。 | | chainAnimation | boolean | false | 用于设置当前list是否启用链式联动动效,开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果:list内的list-item间隔一定距离,在基本的滑动交互行为下,主动对象驱动从动对象进行联动,驱动效果遵循弹簧物理动效。
- false:不启用链式联动。
- true:启用链式联动。 | | multiSelectable8+ | boolean | false | 是否开启鼠标框选。
- false:关闭框选。
- true:开启框选。 | -| restoreId8+ | number | - | 组件迁移标识符,标识后的组件在应用迁移时,组件状态会被迁移到被拉起方的同标识组件。
列表组件状态,包括起始位置显示的item序号。 | ## 事件 @@ -57,7 +56,7 @@ List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller} | onReachEnd(event: () => void) | 列表到底末尾位置时触发。 | | onScrollStop(event: () => void) | 列表滑动停止时触发。 | | onItemMove(event: (from: number, to: number) => boolean) | 列表元素发生移动时触发,返回值from、to分别为移动前索引值与移动后索引值。 | -| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any) \| void) | 开始拖拽列表元素时触发,返回值event见ItemDragInfo对象说明,itemIndex为被拖拽列表元素索引值。 | +| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any) \| void)) | 开始拖拽列表元素时触发,返回值event见ItemDragInfo对象说明,itemIndex为被拖拽列表元素索引值。 | | onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入列表元素范围内时触发,返回值event见ItemDragInfo对象说明。 | | onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void) | 拖拽在列表元素范围内移动时触发,返回值event见ItemDragInfo对象说明,itemIndex为拖拽起始位置,insertIndex为拖拽插入位置。 | | onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void) | 拖拽离开列表元素时触发,返回值event见ItemDragInfo对象说明,itemIndex为拖拽离开的列表元素索引值。 | 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 96be40af5f4645e3d342f29bfe8fbe579b9b98ac..6700b91a38f36c1fb9b35c9916159c369450bb15 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 @@ -40,10 +40,10 @@ Navigator(value?: {target: string, type?: NavigationType}) ## 属性 -| 名称 | 参数 | 默认值 | 描述 | -| ------ | ------- | --------- | ---------------------------------------- | -| 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 a579806a93ba9daa1154e7ec8e948373a2b9593a..a1e509d4738e0728db0f78553793a2210fa59e10 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 @@ -19,7 +19,7 @@ ## 接口 -Panel(value:{show:boolean}) +Panel(show:boolean) **参数:** @@ -29,14 +29,14 @@ Panel(value:{show:boolean}) ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------- | --------- | ------------------ | ---------------------------------- | -| type | PanelType | PanelType.Foldable | 设置可滑动面板的类型。 | -| mode | PanelMode | - | 设置可滑动面板的初始状态。 | -| dragBar | boolean | true | 设置是否存在dragbar,true表示存在,false表示不存在。 | -| fullHeight | Length | - | 指定PanelMode.Full状态下的高度。 | -| halfHeight | Length | - | 指定PanelMode.Half状态下的高度,默认为屏幕尺寸的一半。 | -| miniHeight | Length | - | 指定PanelMode.Mini状态下的高度。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| ---------- | -------------- | ------------------ | ------------------------------------------------------ | +| type | PanelType | PanelType.Foldable | 设置可滑动面板的类型。 | +| mode | PanelMode | - | 设置可滑动面板的初始状态。 | +| dragBar | boolean | true | 设置是否存在dragbar,true表示存在,false表示不存在。 | +| fullHeight | number\|string | - | 指定PanelMode.Full状态下的高度。 | +| halfHeight | number\|string | - | 指定PanelMode.Half状态下的高度,默认为屏幕尺寸的一半。 | +| miniHeight | number\|string | - | 指定PanelMode.Mini状态下的高度。 | ## PanelType枚举说明 @@ -56,9 +56,9 @@ Panel(value:{show:boolean}) ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (width: number, height: number, mode: PanelMode) => void) | 当可滑动面板发生状态变化时触发, 返回的height值为内容区高度值,当dragbar属性为true时,panel本身的高度值为dragbar高度加上内容区高度。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| onChange(event: (width: number, height: number, mode: PanelMode) => void) | 当可滑动面板发生状态变化时触发, 返回的height值为内容区高度值,当dragbar属性为true时,panel本身的高度值为dragbar高度加上内容区高度。 | ## 示例 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 a6c3be65ab1f90b10ab9551aef4ee93ce8691636..c6abd718b6ac60b948c47320bf58849d9a255476 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 @@ -16,7 +16,7 @@ ## 接口 -Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number | string\}\) +Refresh\(value: \{refreshing: boolean, offset?: number | string, friction?: number | string\}\) **参数:** 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 00ef7731919aaaaf254aa229fd66e02e38d0b32d..3fd944bbcf994bb5e1bbb54a7f35c50b1d683bb8 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 @@ -19,13 +19,13 @@ ## 接口 -Row(value?:{space?: Length}) +Row(value?:{space?: string | number }) **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | --------- | -| space | Length | 否 | 0 | 横向布局元素间距。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | -------------------------- | ---- | ------ | ------------------ | +| space | string \| number | 否 | 0 | 横向布局元素间距。 | ## 属性 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 bd357c6d1ab9c9ad761639ec5fe64f43a3a267a3..572b14e88d4a3f47919b0b60149f83415d356769 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 @@ -30,8 +30,8 @@ Scroll(scroller?: Scroller) | scrollable | ScrollDirection | ScrollDirection.Vertical | 设置滚动方法。 | | scrollBar | [BarState](ts-appendix-enums.md#barstate) | BarState.Off | 设置滚动条状态。 | | scrollBarColor | string \| number \| Color | - | 设置滚动条的颜色。 | -| scrollBarWidth | Length | - | 设置滚动条的宽度。 | -| edgeEffect | EdgeEffect | EdgeEffect.Spring | 设置滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。 | +| scrollBarWidth | string \| number | - | 设置滚动条的宽度。 | +| edgeEffect | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | EdgeEffect.Spring | 设置滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。 | ## ScrollDirection枚举说明 @@ -41,14 +41,6 @@ Scroll(scroller?: Scroller) | Vertical | 仅支持竖直方向滚动。 | | None | 不可滚动。 | -## EdgeEffect枚举说明 - -| 名称 | 描述 | -| ------ | ---------------------------------------- | -| Spring | 弹性物理动效,滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离,松手后回弹。 | -| Fade | 阴影效果,滑动到边缘后会有圆弧状的阴影。 | -| None | 滑动到边缘后无效果。 | - ## 事件 | 名称 | 功能描述 | @@ -78,31 +70,19 @@ 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 | number \| string | 是 | - | 水平滑动偏移。 | +| yOffset | number \| string | 是 | - | 竖直滑动偏移。 | +| animation | {
duration: number,
curve: [Curve](ts-animatorproperty.md) 
} | 否 | | 动画配置:
- duration: 滚动时长设置。
- curve: 滚动曲线设置。 | ### scrollEdge -scrollEdge(value: Edge): void +scrollEdge(value: [Edge](ts-appendix-enums.md#edge)): void 滚动到容器边缘。 -## Edge枚举说明 - -| 名称 | 描述 | -| ----- | ---- | -| Top | 竖直方向上边缘 | -| Center | 竖直方向居中位置 | -| Bottom | 竖直方向下边缘 | -| Baseline | 交叉轴方向文本基线位置 | -| Start | 水平方向起始位置 | -| Middle | 水平方向居中位置 | -| End | 水平方向末尾位置 | - ### scrollPage scrollPage(value: { next: boolean, direction?: Axis }): void @@ -118,17 +98,11 @@ scrollPage(value: { next: boolean, direction?: Axis }): void ### currentOffset -currentOffset(): Object +currentOffset() 返回当前的滚动偏移量。 -**返回值:** - -| 类型 | 描述 | -| ---------------------------------------- | ---------------------------------------- | -| {
xOffset: number,
yOffset: number
} | xOffset: 水平滑动偏移;
yOffset: 竖直滑动偏移。 | - ### scrollToIndex scrollToIndex(value: number): void 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 03e67a3e44dd8624f0990c4a5d7588eacac76e1d..8c55742c98609167f7ff9b4276486c86f739961c 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 @@ -59,9 +59,9 @@ SideBarContainer( type?: SideBarContainerType ) ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (value: boolen) => void) | 当侧边栏的状态在显示和隐藏之间切换时触发回调。

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

true表示显示,false表示隐藏。 | ## 示例 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 7d60f89f0b98bb4052c38be1e17f6fe0494d6ef1..d3c40fc07cca595697d3d7d1c484421351c96957 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 @@ -19,7 +19,7 @@ ## 接口 -Stack(value:{alignContent?: Alignment}) +Stack(value?: {alignContent?: Alignment}) **参数:** 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 a5f9adb455746165ab1cef419015d96d04fcced4..be9664b302a47b6b2b5e4870f03fc11a3fb949a6 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 @@ -1,11 +1,11 @@ # Swiper +滑动容器,提供切换子组件显示的能力。 > **说明:** > > 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -滑动容器,提供切换子组件显示的能力。 ## 权限列表 @@ -20,7 +20,7 @@ ## 接口 -Swiper(value:{controller?: SwiperController}) +Swiper(value?:{controller?: SwiperController}) **参数:** @@ -33,24 +33,23 @@ Swiper(value:{controller?: SwiperController}) 不支持[Menu控制](ts-universal-attributes-menu.md)。 -| 名称 | 参数类型 | 描述 | -| --------------------------- | ---------------------------------------- | ---------------------------------------- | -| index | number | 设置当前在容器中显示的子组件的索引值。
默认值:0 | -| autoPlay | boolean | 子组件是否自动播放,自动播放状态下,导航点不可操作。
默认值:false | -| interval | number | 使用自动播放时播放的时间间隔,单位为毫秒。
默认值:3000 | -| indicator | boolean | 是否启用导航点指示器。
默认值:true | -| loop | boolean | 是否开启循环。
设置为true时表示开启循环,在LazyForEach懒循环加载模式下,加载的组件数量建议大于5个。
默认值:true | -| duration | number | 子组件切换的动画时长,单位为毫秒。
默认值:400 | -| vertical | boolean | 是否为纵向滑动。
默认值:false | -| itemSpace | Length | 设置子组件与子组件之间间隙。
默认值:0 | -| displayMode | SwiperDisplayMode | 主轴方向上元素排列的模式,优先以displayCount设置的个数显示,displayCount未设置时本属性生效。
默认值:SwiperDisplayMode.Stretch | -| cachedCount8+ | number | 设置预加载子组件个数。
默认值:1 | -| disableSwipe8+ | boolean | 禁用组件滑动切换功能。
默认值:false | -| curve8+ | [Curve](ts-animatorproperty.md#Curve枚举说明) \| string | 设置Swiper的动画曲线,默认为淡入淡出曲线,常用曲线参考[Curve枚举说明](ts-animatorproperty.md#Curve枚举说明),也可以通过插值计算模块提供的接口创建自定义的Curves([插值曲线对象](ts-interpolation-calculation.md))。
默认值:Curve.Ease | -| indicatorStyle8+ | {
left?: Length,
top?: Length,
right?: Length,
bottom?: Length,
size?: Length,
color?: Color,
selectedColor?: Color
} | 设置indicator样式:
- left: 设置导航点距离Swiper组件左边的距离。
- top: 设置导航点距离Swiper组件顶部的距离。
- right: 设置导航点距离Swiper组件右边的距离。
- bottom: 设置导航点距离Swiper组件底部的距离。
- size: 设置导航点的直径。
- color: 设置导航点的颜色。
- selectedColor: 设置选中的导航点的颜色。 | -| displayCount8+ | number\|string | 设置元素显示个数。
默认值:1 | -| effectMode8+ | EdgeEffect | 滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。
默认值:EdgeEffect.Spring | - +| 名称 | 参数类型 | 默认值 | 描述 | +| --------------------------- | ---------------------------------------- | ---------- | ---------------------------------------- | +| index | number | 0 | 设置当前在容器中显示的子组件的索引值。 | +| autoPlay | boolean | false | 子组件是否自动播放,自动播放状态下,导航点不可操作。 | +| interval | number | 3000 | 使用自动播放时播放的时间间隔,单位为毫秒。 | +| indicator | boolean | true | 是否启用导航点指示器。 | +| loop | boolean | true | 是否开启循环。
设置为true时表示开启循环,在LazyForEach懒循环加载模式下,加载的组件数量建议大于5个。 | +| duration | number | 400 | 子组件切换的动画时长,单位为毫秒。 | +| vertical | boolean | false | 是否为纵向滑动。 | +| itemSpace | number \| string | 0 | 设置子组件与子组件之间间隙。 | +| displayMode | SwiperDisplayMode | SwiperDisplayMode.Stretch | 设置子组件显示模式。 | +| cachedCount8+ | number | 1 | 设置预加载子组件个数。 | +| disableSwipe8+ | boolean | false | 禁用组件滑动切换功能。 | +| displayCount8+ | number \| string | 1 | 设置一页中显示子组件的个数,设置为“auto”时等同于SwiperDisplayMode.AutoLinear的显示效果。 | +| effectMode8+ | EdgeEffect | EdgeEffect.Spring | 设置滑动到边缘时的显示效果。 | +| curve8+ | [Curve](ts-appendix-enums.md#curve) \| string | Curve.Ease | 设置Swiper的动画曲线,默认为淡入淡出曲线,常用曲线参考[Curve枚举说明](ts-appendix-enums.md#curve),也可以通过插值计算模块提供的接口创建自定义的Curves([插值曲线对象](ts-interpolation-calculation.md))。 | +| indicatorStyle8+ | {
left?: [Length](ts-types.md#length),
top?: [Length](ts-types.md#length),
right?: [Length](ts-types.md#length),
bottom?: [Length](ts-types.md#length),
size?: [Length](ts-types.md#length),
mask?: boolean,
color?: [ResourceColor](ts-types.md#resourcecolor8),
selectedColor?: [ResourceColor](ts-types.md#resourcecolor8)
} | - | 设置indicator样式:
- left: 设置导航点距离Swiper组件左边的距离。
- top: 设置导航点距离Swiper组件顶部的距离。
- right: 设置导航点距离Swiper组件右边的距离。
- bottom: 设置导航点距离Swiper组件底部的距离。
- size: 设置导航点的直径。
- mask: 设置是否显示导航点蒙层样式。
- color: 设置导航点的颜色。
- selectedColor: 设置选中的导航点的颜色。 | ## SwiperDisplayMode枚举说明 | 名称 | 描述 | 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 d9e8889701cea489448d2aee69c1a3d26d6d5b2d..13ceeecf8af610e54a3e0e67403df739059ebfd6 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 @@ -28,7 +28,7 @@ TabContent() | 名称 | 参数类型 | 默认值 | 描述 | | ------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| tabBar | string \| Resource \| {
icon?: string \| Resource,
text?: string \| Resource
}
\| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器,内部可以传入组件(API8版本以上适用)。
>  **说明:**
> 如果icon采用svg格式图源,则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源,icon大小则是svg本身内置的宽高属性值大小。 | +| tabBar | string \| [Resource](ts-types.md#resource) \| {
icon?: string \| [Resource](ts-types.md#resource),
text?: string \| [Resource](ts-types.md#resource)
}
\| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器,内部可以传入组件(API8版本以上适用)。
>  **说明:**
> 如果icon采用svg格式图源,则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源,icon大小则是svg本身内置的宽高属性值大小。 | > **说明:** > - TabContent组件不支持设置通用宽度属性,其宽度默认撑满Tabs父组件。 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 40cf0ea5d65f20b1bcfdb3a5c75aa4dd9beca029..e2753015919f7deed4a5b1a6e7dcee1b8684adfb 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 @@ -45,8 +45,8 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsContro | vertical | boolean | false | 设置为false是为横向Tabs,设置为true时为纵向Tabs。 | | scrollable | boolean | true | 设置为true时可以通过滑动页面进行页面切换,为false时不可滑动切换页面。 | | barMode | BarMode | BarMode.Fixed | TabBar布局模式,具体描述见BarMode枚举说明。 | -| barWidth | number \| string8+ | - | TabBar的宽度值。 | -| barHeight | number \| string8+ | - | TabBar的高度值。 | +| barWidth | [Length](ts-types.md#length) | - | TabBar的宽度值。 | +| barHeight | [Length](ts-types.md#length) | - | TabBar的高度值。 | | animationDuration | number | 200 | TabContent滑动动画时长。 | ## BarMode枚举说明 @@ -58,9 +58,9 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsContro ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | -------------- | -| onChange(callback: (index: number) => void) | Tab页签切换后触发的事件。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------- | +| onChange(event: (index: number) => void) | Tab页签切换后触发的事件。 | ## TabsController 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 1db4f4378afc8816facaae96a2606e5b1488a10d..c9883c3e88261d2626e10e20a8f6f44f066d664c 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 @@ -19,21 +19,21 @@ ## 接口 -Circle(options?: {width: Length, height: Length}) +Circle(value?: {width: string | number, height: string | number}) -**options参数:** +**参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | ------ | ---- | ---- | ---- | -| width | Length | 是 | - | 宽度。 | -| height | Length | 是 | - | 高度。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | -------------------------- | ---- | ------ | -------- | +| width | string \| number | 是 | - | 宽度。 | +| height | string \| number | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| ------ | ------ | ---- | ---- | --------- | -| width | Length | 0 | 否 | 圆所在矩形的宽度。 | -| height | Length | 0 | 否 | 圆所在矩形的高度。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| -------- | -------- | ------ | ---- | ------------------ | +| width | Length | 0 | 否 | 圆所在矩形的宽度。 | +| height | Length | 0 | 否 | 圆所在矩形的高度。 | ## 示例 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 36d8040c657a83c3c36a00bdb40ada585d9cbf8f..8bd5b9e6a42a870e5685abb223235498460b73d4 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 @@ -20,21 +20,21 @@ ## 接口 -ellipse(options?: {width: Length, height: Length}) +Ellipse(value?: {width: string | number, height: string | number}) -**options参数说明:** +**参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | ------ | ---- | ---- | ---- | -| width | Length | 是 | - | 宽度。 | -| height | Length | 是 | - | 高度。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | -------------------------- | ---- | ------ | -------- | +| width | string \| number | 是 | - | 宽度。 | +| height | string \| number | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| ------ | ------ | ---- | ---- | ---------- | -| width | Length | 0 | 否 | 椭圆所在矩形的宽度。 | -| height | Length | 0 | 否 | 椭圆所在矩形的高度。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| -------- | -------- | ------ | ---- | -------------------- | +| width | Length | 0 | 否 | 椭圆所在矩形的宽度。 | +| height | Length | 0 | 否 | 椭圆所在矩形的高度。 | ## 示例 @@ -46,7 +46,7 @@ ellipse(options?: {width: Length, height: Length}) struct EllipseExample { build() { Flex({ justifyContent: FlexAlign.SpaceAround }) { - // 在一个 150 * 70 的矩形框中绘制一个椭圆 + // 在一个 150 * 80 的矩形框中绘制一个椭圆 Ellipse({ width: 150, height: 80 }) // 在一个 150 * 70 的矩形框中绘制一个椭圆 Ellipse().width(150).height(80) 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 b5f80f172d4d1f459d31b8bec542396a9b506bb5..c7a9f94701a61607503a113b124ecc91c5730443 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 @@ -19,23 +19,23 @@ ## 接口 -Line(options?: {width: Length, height: Length}) +Line(value?: {width: string | number, height: string | number}) -**options参数说明:** +**参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | ------ | ---- | ---- | ---- | -| width | Length | 是 | - | 宽度。 | -| height | Length | 是 | - | 高度。 | +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| ------ | -------------------------- | ---- | ------ | -------- | +| width | string \| number | 是 | - | 宽度。 | +| height | string \| number | 是 | - | 高度。 | ## 属性 -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| ---------- | ------ | ----------- | ---- | ------------- | -| width | Length | 0 | 否 | 直线所在矩形的宽度。 | -| height | Length | 0 | 否 | 直线所在矩形的高度。 | -| startPoint | Point | [0, 0] | 是 | 直线起点坐标(相对坐标)。 | -| endPoint | Point | [0, 0] | 是 | 直线终点坐标(相对坐标)。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ---------- | ------------- | ----------- | ---- | ------------------------ | +| width | Length | 0 | 否 | 直线所在矩形的宽度。 | +| height | Length | 0 | 否 | 直线所在矩形的高度。 | +| startPoint | Arrayx: 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](ts-appendix-enums.md#linejoinstyle) | LineJoinStyle.Miter | 否 | 边框拐角绘制样式。 | -| strokeMiterLimit | number | 4 | 否 | 锐角绘制成斜角的极限值。 | -| strokeOpacity | number | 1 | 否 | 设置边框的不透明度。 | -| strokeWidth | Length | 1 | 否 | 设置边框的宽度。 | -| antiAlias | boolean | true | 否 | 是否开启抗锯齿。 | +| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | +| ---------------- | ------------------------------------------------------------ | ------------------- | ---- | ------------------------ | +| viewPort | {
x: string \| number,
y: string \| number,
width: string \| number,
height: string \| number
} | - | 是 | 形状的视口。 | +| fill | [ResourceColor](ts-types.md#resourcecolor8) | Black | 否 | 填充颜色。 | +| stroke | [ResourceColor](ts-types.md#resourcecolor8) | - | 否 | 边框颜色。 | +| strokeDashArray | Array<any> | [] | 否 | 设置边框的间隙。 | +| strokeDashOffset | string \| number | 0 | 否 | 边框绘制起点的偏移量。 | +| strokeLineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle) | LineCapStyle.Butt | 否 | 路径端点绘制样式。 | +| strokeLineJoin | [LineJoinStyle](ts-appendix-enums.md#linejoinstyle) | LineJoinStyle.Miter | 否 | 边框拐角绘制样式。 | +| strokeMiterLimit | number | 4 | 否 | 锐角绘制成斜角的极限值。 | +| strokeOpacity | number \| string \|[Resource](ts-types.md#resource) | 1 | 否 | 设置边框的不透明度。 | +| strokeWidth | string \| number | 1 | 否 | 设置边框的宽度。 | +| antiAlias | boolean | true | 否 | 是否开启抗锯齿。 | ## 示例 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 a4c6b77ee6ddcc91a3205de1bf6a9fff2647f466..4b218963f98faa2f4c54ca4f889345cfd64ded8d 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 @@ -27,7 +27,7 @@ ## 接口 -Video(value: VideoOptions) + Video(value: {src?: string | Resource, currentProgressRate?: number | string | PlaybackSpeed, previewUri?: string | PixelMap | Resource, controller?: VideoController}) - VideoOptions类型接口说明 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | @@ -61,16 +61,16 @@ Video(value: VideoOptions) ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onStart() => void | 播放时触发该事件。 | -| onPause() => void | 暂停时触发该事件。 | -| onFinish() => void | 播放结束时触发该事件。 | -| onError() => void | 播放失败时触发该事件。 | -| onPrepared(event?: { duration: number }) => void | 视频准备完成时触发该事件,通过duration可以获取视频时长,单位为秒(s)。 | -| onSeeking(event?: { time: number }) => void | 操作进度条过程时上报时间信息,单位为s。 | -| onSeeked(event?: { time: number }) => void | 操作进度条完成后,上报播放时间信息,单位为s。 | -| onUpdate(event?: { time: number }) => void | 播放进度变化时触发该事件,单位为s,更新时间间隔为250ms。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| onStart(event:() => void) | 播放时触发该事件。 | +| onPause(event:() => void) | 暂停时触发该事件。 | +| onFinish(event:() => void) | 播放结束时触发该事件。 | +| onError(event:() => void) | 播放失败时触发该事件。 | +| onPrepared(callBack:(event?: { duration: number }) => void) | 视频准备完成时触发该事件,通过duration可以获取视频时长,单位为s。
- duration: 视频的时长。 | +| onSeeking(callBack:(event?: { time: number }) => void) | 操作进度条过程时上报时间信息,单位为s。 | +| onSeeked(callBack:(event?: { time: number }) => void) | 操作进度条完成后,上报播放时间信息,单位为s。 | +| onUpdate(callBack:(event?: { time: number }) => void) | 播放进度变化时触发该事件,单位为s,更新时间间隔为250ms。 | ## VideoController 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 47141fdcea02499ed47fd6ad052d96a899beed2b..b4a8cfc32754fd588c6cdff63295191632578be0 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 @@ -14,7 +14,7 @@ ## ActionSheet.show -show(options: { paramObject1}) +show(value?: {  title?: string | Resource,message?: string | Resource,confirm?:{value: string | Resource,action:() => void},cancel?:()=>void,sheets?:Arrayvalue: string \| [Resource](ts-types.md#resource),
action: () => void
} | 否 | - | 确认按钮的文本内容和点击回调。
value:按钮文本内容。
action: 按钮选中时的回调。 | | cancel | () => void | 否 | - | 点击遮障层关闭dialog时的回调。 | | alignment | [DialogAlignment](ts-methods-custom-dialog-box.md) | 否 | DialogAlignment.Default | 弹窗在竖直方向上的对齐方式。 | - | offset | {
dx: Length,
dy: Length
} | 否 | {
dx: 0,
dy: 0
} | 弹窗相对alignment所在位置的偏移量。 | + | offset | {
dx: number \| string \| [Resource](ts-types.md#resource),
dy: number \| string \| [Resource](ts-types.md#resource)
} | 否 | {
dx: 0,
dy: 0
} | 弹窗相对alignment所在位置的偏移量。 | | sheets | Array