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 649e80e27b5cc1b229767dc628437644f52c35fe..9b7b588d64e4f56a1b3ed976a02f8791272ea8df 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 @@ -6,25 +6,21 @@ > > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 无 ## 接口 -CheckboxGroup( option?: {group?: string} ) +CheckboxGroup( options?: {group?: string} ) 创建多选框群组，可以控制群组内的Checkbox全选或者不全选，相同group的Checkbox和CheckboxGroup为同一群组。 **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ----- | -| group | string | 否 | - | 群组名称。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ---------- | +| group | string | 否 | 群组名称。 | ## 属性 @@ -50,7 +46,7 @@ CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化 | 名称 | 参数类型 | 描述 | | ------ | ------------------- | -------------- | | name | Array<string> | checkBox名称。 | -| status | selectStatus | 选中状态。 | +| status | SelectStatus | 选中状态。 | ## SelectStatus枚举说明 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 13ceeecf8af610e54a3e0e67403df739059ebfd6..2e49627ae5042a02a8ccbcc23710e38ece7b49e2 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 支持单个子组件。 @@ -28,7 +23,7 @@ TabContent() | 名称 | 参数类型 | 默认值 | 描述 | | ------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| 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本身内置的宽高属性值大小。 | +| 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 3d57780417811d75a9bee3d98e1754ad6d8e763c..a6c008d453e8f8bfacae8b91b5a66f344b2f0d9c 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 包含子组件[TabContent](ts-container-tabcontent.md)。 @@ -19,7 +14,7 @@ ## 接口说明 -Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsController](#tabscontroller)}) +Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: [TabsController](#tabscontroller)}) **参数：** 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 2ebe1ba22ebfdf25bfd8133f271111f47a8798d8..1a1d6e4b6767a22f03971a22f5d6e7d8ce7d9652 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,10 +1,11 @@ # Video -> **说明：** -> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - 视频播放组件。 +> **说明：** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 + ## 权限列表 使用网络视频时，需要在config或者module.json对应的"abilities"中添加网络使用权限ohos.permission.INTERNET。 @@ -27,7 +28,7 @@ ## 接口 - Video(value: {src?: string | Resource, currentProgressRate?: number | string | PlaybackSpeed, previewUri?: string | PixelMap | Resource, controller?: VideoController}) +Video(value: {src?: string | Resource, currentProgressRate?: number | string | PlaybackSpeed, previewUri?: string | PixelMap | Resource, controller?: VideoController}) **参数：** @@ -68,10 +69,10 @@ | 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。 | +| 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-universal-attributes-background.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-background.md index 869a5aa65625c4fd9b61e5dd27f1022c6ba8e6a9..123a5f48d8d9ba221c339b662e0b71861edd0d89 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,26 +1,21 @@ # 背景设置 -> **说明：** -> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - 设置组件的背景色。 - -## 权限列表 - -无 +> **说明：** +> +> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| backgroundColor | Color | - | 设置组件的背景色。 | -| backgroundImage | src: string,
repeat?: [ImageRepeat](ts-appendix-enums.md#imagerepeat) | - | src参数：图片地址，支持网络图片资源和本地图片资源地址(不支持svg类型的图片)。
repeat参数：设置背景图片的重复样式，默认不重复。 | -| backgroundImageSize | {
width?: Length,
height?: Length
} \| [ImageSize](ts-appendix-enums.md#imagesize) | Auto | 设置背景图像的高度和宽度。当输入为{width: Length, height: Length}对象时，如果只设置一个属性，则第二个属性保持图片原始宽高比进行调整。默认保持原图的比例不变。 | -| backgroundImagePosition | {
x?: Length,
y?: Length
} \| [Alignment](ts-appendix-enums.md#alignment) | {
x: 0,
y: 0
} | 设置背景图在组件中显示位置。 | +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| backgroundColor | [ResourceColor](ts-types.md#resourcecolor) | 设置组件的背景色。 | +| backgroundImage | src: [ResourceStr](ts-types.md#resourcestr),
repeat?: [ImageRepeat](ts-appendix-enums.md#imagerepeat) | src：图片地址，支持网络图片资源和本地图片资源地址(不支持svg类型的图片)。
repeat：设置背景图片的重复样式，默认不重复。 | +| backgroundImageSize | {
width?: [Length](ts-types.md#length),
height?: [Length](ts-types.md#length)
} \| [ImageSize](ts-appendix-enums.md#imagesize) | 设置背景图像的高度和宽度。当输入为{width: Length, height: Length}对象时，如果只设置一个属性，则第二个属性保持图片原始宽高比进行调整。默认保持原图的比例不变。
默认值：ImageSize.Auto | +| backgroundImagePosition | {
x?: [Length](ts-types.md#length),
y?: [Length](ts-types.md#length)
} \| [Alignment](ts-appendix-enums.md#alignment) | 设置背景图在组件中显示位置。
{
x: 0,
y: 0
} | ## 示例 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 3a50b531df13f3ec7d1ea5582da3cc6078c2818c..9a1b22fd75740e1ee7cb8a44dc0eadb323d9d46c 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,27 +1,22 @@ # 边框设置 -> **说明：** -> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - 设置组件边框样式。 - -## 权限列表 - -无 +> **说明：** +> +> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| border | {
width?: Length,
color?: Color,
radius?: Length,
style?: [BorderStyle](ts-appendix-enums.md#borderstyle)
} | - | 统一边框样式设置接口。 | -| borderStyle | [BorderStyle](ts-appendix-enums.md#borderstyle) |  BorderStyle.Solid | 设置元素的边框样式。 | -| borderWidth | Length | 0 | 设置元素的边框宽度。 | -| borderColor | Color | - | 设置元素的边框颜色。 | -| borderRadius | Length | 0 | 设置元素的边框圆角半径。 | +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| border | {
width?: [Length](ts-types.md#length),
color?: [ResourceColor](ts-types.md#resourcecolor),
radius?: [Length](ts-types.md#length),
style?: [BorderStyle](ts-appendix-enums.md#borderstyle)
} | 统一边框样式设置接口。 | +| borderStyle | [BorderStyle](ts-appendix-enums.md#borderstyle) | 设置元素的边框样式。
默认值：BorderStyle.Solid | +| borderWidth | [Length](ts-types.md#length) | 设置元素的边框宽度。 | +| borderColor | [ResourceColor](ts-types.md#resourcecolor) | 设置元素的边框颜色。 | +| borderRadius | [Length](ts-types.md#length) | 设置元素的边框圆角半径。 | 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 447edde654f97fd91f34e5708e9ed9bbbc4b3e9a..3c65b9b1f6591b2b12571864b3ae51444c8d091c 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 @@ -5,24 +5,19 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------------------------- | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| bindMenu | Array8+ | - | 给组件绑定菜单，点击后弹出菜单。弹出菜单项支持文本和自定义两种功能。 | -| bindContextMenu8+ | content: [CustomBuilder](ts-types.md#custombuilder8)
responseType: [ResponseType](ts-appendix-enums.md#responsetype8) | - | 给组件绑定菜单，触发方式为长按或者右键点击，弹出菜单项需要自定义。 | +| 名称 | 参数类型 | 描述 | +| ---------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| bindMenu | Array8+ | content: [CustomBuilder](ts-types.md#custombuilder8)
responseType: [ResponseType](ts-appendix-enums.md#responsetype8) | 给组件绑定菜单，触发方式为长按或者右键点击，弹出菜单项需要自定义。 | ## MenuItem -| 名称 | 类型 | 描述 | -| ------ | ----------------------- | ----------- | -| value | string | 菜单项文本。 | +| 名称 | 类型 | 描述 | +| ------ | ----------------------- | ---------------------- | +| value | string | 菜单项文本。 | | action | () => void | 点击菜单项的事件回调。 | 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 44e5d0785420e0b501daee22dcb22b20ad1a548f..04cf60d25ddc9558e4c1e944b455532fe762d49c 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 @@ -7,17 +7,12 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ------- | ------ | ---- | ---------------------------------- | -| opacity | number | 1 | 元素的不透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。 | +| 名称 | 参数类型 | 描述 | +| ------- | ---------------------------------------------------- | ------------------------------------------------------------ | +| opacity | number \| [Resource](ts-types.md#resource) | 元素的不透明度，取值范围为0到1，1表示为不透明，0表示为完全透明。
默认值：1 | ## 示例 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 44c2a17684ecdd23ab19b72b29f4699d354b8f1a..f3ddeacc02f67ef3bb7ab370f5493acd4c3fac5b 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,30 +1,27 @@ # 多态样式 -> **说明：** -> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - 设置组件不同状态下的样式。 - -## 权限列表 - -无 +> **说明：** +> +> 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------- | ----------- | ---- | ------------ | -| stateStyles | StateStyles | - | 设置组件不同状态的样式。 | +| 名称 | 参数类型 | 描述 | +| ----------- | ----------- | ------------------------ | +| stateStyles | StateStyles | 设置组件不同状态的样式。 | ## StateStyles接口说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| -------- | ----------- | ---- | ---- | ---------- | -| normal | ()=>void | 否 | - | 组件无状态时的样式。 | -| pressed | ()=>void | 否 | - | 组件按下状态的样式。 | -| disabled | ()=>void | 否 | - | 组件禁用状态的样式。 | +| 名称 | 类型 | 必填 | 描述 | +| -------- | ---- | ---- | -------------------- | +| normal | any | 否 | 组件无状态时的样式。 | +| pressed | any | 否 | 组件按下状态的样式。 | +| disabled | any | 否 | 组件禁用状态的样式。 | +| focused | any | 否 | 组件获焦状态的样式。 | +| clicked | any | 否 | 组件点击状态的样式。 | ## 示例 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 4d81ce020ef1e3f91d4ea69fcdc5907966711673..ae882e08ac4b44096bf99dfcb21a15446866ac7a 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 @@ -5,39 +5,34 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - -## 属性 - - -| 名称 | 参数类型 | 默认值 | 描述 | -| --------- | ---------------------------------------- | ---- | ---------------------------------------- | -| 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](ts-appendix-enums.md#placement8) | 否 | Placement.Bottom | 气泡组件优先显示的位置，当前位置显示不下时，会自动调整位置。 | -| maskColor | [Color](ts-appendix-enums.md#color) | 否 | - | 提示气泡遮障层的颜色。 | -| popupColor | [Color](ts-appendix-enums.md#color) | 否 | - | 提示气泡的颜色。 | -| enableArrow | boolean | 否 | true | 是否显示箭头，只有上、下方向的气泡会显示箭头。 | -| autoCancel | boolean | 否 | true | 页面有操作时，是否自动关闭气泡 | -| onStateChange | (isVisible: boolean) => void | 否 | - | 弹窗状态变化事件回调，参数为弹窗当前的显示状态。 | +## 接口 + + +| 名称 | 参数类型 | 描述 | +| --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| bindPopup | show: boolean,
popup: PopupOptions\| CustomPopupOptions8+ | 给组件绑定Popup，点击弹出弹窗。
show: 创建页面弹窗提示是否默认显示，默认值为false。
popup: 配置当前弹窗提示的参数。 | + +## PopupOptions类型说明 + +| 名称 | 类型 | 必填 | 描述 | +| --------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| message | string | 是 | 弹窗信息内容。 | +| placementOnTop | boolean | 否 | 是否在组件上方显示，默认值为false。 | +| primaryButton | {
value: string,
action: () => void
} | 否 | 第一个按钮。
value: 弹窗里主按钮的文本。
action: 点击主按钮的回调函数。 | +| secondaryButton | {
value: string,
action: () => void
} | 否 | 第二个按钮。
value: 弹窗里辅助按钮的文本。
action: 点击辅助按钮的回调函数。 | +| onStateChange | (event:{isVisible: boolean }) => void | 否 | 弹窗状态变化事件回调，参数isVisible为弹窗当前的显示状态。 | + +## CustomPopupOptions8+类型说明 + +| 名称 | 类型 | 必填 | 描述 | +| ------------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| builder | [CustomBuilder](ts-types.md#custombuilder8) | 是 | 提示气泡内容的构造器。 | +| placement | [Placement](ts-appendix-enums.md#placement8) | 否 | 气泡组件优先显示的位置，当前位置显示不下时，会自动调整位置。
默认值：Placement.Bottom | +| maskColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | 提示气泡遮障层的颜色。 | +| popupColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | 提示气泡的颜色。 | +| enableArrow | boolean | 否 | 是否显示箭头，只有上、下方向的气泡会显示箭头。
默认值：true | +| autoCancel | boolean | 否 | 页面有操作时，是否自动关闭气泡
默认值：true | +| onStateChange | (event:{isVisible: boolean }) => void | 否 | 弹窗状态变化事件回调，参数为弹窗当前的显示状态。 | ## 示例 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 474f34717426e12263e2d5cbaeb61354744465ec..ff5c7cccc7a293ad4ae0c0856e4f63501a9c16ab 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 @@ -5,23 +5,18 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数说明 | 默认值 | 描述 | -| -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| 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布局中生效。 | +| 名称 | 参数说明 | 描述 | +| -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| width | [Length](ts-types.md#length) | 设置组件自身的宽度，缺省时使用元素自身内容需要的宽度。 | +| height | [Length](ts-types.md#length) | 设置组件自身的高度，缺省时使用元素自身内容需要的高度。 | +| size | {
width?: [Length](ts-types.md#length),
height?: [Length](ts-types.md#length)
} | 设置高宽尺寸。 | +| padding | [Padding](ts-types.md#padding) \| [Length](ts-types.md#length) | 设置内边距属性。
参数为Length类型时，四个方向内边距同时生效。
默认值：0 | +| margin | [Margin](ts-types.md#margin) \| [Length](ts-types.md#length) | 设置外边距属性。
参数为Length类型时，四个方向外边距同时生效。
默认值：0 | +| constraintSize | {
minWidth?: [Length](ts-types.md#length),
maxWidth?: [Length](ts-types.md#length),
minHeight?: [Length](ts-types.md#length),
maxHeight?: [Length](ts-types.md#length)
} | 设置约束尺寸，组件布局时，进行尺寸范围限制。
默认值：
{
minWidth: 0,
maxWidth: Infinity,
minHeight: 0,
maxHeight: Infinity
} | +| layoutWeight | number \| string | 容器尺寸确定时，元素与兄弟节点主轴布局尺寸按照权重进行分配，忽略本身尺寸设置，表示自适应占满剩余空间。
默认值：0
**说明：**
仅在Row/Column/Flex布局中生效。 | ## 示例 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 2043171acbda94af034e0b4bac847e9a902ea05a..700349d0a0cefe05271e1c2995ecf99dad61b2a0 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,37 +1,35 @@ # 触摸热区设置 +适用于支持通用点击事件、通用触摸事件、通用手势处理的组件。 + > **说明：** > > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -适用于支持通用点击事件、通用触摸事件、通用手势处理的组件。 - - -## 权限列表 - -无 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| 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%'表示热区高度设置为该组件本身的高度。 | +| 名称 | 参数类型 | 描述 | +| -------------- | --------------------------------------------- | ------------------------------------------------------------ | +| responseRegion | Array<Rectangle> \| Rectangle | 设置一个或多个触摸热区，包括位置和大小。
默认值：
{
x：0,
y：0,
width：'100%',
height：'100%'
} | ### Rectangle对象说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| ------ | ------ | ---- | ---- | ------------------ | -| x | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。 | -| y | Length | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。 | -| width | Length | 否 | 100% | 触摸热区范围的宽度。 | -| height | Length | 否 | 100% | 触摸热区范围的高度。 | +| 名称 | 类型 | 必填 | 默认值 | 描述 | +| ------ | ---------------------------- | ---- | ------ | --------------------------------------------------- | +| x | [Length](ts-types.md#length) | 否 | 0vp | 触摸点相对于组件本身左边沿的X坐标。
默认值：0vp | +| y | [Length](ts-types.md#length) | 否 | 0vp | 触摸点相对于组件本身左边沿的Y坐标。
默认值：0vp | +| width | [Length](ts-types.md#length) | 否 | 100% | 触摸热区范围的宽度。
默认值：100% | +| height | [Length](ts-types.md#length) | 否 | 100% | 触摸热区范围的高度。
默认值：100% | > **说明：** > - > 当x和y都设置为正值时，表示组件的触摸热区的范围整体往组件本身右下角偏移，偏移的大小可通过数值来设置。 + > x和y可以设置正负值百分比。当x设置为'100%'时表示热区往右偏移组件本身宽度大小，当x设置为'-100%'时表示热区往左偏移组件本身宽度大小。当y设置为'100%'时表示热区往下偏移组件本身高度大小，当y设置为'-100%'时表示热区往上偏移组件本身高度大小。 + > + > width和height只能设置正值百分比。width：'100%'表示热区宽度设置为该组件本身的宽度。比如组件本身宽度是100vp，那么'100%'表示热区宽度也为100vp。height：'100%'表示热区高度设置为该组件本身的高度。 + > + > 百分比是相对于组件本身来度量的。 ## 示例 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 8bfa7a8329c9ef79129b3c60b80df0e2826d7f3a..6f8902fb7626655e717ca8742fc90f2a564eeacb 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 @@ -5,26 +5,22 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 事件 -| 名称 | 支持冒泡 | 功能描述 | -| ---------------------------------------- | ---- | --------------------------------- | -| onClick(callback: (event?: ClickEvent) => void) | 否 | 点击动作触发该方法调用，event参数见ClickEvent介绍。 | +| 名称 | 支持冒泡 | 功能描述 | +| ------------------------------------------------------------ | -------- | --------------------------------------------------- | +| onClick(event: (event?: ClickEvent) => void) | 否 | 点击动作触发该方法调用，event参数见ClickEvent介绍。 | ## ClickEvent对象说明 -| 属性名称 | 类型 | 描述 | -| ------------------- | -------------------------------- | ------------------- | -| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 | -| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 | -| x | number | 点击点相对于被点击元素左边沿的X坐标。 | -| y | number | 点击点相对于被点击元素上边沿的Y坐标。 | -| target8+ | [EventTarget](#eventtarget8对象说明) | 被点击元素对象。 | -| timestamp | number | 事件时间戳。 | +| 属性名称 | 类型 | 描述 | +| ---------------------- | ------------------------------------ | ------------------------------------- | +| screenX | number | 点击点相对于设备屏幕左边沿的X坐标。 | +| screenY | number | 点击点相对于设备屏幕上边沿的Y坐标。 | +| x | number | 点击点相对于被点击元素左边沿的X坐标。 | +| y | number | 点击点相对于被点击元素上边沿的Y坐标。 | +| target8+ | [EventTarget](#eventtarget8对象说明) | 被点击元素对象。 | +| timestamp8+ | number | 事件时间戳。 | +| source8+ | [SourceType](ts-gesture-settings.md) | 事件输入设备。 | ## EventTarget8+对象说明 | 名称 | 参数类型 | 描述 | 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 1797ffa5e4771aff380ab24fa8497d1eb6ca8bdc..508837cd92455f5408800d076e530833d2a25358 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 @@ -5,16 +5,11 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 事件 -| 名称 | 是否冒泡 | 功能描述 | -| ---------------------------------------- | ---- | ---------------------------------------- | -| onTouch(callback: (event?: TouchEvent) => void) | 是 | 触摸动作触发该方法调用，event参数见[TouchEvent](#touchevent对象说明)介绍。 | +| 名称 | 是否冒泡 | 功能描述 | +| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| onTouch(event: (event?: TouchEvent) => void) | 是 | 触摸动作触发该方法调用，event参数见[TouchEvent](#touchevent对象说明)介绍。 | ## TouchEvent对象说明 @@ -23,7 +18,7 @@ | 属性名称 | 类型 | 描述 | | ------------------- | ------------------------------------------------------------ | ---------------------------------- | -| type | [TouchType](ts-appendix-enums.md#touchtype) | 触摸事件的类型。 | +| type | [TouchType](ts-appendix-enums.md#touchtype) | 触摸事件的类型。 | | touches | Array<[TouchObject](#touchobject对象说明)> | 全部手指信息。 | | changedTouches | Array<[TouchObject](#touchobject对象说明)> | 当前发生变化的手指信息。 | | timestamp | number | 距离开机时间的时间戳，单位为毫秒。 | 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 1735b4af8a9184d39c1166ad8f0744de31d282ad..e0a3a5d3a57e2f0897cb6c8216ca7fabfbb4b2e9 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 @@ -5,17 +5,12 @@ > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 事件 -| 名称 | 支持冒泡 | 描述 | -| ---------------------------------------- | ---- | ---------------------------------------- | -| onHover(callback: (isHover: boolean) => void) | 否 | 鼠标进入或退出组件时触发该回调。
isHover：表示鼠标是否悬浮在组件上，鼠标进入时为true, 退出时为false。 | -| onMouse(callback: (event?: MouseEvent) => void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时，触发该回调，event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 | +| 名称 | 支持冒泡 | 描述 | +| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| onHover(event: (isHover: boolean) => void) | 否 | 鼠标进入或退出组件时触发该回调。
isHover：表示鼠标是否悬浮在组件上，鼠标进入时为true, 退出时为false。 | +| onMouse(event: (event?: MouseEvent) => void) | 是 | 当前组件被鼠标按键点击时或者鼠标在组件上移动时，触发该回调，event参数包含触发事件时的时间戳、鼠标按键、动作、点击触点在整个屏幕上的坐标和点击触点相对于当前组件的坐标。 | ## MouseEvent对象说明