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 f19b51abb7c46a99556e712154823b4584553b2e..d6a2824e2ad9a4acb1a62a41a763e8990bb46eef 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 @@ -25,9 +25,9 @@ LoadingProgress() ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----- | ----- | ---- | ----------- | -| color | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置加载进度条前景色。 | +| 名称 | 参数类型 | 描述 | +| ----- | ------------------------------------------- | ---------------------- | +| color | [ResourceColor](ts-types.md#resourcecolor8) | 设置加载进度条前景色。 | ## 示例 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 72f4fa886e2e872d1486b6978b057603494b7778..9cb2c0c6c2c1bd960946495cc7ce73f6f86fabc4 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 @@ -12,9 +12,9 @@ LongPressGesture(value?: { fingers?: number, repeat?: boolean, duration?: number | 参数名称 | 参数类型 | 必填 | 参数描述 | | -------- | -------- | ---- | ------------------------------------------------------------ | -| fingers | number | 否 | 触发长按的最少手指数，最小为1指， 最大取值为10指。
默认值：1 | +| fingers | number | 否 | 触发长按的最少手指数，最小取值为1指， 最大取值为10指。
默认值：1 | | repeat | boolean | 否 | 是否连续触发事件回调。
默认值：false | -| duration | number | 否 | 最小触发长按的时间，单位为毫秒（ms）。
默认值：500 | +| duration | number | 否 | 触发长按的最小时间，单位为毫秒（ms）。
默认值：500 | ## 事件 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 2e7859d8a14543d61619a66bc92f832647c8b520..751ac18174e53a00b24f84192503ae637c6d9c08 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 @@ -6,10 +6,6 @@ > > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 @@ -22,10 +18,10 @@ AlphabetIndexer(value: {arrayValue: Array<string>, selected: number}) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ---------- | ------------------- | ---- | ---- | ---------- | -| arrayValue | Array<string> | 是 | - | 字母索引字符串数组。 | -| selected | number | 是 | - | 初始选中项索引值。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ---------- | ------------------- | ---- | ---------- | +| arrayValue | Array<string> | 是 | 字母索引字符串数组。 | +| selected | number | 是 | 初始选中项索引值。 | ## 属性 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 c282a22d3746b08dc37ef2db7ba104bf46488a69..59a490b5e848775fbc57442e42226c94a971ec98 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 包含[GridItem](ts-container-griditem.md)子组件。 @@ -23,30 +18,30 @@ Grid(scroller?: Scroller) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| --------- | ---------------------------------------- | ---- | --------------------------- | ----------------------- | -| scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| --------- | ---------------------------------------- | ---- | ----------------------- | +| scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------------------------------------- | ------- | ----- | ---------------------------------------- | -| columnsTemplate | string | '1fr' | 用于设置当前网格布局列的数量，不设置时默认1列 示例, '1fr 1fr 2fr' 分三列，将父组件允许的宽分为4等份，第一列占1份，第二列占一份，第三列占2份。 | -| rowsTemplate | string | '1fr' | 用于设置当前网格布局行的数量，不设置时默认1行 示例, '1fr 1fr 2fr'分三行，将父组件允许的高分为4等份，第一行占1份，第二行占一份，第三行占2份。 | -| columnsGap | Length | 0 | 用于设置列与列的间距。 | -| rowsGap | Length | 0 | 用于设置行与行的间距。 | -| scrollBar | [BarState](ts-appendix-enums.md#barstate) | BarState.Off | 设置滚动条状态。 | -| 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 | 设置布局的主轴方向。 | -| maxCount8+ | number | 1 | 当layoutDirection是Row/RowReverse时，表示可显示的最大行数
当layoutDirection是Column/ColumnReverse时，表示可显示的最大列数。 | -| minCount8+ | number | 1 | 当layoutDirection是Row/RowReverse时，表示可显示的最小行数。
当layoutDirection是Column/ColumnReverse时，表示可显示的最小列数。 | -| cellLength8+ | number | 0 | 当layoutDirection是Row/RowReverse时，表示一行的高度。
当layoutDirection是Column/ColumnReverse时，表示一列的宽度。 | -| multiSelectable8+ | boolean | false | 是否开启鼠标框选。
- false：关闭框选。
- true：开启框选。 | -| supportAnimation8+ | boolean | false | 是否支持动画。 | +| 名称 | 参数类型 | 描述 | +| ---------------------------------------- | ------- | ---------------------------------------- | +| columnsTemplate | string | 设置当前网格布局列的数量，不设置时默认1列。
例如, '1fr 1fr 2fr' 是将父组件分3列，将父组件允许的宽分为4等份，第一列占1份，第二列占1份，第三列占2份。
默认值：'1fr' | +| rowsTemplate | string | 设置当前网格布局行的数量，不设置时默认1行。
例如, '1fr 1fr 2fr'是将父组件分三行，将父组件允许的高分为4等份，第一行占1份，第二行占一份，第三行占2份。
默认值：'1fr' | +| columnsGap | Length | 设置列与列的间距。
默认值：0 | +| rowsGap | Length | 设置行与行的间距。
默认值：0 | +| scrollBar | [BarState](ts-appendix-enums.md#barstate) | 设置滚动条状态。
默认值：BarState.Off | +| scrollBarColor | string \| number \| [Color](ts-appendix-enums.md#color) | 设置滚动条的颜色。 | +| scrollBarWidth | string \| number | 设置滚动条的宽度。 | +| cachedCount | number | 设置预加载的GridItem的数量。具体使用可参考[减少应用白块说明](../../ui/ts-performance-improvement-recommendation.md#减少应用滑动白块)。
默认值：1 | +| editMode 8+ | boolean | 是否进入编辑模式，进入编辑模式可以拖拽Grid组件内部[GridItem](ts-container-griditem.md)。
默认值：false | +| layoutDirection8+ | GridDirection | 设置布局的主轴方向。
默认值：GridDirection.Row | +| maxCount8+ | number | 当layoutDirection是Row/RowReverse时，表示可显示的最大行数
当layoutDirection是Column/ColumnReverse时，表示可显示的最大列数。
默认值：1 | +| minCount8+ | number | 当layoutDirection是Row/RowReverse时，表示可显示的最小行数。
当layoutDirection是Column/ColumnReverse时，表示可显示的最小列数。
默认值：1 | +| cellLength8+ | number | 当layoutDirection是Row/RowReverse时，表示一行的高度。
当layoutDirection是Column/ColumnReverse时，表示一列的宽度。
默认值：0 | +| multiSelectable8+ | boolean | 是否开启鼠标框选。
- false：关闭框选。
- true：开启框选。
默认值：false | +| supportAnimation8+ | boolean | 是否支持动画。
默认值：false | ## GridDirection枚举说明8+ @@ -59,14 +54,14 @@ Grid(scroller?: Scroller) ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ----------------------- | -| onScrollIndex(event: (first: number) => void) | 当前网格显示的起始位置item发生变化时触发，返回值为当前显示的网格起始位置的索引值。 | -| 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为拖拽离开的网格元素索引值。 | -| onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void) | 绑定该事件的网格元素可作为拖拽释放目标，当在网格元素内停止拖拽时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽起始位置，insertIndex为拖拽插入位置，isSuccess为是否成功释放。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| onScrollIndex(event: (first: number) => void) | 当前网格显示的起始位置item发生变化时触发。
- first: 当前显示的网格起始位置的索引值。 | +| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any) \| void) | 开始拖拽网格元素时触发。
- event: 见[ItemDragInfo对象说明](#itemdraginfo对象说明)。
- itemIndex: 被拖拽网格元素索引值。 | +| onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入网格元素范围内时触发。
- event: 见[ItemDragInfo对象说明](#itemdraginfo对象说明)。 | +| onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void) | 拖拽在网格元素范围内移动时触发。
- event: 见[ItemDragInfo对象说明](#itemdraginfo对象说明)。
- itemIndex: 拖拽起始位置。
- insertIndex: 拖拽插入位置。 | +| onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void) | 拖拽离开网格元素时触发。
- event: 见[ItemDragInfo对象说明](#itemdraginfo对象说明)。
- itemIndex: 拖拽离开的网格元素索引值。 | +| onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void) | 绑定该事件的网格元素可作为拖拽释放目标，当在网格元素内停止拖拽时触发。
- event: 见[ItemDragInfo对象说明](#itemdraginfo对象说明)。
- itemIndex: 拖拽起始位置。
- insertIndex: 拖拽插入位置。
- isSuccess: 是否成功释放。 | ## ItemDragInfo对象说明 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 00ff348764438a53dd2057d43542017f86300d92..a6cd296418a398105ed4aa1da12c66395aa5fe82 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,15 +1,10 @@ # GridContainer -> **说明：** -> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - 纵向排布栅格布局容器，仅在栅格布局场景中使用。 - -## 权限列表 - -无 +> **说明：** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 ## 子组件 @@ -19,16 +14,16 @@ ## 接口 -GridContainer(options?: { columns?: number | auto, sizeType?: SizeType, gutter?: string|number, margin?: string|number}) +GridContainer(value?: { 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-griditem.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md index 40551bff574f61d0d50ae29d7a092c7677c197a9..d2c0641363334430ee18bfb85e402c897b67194f 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含子组件。 @@ -24,21 +19,21 @@ GridItem() ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------------- | ------- | ----- | ---------------------------------------- | -| rowStart | number | - | 用于指定当前元素起始行号。 | -| rowEnd | number | - | 用于指定当前元素终点行号。 | -| columnStart | number | - | 用于指定当前元素起始列号。 | -| columnEnd | number | - | 用于指定当前元素终点列号。 | -| forceRebuild | boolean | false | 用于设置在触发组件build时是否重新创建此节点。 | -| selectable8+ | boolean | true | 当前GridItem元素是否可以被鼠标框选。
>  **说明：**
> 外层Grid容器的鼠标框选开启时，GridItem的框选才生效。 | +| 名称 | 参数类型 | 描述 | +| ----------------------- | -------- | ------------------------------------------------------------ | +| rowStart | number | 指定当前元素起始行号。 | +| rowEnd | number | 指定当前元素终点行号。 | +| columnStart | number | 指定当前元素起始列号。 | +| columnEnd | number | 指定当前元素终点列号。 | +| forceRebuild | boolean | 设置在触发组件build时是否重新创建此节点。
默认值：false | +| selectable8+ | boolean | 当前GridItem元素是否可以被鼠标框选。
默认值：true
>  **说明：**
> 外层Grid容器的鼠标框选开启时，GridItem的框选才生效。 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onSelect(callback: (isSelected: boolean) => void)8+ | GridItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| onSelect(event: (isSelected: boolean) => void)8+ | GridItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中，返回true；移出鼠标框选范围即未被选中，返回false。。 | ## 示例 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 94a2f6d117a45bdcd7ba1eb13a1bdd5709435c45..a0738f142dcbdfc4cbc7f91f672065e80211ef82 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 @@ -9,11 +9,6 @@ > - 该组件回弹的前提是要有滚动。内容小于一屏时，没有回弹效果。 -## 权限列表 - -无 - - ## 子组件 包含[ListItem](ts-container-listitem.md)子组件。 @@ -25,24 +20,24 @@ List(value?:{space?: number | string, initialIndex?: number, scroller?: Scroller **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------------ | ------ | ---- | ---- | ---------------------------------------- | -| space | number \| string | 否 | 0 | 列表项间距。 | -| initialIndex | number | 否 | 0 | 设置当前List初次加载时视口起始位置显示的item，即显示第一个item，如设置的序号超过了最后一个item的序号，则设置不生效。 | -| scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------------ | ------ | ---- | ---------------------------------------- | +| space | number \| string | 否 | 列表项间距。
默认值：0 | +| initialIndex | number | 否 | 设置当前List初次加载时视口起始位置显示的item的索引值。如果设置的值超过了当前List最后一个item的索引值，则设置不生效。
默认值：0 | +| scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------------------------- | ---------------------------------------- | ----------------- | ---------------------------------------- | -| listDirection | [Axis](ts-appendix-enums.md#axis) | Vertical | 设置List组件排列方向参照Axis枚举说明。 | -| 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：开启框选。 | +| 名称 | 参数类型 | 描述 | +| ---------------------------- | ---------------------------------------- | ---------------------------------------- | +| listDirection | [Axis](ts-appendix-enums.md#axis) | 设置List组件排列方向参照Axis枚举说明。
默认值：Vertical | +| 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 | 设置预加载的ListItem的数量。具体使用可参考[减少应用白块说明](../../ui/ts-performance-improvement-recommendation.md#减少应用滑动白块)。
默认值：1 | +| editMode | boolean | 声明当前List组件是否处于可编辑模式。
默认值：false | +| edgeEffect | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | 滑动效果，目前支持的滑动效果参见EdgeEffect的枚举说明。
默认值：EdgeEffect.Spring | +| chainAnimation | boolean | 用于设置当前list是否启用链式联动动效，开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果：list内的list-item间隔一定距离，在基本的滑动交互行为下，主动对象驱动从动对象进行联动，驱动效果遵循弹簧物理动效。
- false：不启用链式联动。
- true：启用链式联动。
默认值：false | +| multiSelectable8+ | boolean | 是否开启鼠标框选。
>默认值：false
- false：关闭框选。
- true：开启框选。 | ## 事件 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 4eda9fbb21d65642fb56c345ef0f8f44bf6cc371..aa151c34f5771f0875065e5bf24a3b55bac8d522 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含单个子组件。 @@ -19,16 +14,16 @@ ## 接口 -ListItem() +ListItem(value?: string) ## 属性 | 名称 | 参数类型 | 默认值 | 描述 | | ----------------------- | ------- | ----------- | ---------------------------------------- | -| sticky | Sticky | Sticky.None | 设置ListItem吸顶效果，参见Sticky枚举描述。 | -| editable | boolean \| EditMode | false | 当前ListItem元素是否可编辑，进入编辑模式后可删除或移动。 | -| selectable8+ | boolean | true | 当前ListItem元素是否可以被鼠标框选。
>  **说明：**
> 外层List容器的鼠标框选开启时，ListItem的框选才生效。 | +| sticky | Sticky | Sticky.None | 设置ListItem吸顶效果，参见Sticky枚举描述。
默认值：Sticky.None | +| editable | boolean \| EditMode | false | 当前ListItem元素是否可编辑，进入编辑模式后可删除或移动。
默认值：false | +| selectable8+ | boolean | true | 当前ListItem元素是否可以被鼠标框选。
默认值：true
**说明：**
外层List容器的鼠标框选开启时，ListItem的框选才生效。 | ## Sticky枚举说明 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 6700b91a38f36c1fb9b35c9916159c369450bb15..2ef3440f88da8494b85d8700cbebe6db816bf6a3 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含子组件。 @@ -25,10 +20,10 @@ Navigator(value?: {target: string, type?: NavigationType}) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------ | -------------- | ---- | ------------------- | ------------ | -| target | string | 是 | - | 指定跳转目标页面的路径。 | -| type | NavigationType | 否 | NavigationType.Push | 指定路由方式。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------------- | ---- | ---------------------------------------------- | +| target | string | 是 | 指定跳转目标页面的路径。 | +| type | NavigationType | 否 | 指定路由方式。
默认值：NavigationType.Push | ## NavigationType枚举说明 @@ -40,10 +35,10 @@ Navigator(value?: {target: string, type?: NavigationType}) ## 属性 -| 名称 | 参数 | 默认值 | 描述 | -| ------ | ------- | --------- | ------------------------------------------------------------ | -| active | boolean | - | 当前路由组件是否处于激活状态，处于激活状态时，会生效相应的路由操作。 | -| params | object | undefined | 跳转时要同时传递到目标页面的数据，可在目标页面使用router.getParams()获得。 | +| 名称 | 参数 | 描述 | +| ------ | ------- | ------------------------------------------------------------ | +| active | boolean | 当前路由组件是否处于激活状态，处于激活状态时，会生效相应的路由操作。 | +| params | object | 跳转时要同时传递到目标页面的数据，可在目标页面使用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 a1e509d4738e0728db0f78553793a2210fa59e10..13988b9e9727ccd2c19f4f8e5bbb94f1a7a63baa 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含子组件。 @@ -19,24 +14,24 @@ ## 接口 -Panel(show：boolean) +Panel(show: boolean) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ---- | ------- | ---- | ---- | ------------- | -| show | boolean | 是 | - | 控制Panel显示或隐藏。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | --------------------- | +| show | boolean | 是 | 控制Panel显示或隐藏。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------- | -------------- | ------------------ | ------------------------------------------------------ | -| 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状态下的高度。 | +| 名称 | 参数类型 | 描述 | +| ---------- | -------------- | ------------------------------------------------------------ | +| type | PanelType | 设置可滑动面板的类型。
默认值：PanelType.Foldable | +| mode | PanelMode | 设置可滑动面板的初始状态。 | +| dragBar | boolean | 设置是否存在dragbar，true表示存在，false表示不存在。
默认值：true | +| fullHeight | number\|string | 指定PanelMode.Full状态下的高度。 | +| halfHeight | number\|string | 指定PanelMode.Half状态下的高度，默认为屏幕尺寸的一半。 | +| miniHeight | number\|string | 指定PanelMode.Mini状态下的高度。 | ## PanelType枚举说明 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 2fa380979b1014d4a9167b72cba5710d909e7401..8baab561732656c102f4a399f1464e28e67ac5bb 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 @@ -40,7 +40,7 @@ Swiper(value?:{controller?: SwiperController}) | cachedCount8+ | number | 设置预加载子组件个数。
默认值：1 | | disableSwipe8+ | boolean | 禁用组件滑动切换功能。
默认值：false | | displayCount8+ | number \| string | 设置一页中显示子组件的个数，设置为“auto”时等同于SwiperDisplayMode.AutoLinear的显示效果。
默认值：1 | -| effectMode8+ | EdgeEffect | 设置滑动到边缘时的显示效果。
默认值：EdgeEffect.Spring | +| effectMode8+ | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | 设置滑动到边缘时的显示效果。
默认值：EdgeEffect.Spring | | curve8+ | [Curve](ts-appendix-enums.md#curve) \| string | 设置Swiper的动画曲线，默认为淡入淡出曲线，常用曲线参考[Curve枚举说明](ts-appendix-enums.md#curve)，也可以通过插值计算模块提供的接口创建自定义的Curves([插值曲线对象](ts-interpolation-calculation.md))。
默认值：Curve.Ease | | 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)
} | 设置导航点样式：
- left: 设置导航点距离Swiper组件左边的距离。
- top: 设置导航点距离Swiper组件顶部的距离。
- right: 设置导航点距离Swiper组件右边的距离。
- bottom: 设置导航点距离Swiper组件底部的距离。
- size: 设置导航点的直径。
- mask: 设置是否显示导航点蒙层样式。
- color: 设置导航点的颜色。
- selectedColor: 设置选中的导航点的颜色。 | ## SwiperDisplayMode枚举说明 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 8e59c95ec873576948fa0b84a538850dd7b4448d..cd049e3a2c0bcc619b071505f69484aea356cf72 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,62 +1,50 @@ # 页面间转场 -> **说明：** -> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - - -页面转场通过在全局pageTransition方法内配置页面入场组件和页面退场组件来自定义页面转场动效。 - - -| 名称 | 参数 | 参数描述 | -| -------- | -------- | -------- | -| PageTransitionEnter | Object | 页面入场组件，用于自定义当前页面的入场效果，详见动效参数说明。 | -| PageTransitionExit | Object | 页面退场组件，用于自定义当前页面的退场效果，详见动效参数说明。 | +在全局pageTransition方法内配置页面入场和页面退场时的自定义转场动效。 +> **说明：** +> +> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -- 动效参数说明 - | 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | type | RouteType | - | 否 | 不配置时表明pop为push时效果的逆播。 | - | duration | number | 1000 | 否 | 动画时长，单位为毫秒。 | - | curve | Curve \| Curves | Linear | 否 | 动画曲线，有效值参见[Curve](ts-animatorproperty.md) 说明。 | - | delay | number | 0 | 否 | 动画延迟时长，单位为毫秒，默认不延时播放。 | +| 名称 | 参数 | 参数描述 | +| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| PageTransitionEnter | {
type?: RouteType,
duration?: number,
curve?: Curve \| string,
delay?:number
} | 设置当前页面的自定义入场动效。
- type：不配置时表明pop为push时效果的逆播。
- duration：动画的时长，单位为毫秒。
- curve：动画曲线，有效值参见[Curve](ts-animatorproperty.md) 。
 默认值：Curve.Linear
- delay：动画延迟时长，单位为毫秒，默认不延迟播放。 | +| PageTransitionExit | {
type?: RouteType,
duration?: number,
curve?: Curve \| string,
delay?: number
} | 设置当前页面的自定义退场动效。
- type：不配置时表明pop为push时效果的逆播
- duration：动画的时长，单位为毫秒。
- curve：动画曲线，有效值参见[Curve](ts-animatorproperty.md) 。
 默认值：Curve.Linear
- delay：动画延迟时长，单位为毫秒，默认不延迟播放。 | +## RouteType枚举说明 -- RouteType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Pop | 重定向指定页面。PageA跳转到PageB时，PageA为Exit+Push，PageB为Enter+Push。 | - | Push | 跳转到下一页面。PageB返回至PageA时，PageA为Enter+Pop，PageB为Exit+Pop。 | +| 名称 | 描述 | +| -------- | -------- | +| Pop | 重定向指定页面。PageA跳转到PageB时，PageA为Exit+Push，PageB为Enter+Push。 | +| Push | 跳转到下一页面。PageB返回至PageA时，PageA为Enter+Pop，PageB为Exit+Pop。 | +| None | 页面未重定向。 | ## 属性 -PageTransitionEnter和PageTransitionExit组件支持的属性： +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | -------- | -------- | +| slide | SlideEffect | 否 | 设置页面转场时的滑入滑出效果。
默认值：SlideEffect.Right | +| translate | {
x? : number \| string,
y? : number \| string,
z? : number \| string
} | 否 | 设置页面转场时的平移效果，为入场时起点和退场时终点的值，和slide同时设置时默认生效slide。
- x：横向的平移距离。
- y：纵向的平移距离。
- z：竖向的平移距离。 | +| scale | {
x? : number,
y? : number,
z? : number,
centerX? : number \| string,
centerY? : number \| string
} | 否 | 设置页面转场时的缩放效果，为入场时起点和退场时终点的值。
- x：横向放大倍数（或缩小比例）。
- y：纵向放大倍数（或缩小比例）。
- z：竖向放大倍数（或缩小比例）。
- centerX、centerY缩放中心点。
- 中心点为0时，默认的是组件的左上角。 | +| opacity | number | 否 | 设置入场的起点透明度值或者退场的终点透明度值。
默认值：1 | -| 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | -| -------- | -------- | -------- | -------- | -------- | -| slide | SlideEffect | SlideEffect.Right | 否 | 设置转场的滑入效果，有效值参见SlideEffect枚举说明。 | -| translate | {
x? : number,
y? : number,
z? : number
} | - | 否 | 设置页面转场时的平移效果，为入场时起点和退场时终点的值，和slide同时设置时默认生效slide。 | -| scale | {
x? : number,
y? : number,
z? : number,
centerX? : number,
centerY? : number
} | - | 否 | 设置页面转场时的缩放效果，为入场时起点和退场时终点的值。 | -| opacity | number | 1 | 否 | 设置入场的起点透明度值或者退场的终点透明度值。 | +## SlideEffect枚举说明 -- SlideEffect枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Left | 设置到入场时表示从左边滑入，出场时表示滑出到左边。 | - | Right | 设置到入场时表示从右边滑入，出场时表示滑出到右边。 | - | Top | 设置到入场时表示从上边滑入，出场时表示滑出到上边。 | - | Bottom | 设置到入场时表示从下边滑入，出场时表示滑出到下边。 | +| 名称 | 描述 | +| -------- | -------- | +| Left | 设置到入场时表示从左边滑入，出场时表示滑出到左边。 | +| Right | 设置到入场时表示从右边滑入，出场时表示滑出到右边。 | +| Top | 设置到入场时表示从上边滑入，出场时表示滑出到上边。 | +| Bottom | 设置到入场时表示从下边滑入，出场时表示滑出到下边。 | ## 事件 -PageTransitionEnter和PageTransitionExit组件支持的事件： - | 事件 | 功能描述 | | -------- | -------- | -| onEnter(type: RouteType, progress: number) => void | 回调入参为当前入场动画的归一化进度[0 - 1]。 | -| onExit(type: RouteType, progress: number) => void | 回调入参为当前退场动画的归一化进度[0 - 1]。 | +| onEnter(event: (type: RouteType, progress: number) => void) | 回调入参为当前入场动画的归一化进度[0 - 1]。
- type：跳转方法。
- progress：当前进度。 | +| onExit(event: (type: RouteType, progress: number) => void) | 回调入参为当前退场动画的归一化进度[0 - 1]。
- type：跳转方法。
- progress：当前进度。 | ## 示例