diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-basic-select.md b/zh-cn/application-dev/reference/arkui-js/js-components-basic-select.md index a5e15df4f52f7fef56a141cf374d99ae2f36b3e9..f7f8893c08e1d4e6c84fb5cc93b5ec4874209cda 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-basic-select.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-basic-select.md @@ -1,14 +1,11 @@ # select +下拉选择按钮,可使用下拉菜单展示并选择内容。 + > **说明:** +> > 从API version 4开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -下拉选择按钮,可让用户在多个选项之间选择。 - -## 权限列表 - -无 - ## 子组件 @@ -24,18 +21,18 @@ 除支持[通用样式](../arkui-js/js-components-common-styles.md)外,还支持如下样式: -| 名称 | 类型 | 默认值 | 必填 | 描述 | -| ----------- | ------ | ---------- | ---- | ---------------------------------------- | -| font-family | string | sans-serif | 否 | 字体列表,用逗号分隔,每个字体用字体名或者字体族名设置。列表中第一个系统中存在的或者通过[自定义字体](../arkui-js/js-components-common-customizing-font.md)指定的字体,会被选中作为文本的字体。 | +| 名称 | 类型 | 必填 | 描述 | +| ----------- | ------ | ---- | ------------------------------------------------------------ | +| font-family | string | 否 | 字体样式列表,用逗号分隔。列表中第一个系统中存在的字体样式或者通过[自定义字体](./js-components-common-customizing-font.md)指定的字体样式,会被选中作为当前文本的字体样式。
默认值:sans-serif | ## 事件 除支持[通用事件](../arkui-js/js-components-common-events.md)外,还支持如下事件: -| 名称 | 参数 | 描述 | -| ------ | ------------------------- | ---------------------------------------- | -| change | {newValue: newValue} | 下拉选择新值后触发该事件,newValue的值为子组件option的value属性值。 | +| 名称 | 参数 | 描述 | +| ------ | ------------------------- | ------------------------------------------------------------ | +| change | {newValue: newValue} | 选择下拉选项后触发该事件,返回值为一个对象,其中newValue为选中项option的value值。 | > **说明:** > @@ -75,4 +72,13 @@ } ``` -![zh-cn_image_0000001152588538](figures/zh-cn_image_0000001152588538.png) +```js +// ×××.js +export default { + changeFruit(e){ + console.log("newValue:" + e.newValue) + } +} +``` + +![zh-cn_image_0000001152588538](figures/zh-cn_image_0000001152588538.png) \ No newline at end of file diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-common-animation.md b/zh-cn/application-dev/reference/arkui-js/js-components-common-animation.md index 52930bd935d7e69a83d3253121154cf869c91f33..d0b3d57916df702b6229c17a072e2f37fb991d9f 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-common-animation.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-common-animation.md @@ -1,6 +1,7 @@ # 动画样式 > **说明:** +> > 从API version 4开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 组件支持动态的旋转、平移、缩放效果,可在style或css中设置。 diff --git a/zh-cn/application-dev/reference/arkui-js/js-components-custom-events.md b/zh-cn/application-dev/reference/arkui-js/js-components-custom-events.md index 729cb24785efec2b43ccfa026a8a254822ecf875..33718f75e5350b02d3c5307093b7519111d71077 100644 --- a/zh-cn/application-dev/reference/arkui-js/js-components-custom-events.md +++ b/zh-cn/application-dev/reference/arkui-js/js-components-custom-events.md @@ -72,3 +72,5 @@ export default { textClicked () {}, } ``` + +其他相关说明详见:[基本用法](./js-components-custom-basic-usage.md)。 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001174104386.gif b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001174104386.gif index fa6a5f8e639b2b8b73bdae505da6b67800c5eb63..0a924f85501f74700c590b7d2d47c3ab3663c164 100644 Binary files a/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001174104386.gif and b/zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001174104386.gif differ 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 440f326a9addc6002054d4d991d1833bc0a870c4..db994a3d8e0f9316526ecde92224dd91e62b5226 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 @@ -6,11 +6,6 @@ > 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -22,15 +17,11 @@ LoadingProgress() 创建加载进展组件。 - - ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| color | [ResourceColor](../../ui/ts-types.md) | - | 设置加载进度条前景色。 | - - +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| color | [ResourceColor](../../ui/ts-types.md) | 设置加载进度条前景色。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md index 914f9300b4d1600630c650dadc1af135c621c44c..eae2b01713e67271edcb927b13e7c00ae770e0a0 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md @@ -1,16 +1,11 @@ # Marquee - -> **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 跑马灯组件,用于滚动展示一段单行文本,仅当文本内容宽度超过跑马灯组件宽度时滚动。 -## 权限列表 - -无 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 子组件 @@ -22,23 +17,29 @@ Marquee(value: { start: boolean, step?: number, loop?: number, fromStart?: boolean, src: string }) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | start | boolean | 是 | - | 控制是否进入播放状态。 | - | step | number | 否 | 6 | 滚动动画文本滚动步长。 | - | loop | number | 否 | -1 | 设置重复滚动的次数,小于等于零时无限循环。 | - | fromStart | boolean | 否 | true | 设置文本从头开始滚动或反向滚动。 | - | src | string | 是 | - | 需要滚动的文本。 | +**参数:** + +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | -------- | -------- | +| start | boolean | 是 | 控制跑马灯是否进入播放状态。 | +| step | number | 否 | 滚动动画文本滚动步长。
默认值:6vp | +| loop | number | 否 | 设置重复滚动的次数,小于等于零时无限循环。
默认值:-1 | +| fromStart | boolean | 否 | 设置文本从头开始滚动或反向滚动。
默认值:true | +| src | string | 是 | 需要滚动的文本。 | + +## 属性 +| 名称 | 参数类型 | 描述 | +| ---------- | -------- | ------------------------------------ | +| allowScale | boolean | 是否允许文本缩放。
默认值:false | ## 事件 - | 名称 | 功能描述 | +| 名称 | 功能描述 | | -------- | -------- | -| onStart(event: () => void) | 开始滚动时触发回调。 | -| onBounce(event: () => void) | 滚动到底时触发回调。 | -| onFinish(event: () => void) | 滚动完成时触发回调。 | +| onStart(event: () => void) | 开始滚动时触发回调。 | +| onBounce(event: () => void) | 完成一次滚动时触发,若循环次数不为1,则该事件会多次触发。 | +| onFinish(event: () => void) | 滚动全部循环次数完成时触发回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md index e6095152151a471bb7fcea50d7bc09596b030c43..83f769f07188777f1a2f0775cb40f07ef7a53394 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md @@ -3,30 +3,27 @@ 支持单次点击、多次点击识别。 > **说明:** -> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - -## 权限列表 - -无 +> +> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 接口 -TapGesture(options?: { count?: number, fingers?: number }) +TapGesture(value?: { count?: number, fingers?: number }) + +**参数:** -- 参数 - | 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1,会被转化为默认值。
>  **说明:**
> 如配置多击,上一次抬起和下一次按下的超时时间为300毫秒(ms)。 | - | fingers | number | 否 | 1 | 触发点击的最少手指数,最小为1指, 最大为10指。
>  **说明:**
> 1. 当配置多指时,第一根手指按下后300毫秒(ms)内未有足够的手指数按下,手势识别失败。
> 2. 实际点击手指数超过配置值,手势识别失败。 | +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | -------- | -------- | +| count | number | 否 | 识别的连续点击次数。如果设置小于1,会被转化为默认值。
默认值:1
>  **说明:**
> 如配置多击,上一次抬起和下一次按下的超时时间为300毫秒(ms)。 | +| fingers | number | 否 | 触发点击的最少手指数,最小为1指, 最大为10指。
默认值:1
>  **说明:**
> 1. 当配置多指时,第一根手指按下后300毫秒(ms)内未有足够的手指数按下,手势识别失败。
> 2. 实际点击手指数超过配置值,手势识别失败。 | ## 事件 | 名称 | 功能描述 | | -------- | -------- | -| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | +| onAction(event: (event?: GestureEvent) => void) | Tap手势识别成功回调。 | ## 示例 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 be3ec23faf597ba91313e14070b3e97929b905cf..febd051a9de79b2b8757407e89e79d66e13b1d4f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md @@ -1,16 +1,10 @@ # Grid -> **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - 网格容器,由“行”和“列”分割的单元格所组成,通过指定“项目”所在的单元格做出各种各样的布局。 - - - -## 权限列表 - -无 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 子组件 @@ -23,41 +17,44 @@ 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 | - | 设置滚动条的颜色。 | -| scrollBarWidth | Length | - | 设置滚动条的宽度。 | -| 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 | 是否支持动画。 | +除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性: + +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| 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 | 设置滚动条的颜色。 | +| scrollBarWidth | string \| number | 设置滚动条的宽度。 | +| cachedCount | number | 设置预加载的GridItem的数量。具体使用可参考[减少应用白块说明](../../ui/ts-performance-improvement-recommendation.md#减少应用滑动白块)。
默认值:1 | +| editMode 8+ | boolean | 设置Grid是否进入编辑模式,进入编辑模式可以拖拽Grid组件内部[GridItem](ts-container-griditem.md)。
默认值:flase | +| layoutDirection8+ | [GridDirection](#griddirection8枚举说明) | 设置布局的主轴方向。
默认值: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
- false:关闭框选。
- true:开启框选。 | +| supportAnimation8+ | boolean | 是否支持动画。
默认值:false | ## 事件 +除支持[通用事件](ts-universal-events-click.md)外,还支持以下事件: + | 名称 | 功能描述 | | -------- | -------- | -| 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-gridcol.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md index 7ae03e5762361b2f41e01dd52d300a719c73c7e3..ccea12a5df644894d8f08901ad9d41b29b37363f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md @@ -6,31 +6,28 @@ > > 该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - -## 权限列表 - -无 - ## 子组件 可以包含单个子组件。 ## 接口 -GridCol(span?: number | GridColColumnOption, offset?: number | GridColColumnOption, order?: number | GridColColumnOption) +GridCol(optiion?:{span?: number | GridColColumnOption, offset?: number | GridColColumnOption, order?: number | GridColColumnOption}) + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | ---- | ------------------------------------------------------------ | +| span | number \| GridColColumnOption | 否 | 占用列数。span为0表示该元素不参与布局计算,即不会被渲染。
默认值:1。 | +| offset | number \| GridColColumnOption | 否 | 相对于前一个栅格子组件偏移的列数。
默认值:0。 | +| order | number \| GridColColumnOption | 否 | 元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
默认值:0。 | -**参数**: -| 参数名 |类型|必填|说明 -|-----|-----|-----|----| -|span| number \| GridColColumnOption | 否 |占用列数。span为0,意味着该元素不参与布局计算,即不会被渲染。
默认值:1。| -|offset|number \| GridColColumnOption| 否 |相对于前一个栅格子组件偏移的列数。
默认值:0。| -|order|number \| GridColColumnOption| 否 |元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
默认值:0。| ## 属性 -| 名称 |类型|说明 -|-----|-----|----| -|span| number \| GridColColumnOption |占用列数。span为0,意味着该元素不参与布局计算,即不会被渲染。
默认值:1。| -|offset|number \| GridColColumnOption| 相对于前一个栅格子组件偏移的列数。
默认值:0。| -|order|number \| GridColColumnOption|元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
默认值:0。| + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ----------------------------- | ---- | ------------------------------------------------------------ | +| span | number \| GridColColumnOption | 否 | 占用列数。span为0,意味着该元素不参与布局计算,即不会被渲染。
默认值:1。 | +| offset | number \| GridColColumnOption | 否 | 相对于前一个栅格子组件偏移的列数。
默认值:0。 | +| order | number \| GridColColumnOption | 否 | 元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
默认值:0。 | ## GridColColumnOption 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 4f779e905760c0ff8a93d15f0a8c703e5e3ede9f..48ceb872cb91a0268f054fbcd0a3be548e0d4365 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,24 +14,26 @@ ## 接口 -GridContainer(options?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: Length, margin?: Length}) - -- 参数 - | 参数名 | 类型 | 必填 | 默认值 | 说明 | - | -------- | -------- | -------- | -------- | -------- | - | columns | number \| 'auto' | 否 | 'auto' | 设置当前布局总列数。 | - | sizeType | SizeType | 否 | SizeType.Auto | 选用设备宽度类型。 | - | gutter | Length | 否 | - | 栅格布局列间距。 | - | margin | Length | 否 | - | 栅格布局两侧间距。 | - -- SizeType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | XS | 最小宽度类型设备。 | - | SM | 小宽度类型设备。 | - | MD | 中等宽度类型设备。 | - | LG | 大宽度类型设备。 | - | Auto | 根据设备类型进行选择。 | +GridContainer(value?: { columns?: number | 'auto', sizeType?: SizeType, gutter?: number | string, margin?: number | string}) + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| columns | number \| 'auto' | 否 | 设置当前布局总列数。
默认值:'auto' | +| sizeType | SizeType | 否 | 选用设备宽度类型。
默认值:SizeType.Auto | +| gutter | number \| string | 否 | 栅格布局列间距。 | +| margin | number \| string | 否 | 栅格布局两侧间距。 | + +## SizeType枚举说明 + +| 名称 | 描述 | +| -------- | -------- | +| XS | 最小宽度类型设备。 | +| SM | 小宽度类型设备。 | +| MD | 中等宽度类型设备。 | +| LG | 大宽度类型设备。 | +| Auto | 根据设备类型进行选择。 | ## 属性 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 8377d8dccf74ba49bd94c9dba68f5bd4ad0bb2cf..a4a006b8bc97833657c7dbbe823017617a342cb8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md @@ -1,15 +1,10 @@ # GridItem -> **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 网格容器中单项内容容器。 - -## 权限列表 - -无 +> **说明:** +> +> 该组件从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元素是否可以被鼠标框选。
>  **说明:**
> 外层Grid容器的鼠标框选开启时,GridItem的框选才生效。
默认值:true | ## 事件 | 名称 | 功能描述 | | -------- | -------- | -| 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-gridrow.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md index 9cb2070a0015d6e1e044cd84e9c5b56cd0e3b68f..7f2b517e71c8586ff33ca858e2eed70dee2a529f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md @@ -7,13 +7,6 @@ > 该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - -## 权限列表 - -无 - - ## 子组件 可以包含GridCol子组件。 @@ -27,7 +20,7 @@ GridRow(options?: {columns?: number | GridRowColumnOption, gutter?: Length | Get |-----|-----|----|----| |gutter|Length \| GetterOption| 否 |栅格布局间距,x代表水平方向。| |columns| number \| GridRowColumnOption | 否 |设置布局列数。| -|breakpoints|BreakPoints| 否 |用于设置断点值的断点数列以及基于窗口或容器尺寸的相应参照。| +|breakpoints|BreakPoints| 否 |设置断点值的断点数列以及基于窗口或容器尺寸的相应参照。| |direction|GridRowDirection| 否 |栅格布局排列方向。| ## GetterOption @@ -52,8 +45,8 @@ GridRow(options?: {columns?: number | GridRowColumnOption, gutter?: Length | Get | 参数名 | 参数类型 | 必填 | 参数描述 | | ----- | ------ | ---- | ---------------------------------------- | -| value | Array | 否 | 用于设置断点位置的单调递增数组。
默认值:["320vp", "520vp", "840vp"] | -| reference | BreakpointsReference | 否 | - | 竖直getter option。 | +| value | Array<string> | 否 | 设置断点位置的单调递增数组。
默认值:["320vp", "520vp", "840vp"] | +| reference | BreakpointsReference | 否 | 竖直gutter option。 | ```ts // 启用xs、sm、md共3个断点 breakpoints: {value: ["100vp", "200vp"]} @@ -108,7 +101,7 @@ GridRow(options?: {columns?: number | GridRowColumnOption, gutter?: Length | Get ### onBreakpointChange -onBreakpointChange(callback: (breakpoints: string) => void +onBreakpointChange(callback: (breakpoints: string) => void) **参数:** @@ -116,8 +109,6 @@ onBreakpointChange(callback: (breakpoints: string) => void | ----- | ------ | ---- | ---------------------------------------- | |breakpoints| string |是|断点发生变化时触发回调
取值为`"xs"`、`"sm"`、`"md"`、`"lg"`、`"xl"`、`"xxl"`。| - - ## 示例 ```ts 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 e505f1a7577e7dc6f7a3256ce5b3706841f3d18c..0b6bad849dc9b001894eac9a49a160f45b9d358b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md @@ -1,19 +1,13 @@ # List +列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。 + > **说明:** > > - 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 > - 该组件回弹的前提是要有滚动。内容小于一屏时,没有回弹效果。 -列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。 - - -## 权限列表 - -无 - - ## 子组件 包含[ListItem](ts-container-listitem.md)、[ListItemGroup](ts-container-listitemgroup.md)子组件。 @@ -21,67 +15,67 @@ ## 接口 -List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller}) +List(value?:{space?: number | string, initialIndex?: number, scroller?: Scroller}) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | space | [Length](../../ui/ts-types.md#length) | 否 | 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,
color?:[ResourceColor](../../ui/ts-types.md),
startMargin?: Length,
endMargin?: Length
} | - | 用于设置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序号。 | -| lanes9+ | number \|
{
minLength: Length,
maxLength: Length
} | 1 | 以列模式为例(listDirection为Axis.Vertical):
lanes用于决定List组件在交叉轴方向按几列布局,规则如下:
- lanes为指定的数量时,根据指定的数量与List组件的交叉轴宽度来决定每列的宽度;
- lane设置了{minLength,maxLength}时,根据List组件的宽度自适应决定lanes数量(即列数),保证缩放过程中lane的宽度符合{minLength,maxLength}的限制。其中,minLength条件会被优先满足,即优先保证符合ListItem的宽度符合最小宽度限制。例如在列模式下,设置了{minLength: 40vp,maxLength: 60vp},则当List组件宽度为70vp时,ListItem为一列,并且根据alignListItem属性做靠左、居中或者靠右布局;当List组件宽度变化至80vp时,符合两倍的minLength,则ListItem自适应为两列。 | -| alignListItem9+ | ListItemAlign | ListItemAlign.Center | List交叉轴方向宽度大于ListItem交叉轴宽度 * lanes时,ListItem在List交叉轴方向的布局方式,默认为居中。 | -| sticky9+ | StickyStyle | StickyStyle.None | 配合[ListItemGroup](ts-container-listitemgroup.md)组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底,参见StickyStyle的枚举说明。| - -- ListItemAlign9+枚举说明 - - | 名称 | 描述 | - | ------ | -------------------------------------- | - | Start | ListItem在List中,交叉轴方向首部对齐。 | - | Center | ListItem在List中,交叉轴方向居中对齐。 | - | End | ListItem在List中,交叉轴方向尾部对齐。 | - -- StickyStyle9+枚举说明 - - | 名称 | 描述 | - | ------ | -------------------------------------- | - | None | ListItemGroup的header不吸顶,footer不吸底。 | - | Header | ListItemGroup的header吸顶。 | - | Footer | ListItemGroup的footer吸底。 | - - sticky属性可以设置为 StickyStyle.Header | StickyStyle.Footer 以同时支持header吸顶和footer吸底。 +除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性: + +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| listDirection | [Axis](ts-appendix-enums.md#axis) | 设置List组件排列方向。
默认值:Axis.Vertical | +| divider | {
strokeWidth: [Length](../../ui/ts-types.md#length),
color?:[ResourceColor](../../ui/ts-types.md),
startMargin?: Length,
endMargin?: 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.Spring | +| chainAnimation | boolean | 设置当前List是否启用链式联动动效,开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果:List内的list-item间隔一定距离,在基本的滑动交互行为下,主动对象驱动从动对象进行联动,驱动效果遵循弹簧物理动效。
默认值:false
- false:不启用链式联动。
- true:启用链式联动。 | +| multiSelectable8+ | boolean | 是否开启鼠标框选。
默认值:false
- false:关闭框选。
- true:开启框选。 | +| lanes9+ | number \| [LengthConstrain](../../ui/ts-types.md#lengthconstrain) | 以列模式为例(listDirection为Axis.Vertical):
lanes用于决定List组件在交叉轴方向按几列布局。
默认值:1
规则如下:
- lanes为指定的数量时,根据指定的数量与List组件的交叉轴宽度来决定每列的宽度;
- lane设置了{minLength,maxLength}时,根据List组件的宽度自适应决定lanes数量(即列数),保证缩放过程中lane的宽度符合{minLength,maxLength}的限制。其中,minLength条件会被优先满足,即优先保证符合ListItem的宽度符合最小宽度限制。例如在列模式下,设置了{minLength: 40vp,maxLength: 60vp},则当List组件宽度为70vp时,ListItem为一列,并且根据alignListItem属性做靠左、居中或者靠右布局;当List组件宽度变化至80vp时,符合两倍的minLength,则ListItem自适应为两列。 | +| alignListItem9+ | ListItemAlign | List交叉轴方向宽度大于ListItem交叉轴宽度 * lanes时,ListItem在List交叉轴方向的布局方式,默认为居中。
默认值:ListItemAlign.Center | +| sticky9+ | StickyStyle | 配合[ListItemGroup](ts-container-listitemgroup.md)组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底。
默认值:StickyStyle.None
**说明:**
sticky属性可以设置为 StickyStyle.Header \| StickyStyle.Footer 以同时支持header吸顶和footer吸底。 | + +## ListItemAlign9+枚举说明 + +| 名称 | 描述 | +| ------ | -------------------------------------- | +| Start | ListItem在List中,交叉轴方向首部对齐。 | +| Center | ListItem在List中,交叉轴方向居中对齐。 | +| End | ListItem在List中,交叉轴方向尾部对齐。 | + +## StickyStyle9+枚举说明 + +| 名称 | 描述 | +| ------ | -------------------------------------- | +| None | ListItemGroup的header不吸顶,footer不吸底。 | +| Header | ListItemGroup的header吸顶。 | +| Footer | ListItemGroup的footer吸底。 | ## 事件 | 名称 | 功能描述 | | -------- | -------- | -| onItemDelete(event: (index: number) => boolean) | 列表项删除时触发。 | -| onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void) | 列表滑动时触发,返回值scrollOffset为滑动偏移量,scrollState为当前滑动状态。 | -| onScrollIndex(event: (start: number, end: number) => void) | 列表滑动时触发,返回值分别为滑动起始位置索引值与滑动结束位置索引值。 | +| onItemDelete(event: (index: number) => boolean) | 当List组件在编辑模式时,点击ListItem右边出现的删除按钮时触发。
- index: 被删除的列表项的索引值。 | +| onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void) | 列表滑动时触发。
- scrollOffset: 滑动偏移量。
- [scrollState](#scrollstate枚举说明): 当前滑动状态。 | +| onScrollIndex(event: (start: number, end: number) => void) | 列表滑动时触发。
计算索引值时,ListItemGroup作为一个整体占一个索引值,不计算ListItemGroup内部ListItem的索引值。
- start: 滑动起始位置索引值。
- end: 滑动结束位置索引值。 | | onReachStart(event: () => void) | 列表到达起始位置时触发。 | | onReachEnd(event: () => void) | 列表到底末尾位置时触发。 | +| onScrollBegin9+(event: (dx: number, dy: number) => { dxRemain: number, dyRemain: number }) | 列表开始滑动时触发。
\- dx:即将发生的水平方向滚动量。
\- dy:即将发生的竖直方向滚动量。
- dxRemain:水平方向滚动剩余量。
\- dyRemain:竖直方向滚动剩余量。 | | onScrollStop(event: () => void) | 列表滑动停止时触发。 | -| onItemMove(event: (from: number, to: number) => boolean) | 列表元素发生移动时触发,返回值from、to分别为移动前索引值与移动后索引值。 | -| 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为是否成功释放。 | +| onItemMove(event: (from: number, to: number) => boolean) | 列表元素发生移动时触发。
- from: 移动前索引值。
- to: 移动后索引值。 | +| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any) \| void) | 开始拖拽列表元素时触发。
- event: 见[ItemDragInfo对象说明](ts-container-grid.md#itemdraginfo对象说明)。
- itemIndex: 被拖拽列表元素索引值。 | +| onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入列表元素范围内时触发。
- event: 见[ItemDragInfo对象说明](ts-container-grid.md#itemdraginfo对象说明)。 | +| onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void) | 拖拽在列表元素范围内移动时触发。
- event: 见[ItemDragInfo对象说明](ts-container-grid.md#itemdraginfo对象说明)。
- itemIndex: 拖拽起始位置。
- insertIndex: 拖拽插入位置。 | +| onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void) | 拖拽离开列表元素时触发。
- event: 见[ItemDragInfo对象说明](ts-container-grid.md#itemdraginfo对象说明)。
- itemIndex: 拖拽离开的列表元素索引值。 | +| onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void) | 绑定该事件的列表元素可作为拖拽释放目标,当在列表元素内停止拖拽时触发。
- event: 见ItemDragInfo对象说明。
- itemIndex: 拖拽起始位置。
- insertIndex: 拖拽插入位置。
- isSuccess: 是否成功释放。 | ## ScrollState枚举说明 @@ -92,19 +86,20 @@ List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller} | Fling | 手指拖动状态。 | > **说明:** -> List使能可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件: -> -> - editMode属性设置为true。 -> -> - 绑定onItemDelete事件,且事件回调返回true。 -> -> - ListItem的editable属性设置为true。 -> -> 实现ListItem拖拽,需满足以下条件: -> -> - editMode属性设置为true。 -> -> - 绑定onDragStart事件,且事件回调中返回浮动UI布局。 +> +> 要使List处于可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件: +> +> - editMode属性设置为true。 +> +> - 绑定onItemDelete事件,且事件回调返回true。 +> +> - ListItem的editable属性设置为true。 +> +> 实现ListItem拖拽,需满足以下条件: +> +> - editMode属性设置为true。 +> +> - 绑定onDragStart事件,且事件回调中返回浮动UI布局。 ## 示例 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 51b4f079c1a64dca5d2cb18a678611d760178965..281dbaeca112580429e30278772597160d41a568 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md @@ -1,15 +1,10 @@ # ListItem -> **说明:** -> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 用来展示列表具体item,宽度默认充满List组件,必须配合List来使用。 - -## 权限列表 - -无 +> **说明:** +> +> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 子组件 @@ -19,24 +14,25 @@ ## 接口 -ListItem() - +ListItem(value?: string) ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------- | -------- | -------- | -------- | -| sticky | Sticky | Sticky.None | 设置ListItem吸顶效果,参见Sticky枚举描述。 | -| editable | boolean \| EditMode | false | 当前ListItem元素是否可编辑,进入编辑模式后可删除或移动。 | -| selectable8+ | boolean | true | 当前ListItem元素是否可以被鼠标框选。
>  **说明:**
> 外层List容器的鼠标框选开启时,ListItem的框选才生效。 | -| swipeAction9+ | {
start?: CustomBuilder,
end?:CustomBuilder,
edgeEffect?: SwipeEdgeEffect,
} | - | 用于设置ListItem的划出组件。
start: ListItem向右划动时item左边的组件(List垂直布局时)或ListItem向下划动时item上方的组件(List水平布局时)。
end: ListItem向左划动时item右边的组件(List垂直布局时)或ListItem向上划动时item下方的组件(List水平布局时)。
edgeEffect: 滑动效果,参见SwipeEdgeEffect的枚举说明。
| +除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性: + +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| sticky | [Sticky](#sticky枚举说明) | 设置ListItem吸顶效果。
默认值:Sticky.None | +| editable | boolean \| [EditMode](#editmode枚举说明) | 当前ListItem元素是否可编辑,进入编辑模式后可删除或移动列表项。
默认值:false | +| selectable8+ | boolean | 当前ListItem元素是否可以被鼠标框选。
**说明:**
外层List容器的鼠标框选开启时,ListItem的框选才生效。
默认值:true | +| swipeAction9+ | {
start?: CustomBuilder,
end?:CustomBuilder,
edgeEffect?: [SwipeEdgeEffect](#swipeedgeeffect9枚举说明),
} | 用于设置ListItem的划出组件。
- start: ListItem向右划动时item左边的组件(List垂直布局时)或ListItem向下划动时item上方的组件(List水平布局时)。
- end: ListItem向左划动时item右边的组件(List垂直布局时)或ListItem向上划动时item下方的组件(List水平布局时)。
- edgeEffect: 滑动效果。
| ## Sticky枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | None | 无吸顶效果。 | - | Normal | 当前item吸顶。 | - | Opacity | 当前item吸顶显示透明度变化效果。 | +| 名称 | 描述 | +| -------- | -------- | +| None | 无吸顶效果。 | +| Normal | 当前item吸顶。 | +| Opacity | 当前item吸顶显示透明度变化效果。 | ## EditMode枚举说明 @@ -47,10 +43,10 @@ ListItem() | Movable | 可移动。 | ## SwipeEdgeEffect9+枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Spring | ListItem划动距离超过划出组件大小后可以继续划动,松手后按照弹簧阻尼曲线回弹。 | - | None | ListItem划动距离不能超过划出组件大小。 | +| 名称 | 描述 | +| -------- | -------- | +| Spring | ListItem划动距离超过划出组件大小后可以继续划动,松手后按照弹簧阻尼曲线回弹。 | +| None | ListItem划动距离不能超过划出组件大小。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md index 206f577e2ddb3e6d40ae68b3976e3b42f1b475bf..74b42ee136bc31fe4e70369735d57875d22fa586 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md @@ -6,10 +6,6 @@ > > 该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 @@ -18,15 +14,15 @@ ## 接口 -ListItemGroup(options?: {header?: CustomBuilder, footer?: CustomBuilder, space?: number | string}}) +ListItemGroup(options?: {header?: CustomBuilder, footer?: CustomBuilder, space?: number | string}) **参数:** - | 参数名 | 参数类型 | 必填 | 参数描述 | - | -------- | -------- | -------- | -------- | - | header | [CustomBuilder](../../ui/ts-types.md#custombuilder8) | 否 | 设置ListItemGroup头部组件。 | - | footer | [CustomBuilder](../../ui/ts-types.md#custombuilder8) | 否 | 设置ListItemGroup尾部组件。 | - | space | number \| string | 否 | 列表项间距。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | -------- | -------- | +| header | [CustomBuilder](../../ui/ts-types.md#custombuilder8) | 否 | 设置ListItemGroup头部组件。 | +| footer | [CustomBuilder](../../ui/ts-types.md#custombuilder8) | 否 | 设置ListItemGroup尾部组件。 | +| space | number \| string | 否 | 列表项间距。 | ## 属性 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 10549452d1f1471464b06f7795a48477a905fbe1..8546ba4a914ee5b47575020de6360222a70f2cc2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md @@ -1,19 +1,13 @@ # Scroll +可滚动的容器组件,当子组件的布局尺寸超过父组件的尺寸时,内容可以滚动。 + > **说明:** > - 该组件从API version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 > - 该组件嵌套List子组件滚动时,若List不设置宽高,则默认全部加载,在对性能有要求的场景下建议指定List的宽高。 > - 该组件回弹的前提是要有滚动。内容小于一屏时,没有回弹效果。 -可滚动的容器组件,当子组件的布局尺寸超过父组件的视口时,内容可以滚动。 - - -## 权限列表 - -无 - - ## 子组件 支持单个子组件。 @@ -23,23 +17,25 @@ 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的枚举说明。 | +除支持[通用属性](ts-universal-attributes-size.md)外,还支持以下属性: + +| 名称 | 参数类型 | 描述 | +| -------------- | ---------------------------------------- | --------- | +| scrollable | ScrollDirection | 设置滚动方法。
默认值:ScrollDirection.Vertical | +| scrollBar | [BarState](ts-appendix-enums.md#barstate) | 设置滚动条状态。
默认值:BarState.Off | +| scrollBarColor | string \| number \| Color | 设置滚动条的颜色。 | +| scrollBarWidth | string \| number | 设置滚动条的宽度。 | +| edgeEffect | [EdgeEffect](#edgeeffect) | 设置滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。
默认值:EdgeEffect.Spring | ## ScrollDirection枚举说明 - | 名称 | 描述 | - | ---------- | ---------- | - | Horizontal | 仅支持水平方向滚动。 | - | Vertical | 仅支持竖直方向滚动。 | - | None | 不可滚动。 | +| 名称 | 描述 | +| ---------- | ------------------------ | +| Horizontal | 仅支持水平方向滚动。 | +| Vertical | 仅支持竖直方向滚动。 | +| None | 不可滚动。 | +| Free | 支持竖直或水平方向滚动。 | ## EdgeEffect枚举说明 @@ -51,15 +47,16 @@ Scroll(scroller?: Scroller) ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ----------------------------- | -| onScrollBegin9+(dx: number, dy: number) => { dxRemain: number, dyRemain: number } | 滚动开始事件回调。
参数:
- dx:即将发生的水平方向滚动量。
- dy:即将发生的竖向方向滚动量。
返回值:
- dxRemain:水平方向滚动剩余量。
- dyRemain:竖直方向滚动剩余量。 | -| onScroll(event: (xOffset: number, yOffset: number) => void) | 滚动事件回调, 返回滚动时水平、竖直方向偏移量。 | -| onScrollEdge(event: (side: Edge) => void) | 滚动到边缘事件回调。 | -| onScrollEnd(event: () => void) | 滚动停止事件回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| onScrollBegin9+(event: (dx: number, dy: number) => { dxRemain: number, dyRemain: number }) | 滚动开始事件回调。
参数:
- dx:即将发生的水平方向滚动量。
- dy:即将发生的竖直方向滚动量。
返回值:
- dxRemain:水平方向滚动剩余量。
- dyRemain:竖直方向滚动剩余量。 | +| onScroll(event: (xOffset: number, yOffset: number) => void) | 滚动事件回调, 返回滚动时水平、竖直方向偏移量。 | +| onScrollEdge(event: (side: Edge) => void) | 滚动到边缘事件回调。 | +| onScrollEnd(event: () => void) | 滚动停止事件回调。 | > **说明:** -> 若通过onScrollBegin事件和scrollBy方法实现容器嵌套滚动,需设置子滚动节点的EdgeEffect为None。如Scroll嵌套List滚动时,List组件的edgeEffect属性需设置为EdgeEffect.None。 +> +> 若通过onScrollBegin事件和scrollBy方法实现容器嵌套滚动,需设置子滚动节点的EdgeEffect为None。如Scroll嵌套List滚动时,List组件的edgeEffect属性需设置为EdgeEffect.None。 ## Scroller @@ -80,13 +77,13 @@ scrollTo(value: { xOffset: number | string, yOffset: number | string, animation? 滑动到指定位置。 +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------- | ---------------------------------------- | ---- | ---- | ---------------------------------------- | - | xOffset | Length | 是 | - | 水平滑动偏移。 | - | yOffset | Length | 是 | - | 竖直滑动偏移。 | - | animation | {
duration: number,
curve: [Curve](ts-animatorproperty.md) \|
CubicBezier \|
SpringCurve
} | 否 | | 动画配置:
- duration: 滚动时长设置。
- curve: 滚动曲线设置。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| --------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| xOffset | Length | 是 | 水平滑动偏移。 | +| yOffset | Length | 是 | 竖直滑动偏移。 | +| animation | {
duration: number,
curve: [Curve](ts-animatorproperty.md) \|
CubicBezier \|
SpringCurve
} | 否 | 动画配置:
- duration: 滚动时长设置。
- curve: 滚动曲线设置。 | ### scrollEdge @@ -96,14 +93,12 @@ scrollEdge(value: Edge): void 滚动到容器边缘。 +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ---- | ---- | ---- | --------- | - | value | [Edge](ts-appendix-enums.md#edge) | 是 | - | 滚动到的边缘位置。 | - +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----- | ---- | ---- | --------- | +| value | [Edge](ts-appendix-enums.md#edge) | 是 | 滚动到的边缘位置。 | - ### scrollPage @@ -111,25 +106,26 @@ scrollPage(value: { next: boolean, direction?: Axis }): void 滚动到下一页或者上一页。 -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | --------- | ------- | ---- | ---- | ------------------------------ | - | next | boolean | 是 | - | 是否向下翻页。true表示向下翻页,false表示向上翻页。 | - | direction | [Axis](ts-appendix-enums.md#axis) | 否 | - | 设置滚动方向为水平或竖直方向。 | +**参数:** + +| 参数名 | 参数类型 | 必填 | 参数描述 | +| --------- | ------- | ---- | ------------------------------ | +| next | boolean | 是 | 是否向下翻页。true表示向下翻页,false表示向上翻页。 | +| direction | [Axis](ts-appendix-enums.md#axis) | 否 | 设置滚动方向为水平或竖直方向。 | ### currentOffset -currentOffset(): Object +currentOffset() 返回当前的滚动偏移量。 +**返回值** -- 返回值 - | 类型 | 描述 | - | ---------------------------------------- | ---------------------------------------- | - | {
xOffset: number,
yOffset: number
} | xOffset: 水平滑动偏移;
yOffset: 竖直滑动偏移。 | +| 类型 | 描述 | +| ---------------------------------------- | ---------------------------------------- | +| {
xOffset: number,
yOffset: number
} | xOffset: 水平滑动偏移;
yOffset: 竖直滑动偏移。 | ### scrollToIndex @@ -141,13 +137,14 @@ scrollToIndex(value: number): void > **说明:** -> 仅支持list组件。 +> +> 仅支持list组件。 +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ------ | ---- | ---- | ----------------- | - | value | number | 是 | - | 要滑动到的列表项在列表中的索引值。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ---------------------------------- | +| value | number | 是 | 要滑动到的列表项在列表中的索引值。 | ### scrollBy @@ -159,14 +156,15 @@ scrollBy(dx: Length, dy: Length): void > **说明:** -> 仅支持Scroll组件。 +> +> 仅支持Scroll组件。 +**参数:** -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ----- | ------ | ---- | ---- | ----------------- | - | dx | Length | 是 | - | 水平方向滚动距离。 | - | dy | Length | 是 | - | 竖直方向滚动距离。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----- | ------ | ---- | ----------------- | +| dx | Length | 是 | 水平方向滚动距离。 | +| dy | Length | 是 | 竖直方向滚动距离。 | ## 示例 @@ -208,22 +206,27 @@ struct ScrollExample { .onScrollEnd(() => { console.info('Scroll Stop') }) - + + Button('scroll 150') + .onClick(() => { // 点击后下滑指定距离150.0vp + this.scroller.scrollBy(0,150) + }) + .margin({ top: 10, left: 20 }) Button('scroll 100') - .onClick(() => { // 点击后下滑100.0距离 + .onClick(() => { // 点击后滑动到指定位置,即下滑100.0vp的距离 this.scroller.scrollTo({ xOffset: 0, yOffset: this.scroller.currentOffset().yOffset + 100 }) }) - .margin({ top: 10, left: 20 }) + .margin({ top: 60, left: 20 }) Button('back top') .onClick(() => { // 点击后回到顶部 this.scroller.scrollEdge(Edge.Top) }) - .margin({ top: 60, left: 20 }) + .margin({ top: 110, left: 20 }) Button('next page') - .onClick(() => { // 点击后下滑到底部 + .onClick(() => { // 点击后滑到下一页 this.scroller.scrollPage({ next: true }) }) - .margin({ top: 110, left: 20 }) + .margin({ top: 170, left: 20 }) }.width('100%').height('100%').backgroundColor(0xDCDCDC) } } 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 d6f3d8814bf8728ac4fdb48a48c8014d7b55d68a..c3d6fd69e2f8607bc6831805d28bfebbd39e449c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md @@ -1,15 +1,10 @@ # SideBarContainer -> **说明:** -> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 - - 提供侧边栏可以显示和隐藏的侧边栏容器,通过子组件定义侧边栏和内容区,第一个子组件表示侧边栏,第二个子组件表示内容区。 - -## 权限列表 - -无 +> **说明:** +> +> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 ## 子组件 @@ -21,52 +16,54 @@ SideBarContainer( type?: SideBarContainerType ) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | type | SideBarContainerType | 否 | SideBarContainerType.Embed | 设置侧边栏的显示类型。 | +**参数:** -- SideBarContainerType枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Embed | 侧边栏嵌入到组件内,侧边栏和内容区并列显示。 | - | Overlay | 侧边栏浮在内容区上面。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | -------- | -------- | +| type | SideBarContainerType | 否 | 设置侧边栏的显示类型。
默认值:SideBarContainerType.Embed | + +## SideBarContainerType枚举说明 + +| 名称 | 描述 | +| -------- | -------- | +| Embed | 侧边栏嵌入到组件内,侧边栏和内容区并列显示。 | +| Overlay | 侧边栏浮在内容区上面。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| showSideBar | boolean | 设置是否显示侧边栏。
默认值:true | +| controlButton | ButtonStyle | 设置侧边栏控制按钮的属性。 | +| showControlButton | boolean | 设置是否显示控制按钮。
默认值:true | +| sideBarWidth | number | 设置侧边栏的宽度。
默认值:200vp | +| minSideBarWidth | number | 设置侧边栏最小宽度。
默认值:200vp | +| maxSideBarWidth | number | 设置侧边栏最大宽度。
默认值:280vp | +| autoHide9+ | boolean | 设置当侧边栏拖拽到小于最小宽度后,是否自动隐藏。
默认值:true | +| sideBarPosition9+ | SideBarPosition | 设置侧边栏显示位置。
默认值:SideBarPosition.Start | + +## ButtonStyle对象说明 + +| 名称 | 参数类型 | 必填 | 描述 | | -------- | -------- | -------- | -------- | -| showSideBar | boolean | true | 设置是否显示侧边栏。 | -| controlButton | ButtonStyle | - | 设置侧边栏控制按钮的属性。 | -| showControlButton | boolean | true | 设置是否显示控制按钮。 | -| sideBarWidth | number \| [Length9+](../../ui/ts-types.md#长度类型) | 200 | 设置侧边栏的宽度。 | -| minSideBarWidth | number \| [Length9+](../../ui/ts-types.md#长度类型) | 200 | 设置侧边栏最小宽度。 | -| maxSideBarWidth | number \| [Length9+](../../ui/ts-types.md#长度类型) | 280 | 设置侧边栏最大宽度。 | -| autoHide9+ | boolean | true | 设置当侧边栏拖拽到小于最小宽度后,是否自动隐藏。 | -| sideBarPosition9+ | SideBarPosition | SideBarPosition.Start | 设置侧边栏显示位置。 | - -- ButtonStyle对象说明 - | 名称 | 参数类型 | 必填 | 默认值 | 描述 | - | -------- | -------- | -------- | -------- | -------- | - | left | number | 否 | 16 | 设置侧边栏控制按钮距离容器左界限的间距。 | - | top | number | 否 | 48 | 设置侧边栏控制按钮距离容器上界限的间距。 | - | width | number | 否 | 32 | 设置侧边栏控制按钮的宽度。 | - | height | number | 否 | 32 | 设置侧边栏控制按钮的高度。 | - | icons | {
shown: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
hidden: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
switching?: string \| PixelMap \| [Resource](../../ui/ts-types.md)
} | 否 | - | 设置侧边栏控制按钮的图标:

- shown: 设置侧边栏显示时控制按钮的图标。
- hidden: 设置侧边栏隐藏时控制按钮的图标。
- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 | - -- SideBarPosition9+枚举说明 - | 名称 | 描述 | - | -------- | -------- | - | Start | 侧边栏位于容器左侧。 | - | End | 侧边栏位于容器右侧。 | +| left | number | 否 | 设置侧边栏控制按钮与容器左界限的间距。
默认值:16 | +| top | number | 否 | 设置侧边栏控制按钮与容器上界限的间距。
默认值:48 | +| width | number | 否 | 设置侧边栏控制按钮的宽度。
默认值:32 | +| height | number | 否 | 设置侧边栏控制按钮的高度。
默认值:32 | +| icons | {
shown: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
hidden: string \| PixelMap \| [Resource](../../ui/ts-types.md) ,
switching?: string \| PixelMap \| [Resource](../../ui/ts-types.md)
} | 否 | 设置侧边栏控制按钮的图标:

- shown: 设置侧边栏显示时控制按钮的图标。
- hidden: 设置侧边栏隐藏时控制按钮的图标。
- switching:设置侧边栏显示和隐藏状态切换时控制按钮的图标。 | +## SideBarPosition9+枚举说明 +| 名称 | 描述 | +| -------- | -------- | +| Start | 侧边栏位于容器左侧。 | +| End | 侧边栏位于容器右侧。 | ## 事件 -| 名称 | 功能描述 | +| 名称 | 功能描述 | | -------- | -------- | -| onChange(callback: (value: boolean) => void) | 当侧边栏的状态在显示和隐藏之间切换时触发回调。

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

value的true表示显示,false表示隐藏。| ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md b/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md index cbcfa72be684675fb959ed0860e1ea9dd4a3e594..3b4233378f9b31faada9303d5df007e1f2071bba 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md @@ -8,9 +8,9 @@ ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | +| 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| motionPath | {
path: string,
from?: number,
to?: number,
rotatable?: boolean
}
**说明:**
path中支持通过start和end进行起点和终点的替代,如:
'Mstart.x start.y L50 50 Lend.x end.y Z'| {
"",
0.0,
1.0,
false
} | 设置组件的运动路径,入参说明如下:
- path:位移动画的运动路径,使用svg路径字符串。
- from:运动路径的起点,默认为0.0。
- to:运动路径的终点,默认为1.0。
- rotatable:是否跟随路径进行旋转。 | +| motionPath | {
path: string,
from?: number,
to?: number,
rotatable?: boolean
}
**说明:**
path中支持通过start和end进行起点和终点的替代,如:
'Mstart.x start.y L50 50 Lend.x end.y Z'| {
"",
0.0,
1.0,
false
} | 设置组件的运动路径,入参说明如下:
- path:位移动画的运动路径,使用svg路径字符串。
- from:运动路径的起点,默认为0.0。
- to:运动路径的终点,默认为1.0。
- rotatable:是否跟随路径进行旋转。 | ## 示例 @@ -25,6 +25,7 @@ struct MotionPathExample { build() { Column() { Button('click me') + // 执行动画:从起点滑到(300,200),再到(300,500),再到终点。 .motionPath({ path: 'Mstart.x start.y L300 200 L300 500 Lend.x end.y', from: 0.0, to: 1.0, rotatable: true }) .onClick((event: ClickEvent) => { animateTo({ duration: 4000, curve: Curve.Linear }, () => { diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md index 16b62a14b26ee3f5598a8797153c7df0482872f2..d8ed0e845f5650bd2a718d072d5b1075fbfa7a6c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md @@ -3,19 +3,15 @@ 自定义组件的走焦效果,可设置组件是否走焦和具体的走焦顺序,tab键或者方向键切换焦点。 > **说明:** +> > 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 属性 | **名称** | **参数类型** | **默认值** | **描述** | | -------------------- | -------- | ------- | ---------------------------------------- | -| focusable | boolean | false | 设置当前组件是否可以获焦。 | +| focusable | boolean | false | 设置当前组件是否可以获焦。
**说明:**
存在默认交互逻辑的组件例如Button、TextInput等,默认即为可获焦,Text、Image等组件则默认状态为不可获焦。 | | tabIndex9+ | number | 0 | 自定义组件tab键走焦能力,走焦顺序为:tabIndex大于0的组件依次递增走焦, tabIndex等于0的组件按组件树先后顺序走焦。
- tabIndex >= 0:表示元素是可聚焦的,并且可以通过tab键走焦来访问到该元素,按照tabIndex的数值递增而先后获焦。如果多个元素拥有相同的tabIndex,按照元素在当前组件树中的先后顺序获焦
- tabIndex < 0(通常是tabIndex = -1):表示元素是可聚焦的,但是不能通过tab键走焦来访问到该元素。 | | defaultFocus9+ | boolean | false | 设置当前组件是否为当前页面上的默认焦点,仅在初次创建的页面第一次进入时生效。 | | groupDefaultFocus9+ | boolean | false | 设置当前组件是否为当前组件所在容器获焦时的默认焦点,仅在初次创建容器节点第一次获焦时生效。
**说明:** 必须与tabIndex联合使用,当某个容器设置了tabIndex,且容器内某子组件设置了groupDefaultFocus,当该容器首次获焦时,会自动将焦点转移至该组件上。 | diff --git a/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-configuration.md b/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-configuration.md index 3681e765caced63b2f98e917cf6a7cf92725aa56..f139c9efc848cff2a6cabf5da8acd5a56699b8c3 100644 --- a/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-configuration.md +++ b/zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-configuration.md @@ -32,3 +32,5 @@ } } ``` + +可参考示例:[input](./js-service-widget-basic-input.md)与[list](js-service-widget-container-list.md)等组件中的用法。 \ No newline at end of file diff --git a/zh-cn/application-dev/ui/ui-js-animate-component.md b/zh-cn/application-dev/ui/ui-js-animate-component.md index 03b8b958ea70a55e62714ef492b18a84430bd3f9..859fb01701d252c51c60600f2dd283bd62fbd1b5 100644 --- a/zh-cn/application-dev/ui/ui-js-animate-component.md +++ b/zh-cn/application-dev/ui/ui-js-animate-component.md @@ -346,7 +346,7 @@ export default { ![zh-cn_image_0000001220635011](figures/zh-cn_image_0000001220635011.gif) -通过改变playStat的属性实现动画状态的改变。 +通过改变playState的值实现动画状态的改变。 ```html diff --git a/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md b/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md index 581b586411fed4360f3590b6aef42823af5ec30b..f3b632e1d4ba15fa20ca9ee1cb25cfb4ab8984a4 100644 --- a/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md +++ b/zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md @@ -159,12 +159,12 @@ } ``` -3. 获取foodData对应的value。调用router.getParams().foodData来获取到FoodCategoryList页面跳转来时携带的foodDate对应的数据。 +3. 获取foodData对应的value。调用router.getParams()['foodData']来获取到FoodCategoryList页面跳转来时携带的foodDate对应的数据。 ```ts @Entry @Component struct FoodDetail { - private foodItem: FoodData = router.getParams().foodData + private foodItem: FoodData = router.getParams()['foodData'] build() { ...... @@ -248,7 +248,7 @@ @Entry @Component struct FoodDetail { - private foodItem: FoodData = router.getParams().foodData + private foodItem: FoodData = router.getParams()['foodData'] build() { Column() {