Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
7a4f4d87
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
7a4f4d87
编写于
9月 16, 2022
作者:
O
openharmony_ci
提交者:
Gitee
9月 16, 2022
浏览文件
操作
浏览文件
下载
差异文件
!9135 update docs
Merge pull request !9135 from 关明月/master
上级
ca7d5033
455063ed
变更
21
隐藏空白更改
内联
并排
Showing
21 changed file
with
290 addition
and
298 deletion
+290
-298
zh-cn/application-dev/reference/arkui-js/js-components-basic-select.md
...tion-dev/reference/arkui-js/js-components-basic-select.md
+19
-13
zh-cn/application-dev/reference/arkui-js/js-components-common-animation.md
...-dev/reference/arkui-js/js-components-common-animation.md
+1
-0
zh-cn/application-dev/reference/arkui-js/js-components-custom-events.md
...ion-dev/reference/arkui-js/js-components-custom-events.md
+2
-0
zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001174104386.gif
...ference/arkui-ts/figures/zh-cn_image_0000001174104386.gif
+0
-0
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
...reference/arkui-ts/ts-basic-components-loadingprogress.md
+3
-12
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md
...ion-dev/reference/arkui-ts/ts-basic-components-marquee.md
+21
-20
zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md
...n/application-dev/reference/arkui-ts/ts-container-grid.md
+33
-31
zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md
...pplication-dev/reference/arkui-ts/ts-container-gridcol.md
+15
-18
zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md
...tion-dev/reference/arkui-ts/ts-container-gridcontainer.md
+23
-26
zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md
...plication-dev/reference/arkui-ts/ts-container-griditem.md
+11
-16
zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md
...pplication-dev/reference/arkui-ts/ts-container-gridrow.md
+3
-12
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
...n/application-dev/reference/arkui-ts/ts-container-list.md
+52
-53
zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md
...plication-dev/reference/arkui-ts/ts-container-listitem.md
+21
-22
zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md
...tion-dev/reference/arkui-ts/ts-container-listitemgroup.md
+1
-1
zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md
...application-dev/reference/arkui-ts/ts-container-scroll.md
+70
-67
zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md
...n-dev/reference/arkui-ts/ts-container-sidebarcontainer.md
+5
-0
zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md
...cation-dev/reference/arkui-ts/ts-motion-path-animation.md
+3
-2
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md
...n-dev/reference/arkui-ts/ts-universal-attributes-focus.md
+1
-1
zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-configuration.md
...e/js-service-widget-ui/js-service-widget-configuration.md
+2
-0
zh-cn/application-dev/ui/ui-js-animate-component.md
zh-cn/application-dev/ui/ui-js-animate-component.md
+1
-1
zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md
...cation-dev/ui/ui-ts-page-redirection-data-transmission.md
+3
-3
未找到文件。
zh-cn/application-dev/reference/arkui-js/js-components-basic-select.md
浏览文件 @
7a4f4d87
# 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
)
指定的字体样式,会被选中作为当前文本的字体样式。
<br/>
默认值: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
zh-cn/application-dev/reference/arkui-js/js-components-common-animation.md
浏览文件 @
7a4f4d87
# 动画样式
> **说明:**
>
> 从API version 4开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
组件支持动态的旋转、平移、缩放效果,可在style或css中设置。
...
...
zh-cn/application-dev/reference/arkui-js/js-components-custom-events.md
浏览文件 @
7a4f4d87
...
...
@@ -72,3 +72,5 @@ export default {
textClicked
()
{},
}
```
其他相关说明详见:
[
基本用法
](
./js-components-custom-basic-usage.md
)
。
\ No newline at end of file
zh-cn/application-dev/reference/arkui-ts/figures/zh-cn_image_0000001174104386.gif
查看替换文件 @
ca7d5033
浏览文件 @
7a4f4d87
1.1 MB
|
W:
|
H:
88.8 KB
|
W:
|
H:
2-up
Swipe
Onion skin
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md
浏览文件 @
7a4f4d87
...
...
@@ -6,11 +6,6 @@
> 该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
无
...
...
@@ -22,15 +17,11 @@ LoadingProgress()
创建加载进展组件。
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| - | 设置加载进度条前景色。 |
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| color |
[
ResourceColor
](
../../ui/ts-types.md
)
| 设置加载进度条前景色。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md
浏览文件 @
7a4f4d87
# 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 | 否 | 滚动动画文本滚动步长。
<br/>
默认值:6vp |
| loop | number | 否 | 设置重复滚动的次数,小于等于零时无限循环。
<br/>
默认值:-1 |
| fromStart | boolean | 否 | 设置文本从头开始滚动或反向滚动。
<br/>
默认值:true |
| src | string | 是 | 需要滚动的文本。 |
## 属性
| 名称 | 参数类型 | 描述 |
| ---------- | -------- | ------------------------------------ |
| allowScale | boolean | 是否允许文本缩放。
<br/>
默认值:false |
## 事件
| 名称 | 功能描述 |
| 名称 | 功能描述 |
| -------- | -------- |
| onStart(event:
()
=
>
void) | 开始滚动时触发回调。 |
| onBounce(event:
()
=
>
void) |
滚动到底时触发回调。 |
| onFinish(event:
()
=
>
void) | 滚动
完成时触发回调。 |
| onStart(event:
()
=
>
void) | 开始滚动时触发回调。 |
| onBounce(event:
()
=
>
void) |
完成一次滚动时触发,若循环次数不为1,则该事件会多次触发。 |
| onFinish(event:
()
=
>
void) | 滚动
全部循环次数完成时触发回调。 |
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md
浏览文件 @
7a4f4d87
# Grid
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
网格容器,由“行”和“列”分割的单元格所组成,通过指定“项目”所在的单元格做出各种各样的布局。
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -18,30 +17,31 @@
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 | number
\|
string | - | 设置滚动条的宽度。 |
| cachedCount | number | 1 | 设置预加载的GridItem的数量。具体使用可参考
[
减少应用白块说明
](
../../ui/ts-performance-improvement-recommendation.md#减少应用滑动白块
)
。 |
| editMode
<sup>
8+
</sup>
| boolean | false | 是否进入编辑模式,进入编辑模式可以拖拽Grid组件内部
[
GridItem
](
ts-container-griditem.md
)
。 |
| layoutDirection
<sup>
8+
</sup>
|
[
GridDirection
](
#griddirection8枚举说明
)
| GridDirection.Row | 设置布局的主轴方向。 |
| maxCount
<sup>
8+
</sup>
| number | 1 | 当layoutDirection是Row/RowReverse时,表示可显示的最大行数
<br/>
当layoutDirection是Column/ColumnReverse时,表示可显示的最大列数。 |
| minCount
<sup>
8+
</sup>
| number | 1 | 当layoutDirection是Row/RowReverse时,表示可显示的最小行数。
<br/>
当layoutDirection是Column/ColumnReverse时,表示可显示的最小列数。 |
| cellLength
<sup>
8+
</sup>
| number | 0 | 当layoutDirection是Row/RowReverse时,表示一行的高度。
<br/>
当layoutDirection是Column/ColumnReverse时,表示一列的宽度。 |
| multiSelectable
<sup>
8+
</sup>
| boolean | false | 是否开启鼠标框选。
<br/>
-
false:关闭框选。
<br/>
-
true:开启框选。 |
| supportAnimation
<sup>
8+
</sup>
| boolean | false | 是否支持动画。 |
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| columnsTemplate | string | 设置当前网格布局列的数量,不设置时默认1列。
<br/>
例如,
'1fr
1fr
2fr'
是将父组件分3列,将父组件允许的宽分为4等份,第一列占1份,第二列占1份,第三列占2份。
<br/>
默认值:'1fr' |
| rowsTemplate | string | 设置当前网格布局行的数量,不设置时默认1行。
<br/>
例如,
'1fr
1fr
2fr'是将父组件分三行,将父组件允许的高分为4等份,第一行占1份,第二行占一份,第三行占2份。
<br/>
默认值:'1fr' |
| columnsGap | Length | 设置列与列的间距。
<br/>
默认值:0 |
| rowsGap | Length | 设置行与行的间距。
<br/>
默认值:0 |
| scrollBar |
[
BarState
](
ts-appendix-enums.md#barstate
)
| 设置滚动条状态。
<br/>
默认值:BarState.Off |
| scrollBarColor | string
\|
number
\|
Color | 设置滚动条的颜色。 |
| scrollBarWidth | string
\|
number | 设置滚动条的宽度。 |
| cachedCount | number | 设置预加载的GridItem的数量。具体使用可参考
[
减少应用白块说明
](
../../ui/ts-performance-improvement-recommendation.md#减少应用滑动白块
)
。
<br/>
默认值:1 |
| editMode
<sup>
8+
</sup>
| boolean | 设置Grid是否进入编辑模式,进入编辑模式可以拖拽Grid组件内部
[
GridItem
](
ts-container-griditem.md
)
。
<br/>
默认值:flase |
| layoutDirection
<sup>
8+
</sup>
|
[
GridDirection
](
#griddirection8枚举说明
)
| 设置布局的主轴方向。
<br/>
默认值:GridDirection.Row |
| maxCount
<sup>
8+
</sup>
| number | 当layoutDirection是Row/RowReverse时,表示可显示的最大行数
<br/>
当layoutDirection是Column/ColumnReverse时,表示可显示的最大列数。
<br/>
默认值:1 |
| minCount
<sup>
8+
</sup>
| number | 当layoutDirection是Row/RowReverse时,表示可显示的最小行数。
<br/>
当layoutDirection是Column/ColumnReverse时,表示可显示的最小列数。
<br/>
默认值:1 |
| cellLength
<sup>
8+
</sup>
| number | 当layoutDirection是Row/RowReverse时,表示一行的高度。
<br/>
当layoutDirection是Column/ColumnReverse时,表示一列的宽度。
<br/>
默认值:0 |
| multiSelectable
<sup>
8+
</sup>
| boolean | 是否开启鼠标框选。
<br/>
默认值:false
<br/>
-
false:关闭框选。
<br/>
-
true:开启框选。 |
| supportAnimation
<sup>
8+
</sup>
| boolean | 是否支持动画。
<br/>
默认值:false |
## GridDirection<sup>8+</sup>枚举说明
...
...
@@ -54,14 +54,16 @@ Grid(scroller?: Scroller)
## 事件
除支持
[
通用事件
](
ts-universal-events-click.md
)
外,还支持以下事件:
| 名称 | 功能描述 |
| -------- | -------- |
| onScrollIndex(event: (first: number) => void) | 当前网格显示的起始位置item发生变化时触发
,返回值为
当前显示的网格起始位置的索引值。 |
| 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为
是否成功释放。 |
| onScrollIndex(event: (first: number) => void) | 当前网格显示的起始位置item发生变化时触发
。
<br/>
- first:
当前显示的网格起始位置的索引值。 |
| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any)
\|
void) | 开始拖拽网格元素时触发
。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
#itemdraginfo对象说明
)
。
<br/>
- itemIndex:
被拖拽网格元素索引值。 |
| onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入网格元素范围内时触发
。
<br/>
- event:
见
[
ItemDragInfo对象说明
](
#itemdraginfo对象说明
)
。 |
| onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void) | 拖拽在网格元素范围内移动时触发
。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
#itemdraginfo对象说明
)
。
<br/>
- itemIndex: 拖拽起始位置。
<br/>
- insertIndex:
拖拽插入位置。 |
| onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void) | 拖拽离开网格元素时触发
。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
#itemdraginfo对象说明
)
。
<br/>
- itemIndex:
拖拽离开的网格元素索引值。 |
| onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void) | 绑定该事件的网格元素可作为拖拽释放目标,当在网格元素内停止拖拽时触发
。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
#itemdraginfo对象说明
)
。
<br/>
- itemIndex: 拖拽起始位置。
<br/>
- insertIndex: 拖拽插入位置。
<br/>
- isSuccess:
是否成功释放。 |
## ItemDragInfo对象说明
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-gridcol.md
浏览文件 @
7a4f4d87
...
...
@@ -6,31 +6,28 @@
>
> 该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
可以包含单个子组件。
## 接口
GridCol(option?: {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表示该元素不参与布局计算,即不会被渲染。
<br/>
默认值:1。 |
| offset | number
\|
GridColColumnOption | 否 | 相对于前一个栅格子组件偏移的列数。
<br/>
默认值:0。 |
| order | number
\|
GridColColumnOption | 否 | 元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
<br/>
默认值:0。 |
**参数**
:
| 参数名 |类型|必填|说明
|-----|-----|-----|----|
|span| number
\|
GridColColumnOption | 否 |占用列数。span为0,意味着该元素不参与布局计算,即不会被渲染。
<br>
默认值:1。|
|offset|number
\|
GridColColumnOption| 否 |相对于前一个栅格子组件偏移的列数。
<br>
默认值:0。|
|order|number
\|
GridColColumnOption| 否 |元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
<br>
默认值:0。|
## 属性
| 名称 |类型|说明
|-----|-----|----|
|span| number
\|
GridColColumnOption |占用列数。span为0,意味着该元素不参与布局计算,即不会被渲染。
<br>
默认值:1。|
|offset|number
\|
GridColColumnOption| 相对于前一个栅格子组件偏移的列数。
<br>
默认值:0。|
|order|number
\|
GridColColumnOption|元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
<br>
默认值:0。|
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------- | ---- | ------------------------------------------------------------ |
| span | number
\|
GridColColumnOption | 否 | 占用列数。span为0,意味着该元素不参与布局计算,即不会被渲染。
<br/>
默认值:1。 |
| offset | number
\|
GridColColumnOption | 否 | 相对于前一个栅格子组件偏移的列数。
<br/>
默认值:0。 |
| order | number
\|
GridColColumnOption | 否 | 元素的序号,根据栅格子组件的序号,从小到大对栅格子组件做排序。
<br/>
默认值:0。 |
## GridColColumnOption
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-gridcontainer.md
浏览文件 @
7a4f4d87
# GridContainer
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
纵向排布栅格布局容器,仅在栅格布局场景中使用。
## 权限列表
无
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -19,24 +14,26 @@
## 接口
GridContainer(value?: { 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' | 否 | 设置当前布局总列数。
<br/>
默认值:'auto' |
| sizeType | SizeType | 否 | 选用设备宽度类型。
<br/>
默认值:SizeType.Auto |
| gutter | number
\|
string | 否 | 栅格布局列间距。 |
| margin | number
\|
string | 否 | 栅格布局两侧间距。 |
## SizeType枚举说明
| 名称 | 描述 |
| -------- | -------- |
| XS | 最小宽度类型设备。 |
| SM | 小宽度类型设备。 |
| MD | 中等宽度类型设备。 |
| LG | 大宽度类型设备。 |
| Auto | 根据设备类型进行选择。 |
## 属性
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md
浏览文件 @
7a4f4d87
# GridItem
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
网格容器中单项内容容器。
## 权限列表
无
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -24,14 +19,14 @@ GridItem()
## 属性
| 名称 | 参数类型 |
默认值 |
描述 |
| -------- | -------- | -------- |
-------- |
| rowStart | number |
- | 用于
指定当前元素起始行号。 |
| rowEnd | number |
- | 用于
指定当前元素终点行号。 |
| columnStart | number |
- | 用于
指定当前元素起始列号。 |
| columnEnd | number |
- | 用于
指定当前元素终点列号。 |
| forceRebuild | boolean |
false | 用于设置在触发组件build时是否重新创建此节点。
|
| selectable
<sup>
8+
</sup>
| boolean |
true | 当前GridItem元素是否可以被鼠标框选。
<br/>
>
**说明:**
<br/>
>
外层Grid容器的鼠标框选开启时,GridItem的框选才生效。
|
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| rowStart | number | 指定当前元素起始行号。 |
| rowEnd | number | 指定当前元素终点行号。 |
| columnStart | number | 指定当前元素起始列号。 |
| columnEnd | number | 指定当前元素终点列号。 |
| forceRebuild | boolean |
设置在触发组件build时是否重新创建此节点。
<br/>
默认值:false
|
| selectable
<sup>
8+
</sup>
| boolean |
当前GridItem元素是否可以被鼠标框选。
<br/>
>
**说明:**
<br/>
>
外层Grid容器的鼠标框选开启时,GridItem的框选才生效。
<br/>
默认值:true
|
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-gridrow.md
浏览文件 @
7a4f4d87
...
...
@@ -7,13 +7,6 @@
> 该组件从API Version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 权限列表
无
## 子组件
可以包含GridCol子组件。
...
...
@@ -27,7 +20,7 @@ GridRow(option?: {columns?: number | GridRowColumnOption, gutter?: Length | Gutt
|-----|-----|----|----|
|gutter|Length
\|
GutterOption| 否 |栅格布局间距,x代表水平方向。|
|columns| number
\|
GridRowColumnOption | 否 |设置布局列数。|
|breakpoints|BreakPoints| 否 |
用于
设置断点值的断点数列以及基于窗口或容器尺寸的相应参照。|
|breakpoints|BreakPoints| 否 |设置断点值的断点数列以及基于窗口或容器尺寸的相应参照。|
|direction|GridRowDirection| 否 |栅格布局排列方向。|
## GutterOption
...
...
@@ -67,8 +60,8 @@ GridRow(option?: {columns?: number | GridRowColumnOption, gutter?: Length | Gutt
| 参数名 | 参数类型 | 必填 | 参数描述 |
| ----- | ------ | ---- | ---------------------------------------- |
| value | Array
<string>
| 否 | 用于
设置断点位置的单调递增数组。
<br>
默认值:["320vp", "520vp", "840vp"] |
| reference | BreakpointsReference | 否 |
- | 竖直gutter option。
|
| value | Array
<
string
>
| 否 |
设置断点位置的单调递增数组。
<br>
默认值:["320vp", "520vp", "840vp"] |
| reference | BreakpointsReference | 否 |
竖直gutter option。
|
```
ts
// 启用xs、sm、md共3个断点
breakpoints
:
{
value
:
[
"
100vp
"
,
"
200vp
"
]}
...
...
@@ -131,8 +124,6 @@ onBreakpointChange(callback: (breakpoints: string) => void)
| ----- | ------ | ---- | ---------------------------------------- |
|breakpoints| string |是|断点发生变化时触发回调
<br>
取值为
`"xs"`
、
`"sm"`
、
`"md"`
、
`"lg"`
、
`"xl"`
、
`"xxl"`
。|
## 示例
```
ts
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
浏览文件 @
7a4f4d87
# List
列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。
> **说明:**
>
> - 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
> - 该组件回弹的前提是要有滚动。内容小于一屏时,没有回弹效果。
列表包含一系列相同宽度的列表项。适合连续、多行呈现同类数据,例如图片和文本。
## 子组件
包含
[
ListItem
](
ts-container-listitem.md
)
、
[
ListItemGroup
](
ts-container-listitemgroup.md
)
子组件。
...
...
@@ -17,49 +15,49 @@
## 接口
List(value?:
{initialIndex?: number, space?: number | string
, scroller?: Scroller})
List(value?:
{space?: number
|
string, initialIndex?: number
, scroller?: Scroller})
-
参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| initialIndex | number | 否 | 0 | 设置当前List初次加载时视口起始位置显示的item,即显示第一个item,如设置的序号超过了最后一个item的序号,则设置不生效。 |
| space | number
\|
string | 否 | 0 | 列表项间距。 |
| scroller |
[
Scroller
](
ts-container-scroll.md#scroller
)
| 否 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 |
**参数:**
| 参数名 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| space | number
\|
string | 否 | 列表项间距。
<br/>
默认值:0 |
| initialIndex | number | 否 | 设置当前List初次加载时视口起始位置显示的item的索引值。如果设置的值超过了当前List最后一个item的索引值,则设置不生效。
<br/>
默认值:0 |
| scroller |
[
Scroller
](
ts-container-scroll.md#scroller
)
| 否 | 可滚动组件的控制器。用于与可滚动组件进行绑定。 |
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| listDirection |
[
Axis
](
ts-appendix-enums.md#axis
)
| Axis.Vertical | 设置List组件排列方向参照Axis枚举说明。 |
| divider | {
<br/>
strokeWidth:
Length,
<br/>
color?:[ResourceColor](../../ui/ts-types.md),
<br/>
startMargin?:
Length,
<br/>
endMargin?:
Length
<br/>
} | - | 用于设置ListItem分割线样式,默认无分割线。
<br/>
strokeWidth:
分割线的线宽。
<br/>
color:
分割线的颜色。
<br/>
startMargin:
分割线距离列表侧边起始端的距离。
<br/>
endMargin:
分割线距离列表侧边结束端的距离。 |
| scrollBar |
[
BarState
](
ts-appendix-enums.md#barstate
)
| BarState.Off | 设置滚动条状态。 |
| cachedCount | number | 1 | 设置预加载的ListItem的数量。具体使用可参考
[
减少应用白块说明
](
../../ui/ts-performance-improvement-recommendation.md#减少应用滑动白块
)
。 |
| editMode | boolean | false | 声明当前List组件是否处于可编辑模式。 |
| edgeEffect |
[
EdgeEffect
](
ts-appendix-enums.md#edgeeffect
)
| EdgeEffect.Spring | 滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。 |
| chainAnimation | boolean | false | 用于设置当前list是否启用链式联动动效,开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果:List内的ListItem或ListItemGroup间隔一定距离,在基本的滑动交互行为下,主动对象驱动从动对象进行联动,驱动效果遵循弹簧物理动效。其中ListItemGroup以一个整体参与链式联动动效,ListItemGroup内的ListITem不参与链式联动动效。
<br/>
-
false:不启用链式联动。
<br/>
-
true:启用链式联动。 |
| multiSelectable
<sup>
8+
</sup>
| boolean | false | 是否开启鼠标框选。
<br/>
-
false:关闭框选。
<br/>
-
true:开启框选。 |
| lanes
<sup>
9+
</sup>
| number
\|
<br>
{
<br/>
minLength: Length,
<br/>
maxLength: Length
<br/>
} | 1 | 以列模式为例(listDirection为Axis.Vertical):
<br/>
lanes用于决定List组件在交叉轴方向按几列布局,规则如下:
<br/>
- lanes为指定的数量时,根据指定的数量与List组件的交叉轴宽度来决定每列的宽度;
<br/>
- lane设置了{minLength,maxLength}时,根据List组件的宽度自适应决定lanes数量(即列数),保证缩放过程中lane的宽度符合{minLength,maxLength}的限制。其中,minLength条件会被优先满足,即优先保证符合ListItem的宽度符合最小宽度限制。例如在列模式下,设置了{minLength: 40vp,maxLength: 60vp},则当List组件宽度为70vp时,ListItem为一列,并且根据alignListItem属性做靠左、居中或者靠右布局;当List组件宽度变化至80vp时,符合两倍的minLength,则ListItem自适应为两列。 |
| alignListItem
<sup>
9+
</sup>
|
[
ListItemAlign
](
#listitemalign9枚举说明
)
| ListItemAlign.Center | List交叉轴方向宽度大于ListItem交叉轴宽度
*
lanes时,ListItem在List交叉轴方向的布局方式,默认为居中。 |
| sticky
<sup>
9+
</sup>
|
[
StickyStyle
](
#stickystyle9枚举说明
)
| StickyStyle.None | 配合
[
ListItemGroup
](
ts-container-listitemgroup.md
)
组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底,参见StickyStyle的枚举说明。|
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| listDirection |
[
Axis
](
ts-appendix-enums.md#axis
)
| 设置List组件排列方向。
<br/>
默认值:Axis.Vertical |
| divider | {
<br/>
strokeWidth:
[Length](../../ui/ts-types.md#length),
<br/>
color?:[ResourceColor](../../ui/ts-types.md),
<br/>
startMargin?:
Length,
<br/>
endMargin?:
Length
<br/>
}
\|
null | 设置ListItem分割线样式,默认无分割线。
<br/>
- strokeWidth:
分割线的线宽。
<br/>
- color:
分割线的颜色。
<br/>
- startMargin:
分割线与列表侧边起始端的距离。
<br/>
- endMargin:
分割线与列表侧边结束端的距离。 |
| scrollBar |
[
BarState
](
ts-appendix-enums.md#barstate
)
| 设置滚动条状态。
<br/>
默认值:BarState.Off |
| cachedCount | number | 设置预加载的ListItem数量。具体使用可参考
[
减少应用白块说明
](
../../ui/ts-performance-improvement-recommendation.md#减少应用滑动白块
)
。
<br/>
默认值:1 |
| editMode | boolean | 声明当前List组件是否处于可编辑模式。
<br/>
默认值:false |
| edgeEffect |
[
EdgeEffect
](
ts-appendix-enums.md#edgeeffect
)
| 设置组件的滑动效果。
<br/>
默认值:EdgeEffect.Spring |
| chainAnimation | boolean | 设置当前List是否启用链式联动动效,开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果:List内的list-item间隔一定距离,在基本的滑动交互行为下,主动对象驱动从动对象进行联动,驱动效果遵循弹簧物理动效。
<br/>
默认值:false
<br/>
-
false:不启用链式联动。
<br/>
-
true:启用链式联动。 |
| multiSelectable
<sup>
8+
</sup>
| boolean | 是否开启鼠标框选。
<br/>
默认值:false
<br/>
-
false:关闭框选。
<br/>
-
true:开启框选。 |
| lanes
<sup>
9+
</sup>
| number
\|
[
LengthConstrain
](
../../ui/ts-types.md#lengthconstrain
)
| 以列模式为例(listDirection为Axis.Vertical):
<br/>
lanes用于决定List组件在交叉轴方向按几列布局。
<br/>
默认值:1
<br/>
规则如下:
<br/>
- lanes为指定的数量时,根据指定的数量与List组件的交叉轴宽度来决定每列的宽度;
<br/>
- lane设置了{minLength,maxLength}时,根据List组件的宽度自适应决定lanes数量(即列数),保证缩放过程中lane的宽度符合{minLength,maxLength}的限制。其中,minLength条件会被优先满足,即优先保证符合ListItem的宽度符合最小宽度限制。例如在列模式下,设置了{minLength: 40vp,maxLength: 60vp},则当List组件宽度为70vp时,ListItem为一列,并且根据alignListItem属性做靠左、居中或者靠右布局;当List组件宽度变化至80vp时,符合两倍的minLength,则ListItem自适应为两列。 |
| alignListItem
<sup>
9+
</sup>
| ListItemAlign | List交叉轴方向宽度大于ListItem交叉轴宽度
*
lanes时,ListItem在List交叉轴方向的布局方式,默认为居中。
<br/>
默认值:ListItemAlign.Center |
| sticky
<sup>
9+
</sup>
| StickyStyle | 配合
[
ListItemGroup
](
ts-container-listitemgroup.md
)
组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底。
<br/>
默认值:StickyStyle.None
<br/>
**说明:**
<br/>
sticky属性可以设置为 StickyStyle.Header
\|
StickyStyle.Footer 以同时支持header吸顶和footer吸底。 |
## ListItemAlign<sup>9+</sup>枚举说明
| 名称 | 描述 |
| ------ | -------------------------------------- |
| Start | ListItem在List中,交叉轴方向首部对齐。 |
| Center | ListItem在List中,交叉轴方向居中对齐。 |
| End | ListItem在List中,交叉轴方向尾部对齐。 |
| 名称 | 描述 |
| ------ | -------------------------------------- |
| Start | ListItem在List中,交叉轴方向首部对齐。 |
| Center | ListItem在List中,交叉轴方向居中对齐。 |
| End | ListItem在List中,交叉轴方向尾部对齐。 |
## StickyStyle<sup>9+</sup>枚举说明
| 名称 | 描述 |
| ------ | -------------------------------------- |
| None | ListItemGroup的header不吸顶,footer不吸底。 |
| Header | ListItemGroup的header吸顶。 |
| Footer | ListItemGroup的footer吸底。 |
sticky属性可以设置为 StickyStyle.Header | StickyStyle.Footer 以同时支持header吸顶和footer吸底。
| 名称 | 描述 |
| ------ | -------------------------------------- |
| None | ListItemGroup的header不吸顶,footer不吸底。 |
| Header | ListItemGroup的header吸顶。 |
| Footer | ListItemGroup的footer吸底。 |
...
...
@@ -67,19 +65,19 @@ List(value?: {initialIndex?: number, space?: number | string, scroller?: Scrolle
| 名称 | 功能描述 |
| -------- | -------- |
| onItemDelete(event: (index: number) => boolean) | 当List组件在编辑模式时,点击ListItem右边出现的删除按钮时触发。
|
| onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void) | 列表滑动时触发
,返回值scrollOffset为滑动偏移量,
[
scrollState
](
#scrollstate枚举说明
)
为
当前滑动状态。 |
| onScrollIndex(event: (start: number, end: number) => void) | 列表滑动时触发
,返回值分别为滑动起始位置索引值与滑动结束位置索引值。计算索引值时,ListItemGroup作为一个整体占一个索引值,不计算ListItemGroup内部ListItem的
索引值。 |
| onItemDelete(event: (index: number) => boolean) | 当List组件在编辑模式时,点击ListItem右边出现的删除按钮时触发。
<br/>
- index: 被删除的列表项的索引值。
|
| onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void) | 列表滑动时触发
。
<br/>
- scrollOffset: 滑动偏移量。
<br/>
-
[
scrollState
](
#scrollstate枚举说明
)
:
当前滑动状态。 |
| onScrollIndex(event: (start: number, end: number) => void) | 列表滑动时触发
。
<br/>
计算索引值时,ListItemGroup作为一个整体占一个索引值,不计算ListItemGroup内部ListItem的索引值。
<br/>
- start: 滑动起始位置索引值。
<br/>
- end: 滑动结束位置
索引值。 |
| onReachStart(event: () => void) | 列表到达起始位置时触发。 |
| onReachEnd(event: () => void) | 列表到底末尾位置时触发。 |
| onScrollBegin
<sup>
9+
</sup>
(event: (dx: number, dy: number) => { dxRemain: number, dyRemain: number }) | 列表开始滑动时触发。
<br/>
\-
dx:即将发生的水平方向滚动量。
<br/>
\-
dy:即将发生的竖直方向滚动量。
<br/>
- dxRemain:水平方向滚动剩余量。
<br/>
\-
dyRemain:竖直方向滚动剩余量。 |
| onScrollStop(event: () => void) | 列表滑动停止时触发。 |
| 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对象说明
](
ts-container-grid.md#itemdraginfo对象说明
)
,itemIndex为拖拽起始位置,insertIndex为拖拽插入位置,isSuccess为是否成功释放。 |
| onItemMove(event: (from: number, to: number) => boolean) | 列表元素发生移动时触发。
<br/>
- from: 移动前索引值。
<br/>
- to: 移动后索引值。 |
| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any)
\|
void) | 开始拖拽列表元素时触发。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
ts-container-grid.md#itemdraginfo对象说明
)
。
<br/>
- itemIndex: 被拖拽列表元素索引值。 |
| onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入列表元素范围内时触发。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
ts-container-grid.md#itemdraginfo对象说明
)
。 |
| onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void) | 拖拽在列表元素范围内移动时触发。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
ts-container-grid.md#itemdraginfo对象说明
)
。
<br/>
- itemIndex: 拖拽起始位置。
<br/>
- insertIndex: 拖拽插入位置。 |
| onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void) | 拖拽离开列表元素时触发。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
ts-container-grid.md#itemdraginfo对象说明
)
。
<br/>
- itemIndex: 拖拽离开的列表元素索引值。 |
| onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void) | 绑定该事件的列表元素可作为拖拽释放目标,当在列表元素内停止拖拽时触发。
<br/>
- event: 见
[
ItemDragInfo对象说明
](
ts-container-grid.md#itemdraginfo对象说明
)
。
<br/>
- itemIndex: 拖拽起始位置。
<br/>
- insertIndex: 拖拽插入位置。
<br/>
- isSuccess: 是否成功释放。 |
## ScrollState枚举说明
...
...
@@ -90,20 +88,21 @@ List(value?: {initialIndex?: number, space?: number | string, scroller?: Scrolle
| Fling | 手指拖动状态。 |
> **说明:**
> List使能可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件:
>
>
- editMode属性设置为true。
>
要使List处于可编辑模式需配合onItemDelete事件和ListItem的editable属性,即可编辑模式实现删除列表项功能,需满足以下条件:
>
>
- 绑定onItemDelete事件,且事件回调返回
true。
>
- editMode属性设置为
true。
>
>
- ListItem的editable属性设置为
true。
>
- 绑定onItemDelete事件,且事件回调返回
true。
>
>
实现ListItem拖拽,需满足以下条件:
>
- ListItem的editable属性设置为true。
>
>
- editMode属性设置为true。
>
实现ListItem拖拽,需满足以下条件:
>
>
- 绑定onDragStart事件,且事件回调中返回浮动UI布局
。
>
- editMode属性设置为true
。
>
> - 绑定onDragStart事件,且事件回调中返回浮动UI布局。
## 示例
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md
浏览文件 @
7a4f4d87
# ListItem
> **说明:**
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
用来展示列表具体item,宽度默认充满List组件,必须配合List来使用。
> **说明:**
>
> 该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
## 子组件
...
...
@@ -16,24 +14,25 @@
## 接口
ListItem()
ListItem(value?: string)
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| sticky |
[
Sticky
](
#sticky枚举说明
)
| Sticky.None | 设置ListItem吸顶效果。 |
| editable | boolean
\|
[
EditMode
](
#editmode枚举说明
)
| false | 当前ListItem元素是否可编辑,进入编辑模式后可删除或移动。 |
| selectable
<sup>
8+
</sup>
| boolean | true | 当前ListItem元素是否可以被鼠标框选。
<br/>
>
**说明:**
<br/>
>
外层List容器的鼠标框选开启时,ListItem的框选才生效。 |
| swipeAction
<sup>
9+
</sup>
| {
<br/>
start?:
CustomBuilder,
<br/>
end?:CustomBuilder,
<br/>
edgeEffect?:
[
SwipeEdgeEffect
](
#swipeedgeeffect9枚举说明
)
,
<br/>
} | - | 用于设置ListItem的划出组件。
<br/>
start:
ListItem向右划动时item左边的组件(List垂直布局时)或ListItem向下划动时item上方的组件(List水平布局时)。
<br/>
end:
ListItem向左划动时item右边的组件(List垂直布局时)或ListItem向上划动时item下方的组件(List水平布局时)。
<br/>
edgeEffect:
滑动效果。
<br/>
|
除支持
[
通用属性
](
ts-universal-attributes-size.md
)
外,还支持以下属性:
| 名称 | 参数类型 | 描述 |
| -------- | -------- | -------- |
| sticky |
[
Sticky
](
#sticky枚举说明
)
| 设置ListItem吸顶效果。
<br/>
默认值:Sticky.None |
| editable | boolean
\|
[
EditMode
](
#editmode枚举说明
)
| 当前ListItem元素是否可编辑,进入编辑模式后可删除或移动列表项。
<br/>
默认值:false |
| selectable
<sup>
8+
</sup>
| boolean | 当前ListItem元素是否可以被鼠标框选。
<br/>
**说明:**
<br/>
外层List容器的鼠标框选开启时,ListItem的框选才生效。
<br/>
默认值:true |
| swipeAction
<sup>
9+
</sup>
| {
<br/>
start?:
CustomBuilder,
<br/>
end?:CustomBuilder,
<br/>
edgeEffect?:
[
SwipeEdgeEffect
](
#swipeedgeeffect9枚举说明
)
,
<br/>
} | 用于设置ListItem的划出组件。
<br/>
- start:
ListItem向右划动时item左边的组件(List垂直布局时)或ListItem向下划动时item上方的组件(List水平布局时)。
<br/>
- end:
ListItem向左划动时item右边的组件(List垂直布局时)或ListItem向上划动时item下方的组件(List水平布局时)。
<br/>
- edgeEffect:
滑动效果。
<br/>
|
## Sticky枚举说明
| 名称 | 描述 |
| -------- | -------- |
| None | 无吸顶效果。 |
| Normal | 当前item吸顶。 |
| Opacity | 当前item吸顶显示透明度变化效果。 |
| 名称 | 描述 |
| -------- | -------- |
| None | 无吸顶效果。 |
| Normal | 当前item吸顶。 |
| Opacity | 当前item吸顶显示透明度变化效果。 |
## EditMode枚举说明
...
...
@@ -44,10 +43,10 @@ ListItem()
| Movable | 可移动。 |
## SwipeEdgeEffect<sup>9+</sup>枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Spring | ListItem划动距离超过划出组件大小后可以继续划动,松手后按照弹簧阻尼曲线回弹。 |
| None | ListItem划动距离不能超过划出组件大小。 |
| 名称 | 描述 |
| -------- | -------- |
| Spring | ListItem划动距离超过划出组件大小后可以继续划动,松手后按照弹簧阻尼曲线回弹。 |
| None | ListItem划动距离不能超过划出组件大小。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md
浏览文件 @
7a4f4d87
...
...
@@ -17,7 +17,7 @@
## 接口
ListItemGroup(options?: {header?: CustomBuilder, footer?: CustomBuilder, space?: number | string}
}
)
ListItemGroup(options?: {header?: CustomBuilder, footer?: CustomBuilder, space?: number | string})
**参数:**
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md
浏览文件 @
7a4f4d87
# 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 | 设置滚动方法。
<br/>
默认值:ScrollDirection.Vertical |
| scrollBar |
[
BarState
](
ts-appendix-enums.md#barstate
)
| 设置滚动条状态。
<br/>
默认值:BarState.Off |
| scrollBarColor | string
\|
number
\|
Color | 设置滚动条的颜色。 |
| scrollBarWidth | string
\|
number | 设置滚动条的宽度。 |
| edgeEffect |
[
EdgeEffect
](
#edgeeffect
)
| 设置滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。
<br/>
默认值:EdgeEffect.Spring |
## ScrollDirection枚举说明
| 名称 | 描述 |
| ---------- | ---------- |
| Horizontal | 仅支持水平方向滚动。 |
| Vertical | 仅支持竖直方向滚动。 |
| None | 不可滚动。 |
| 名称 | 描述 |
| ---------- | ------------------------ |
| Horizontal | 仅支持水平方向滚动。 |
| Vertical | 仅支持竖直方向滚动。 |
| None | 不可滚动。 |
| Free | 支持竖直或水平方向滚动。 |
## EdgeEffect枚举说明
...
...
@@ -51,15 +47,16 @@ Scroll(scroller?: Scroller)
## 事件
| 名称
| 功能描述
|
| ----------------------------------------
|
----------------------------- |
| onScrollBegin
<sup>
9+
</sup>
(
dx: number, dy: number)
=
>
{ dxRemain: number, dyRemain: number } | 滚动开始事件回调。
<br>
参数:
<br>
- dx:即将发生的水平方向滚动量。
<br>
- dy:即将发生的竖向
方向滚动量。
<br>
返回值:
<br>
- dxRemain:水平方向滚动剩余量。
<br>
- dyRemain:竖直方向滚动剩余量。 |
| onScroll(event: (xOffset: number, yOffset: number) => void)
| 滚动事件回调,
返回滚动时水平、竖直方向偏移量。
|
| onScrollEdge(event: (side: Edge) => void)
| 滚动到边缘事件回调。
|
| onScrollEnd(event: () => void)
| 滚动停止事件回调。
|
| 名称
| 功能描述
|
| ----------------------------------------
-------------------- | -------------------------------
----------------------------- |
| onScrollBegin
<sup>
9+
</sup>
(
event: (dx: number, dy: number) => { dxRemain: number, dyRemain: number }) | 滚动开始事件回调。
<br>
参数:
<br>
- dx:即将发生的水平方向滚动量。
<br>
- dy:即将发生的竖直
方向滚动量。
<br>
返回值:
<br>
- dxRemain:水平方向滚动剩余量。
<br>
- 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 | {
<br/>
duration:
number,
<br/>
curve:
[Curve](ts-animatorproperty.md)
\|
<br/>
CubicBezier
\|
<br/>
SpringCurve
<br/>
} | 否 | | 动画配置:
<br/>
-
duration:
滚动时长设置。
<br/>
-
curve:
滚动曲线设置。 |
| 参数名 | 参数类型 | 必填 | 参数描述 |
| --------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| xOffset | Length | 是 | 水平滑动偏移。 |
| yOffset | Length | 是 | 竖直滑动偏移。 |
| animation | {
<br/>
duration:
number,
<br/>
curve:
[Curve](ts-animatorproperty.md)
\|
<br/>
CubicBezier
\|
<br/>
SpringCurve
<br/>
} | 否 | 动画配置:
<br/>
-
duration:
滚动时长设置。
<br/>
-
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()
返回当前的滚动偏移量。
**返回值**
-
返回值
| 类型 | 描述 |
| ---------------------------------------- | ---------------------------------------- |
| {
<br/>
xOffset:
number,
<br/>
yOffset:
number
<br/>
} | xOffset:
水平滑动偏移;
<br/>
yOffset:
竖直滑动偏移。 |
| 类型 | 描述 |
| ---------------------------------------- | ---------------------------------------- |
| {
<br/>
xOffset:
number,
<br/>
yOffset:
number
<br/>
} | xOffset:
水平滑动偏移;
<br/>
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
:
1
0
,
left
:
20
})
.
margin
({
top
:
6
0
,
left
:
20
})
Button
(
'
back top
'
)
.
onClick
(()
=>
{
// 点击后回到顶部
this
.
scroller
.
scrollEdge
(
Edge
.
Top
)
})
.
margin
({
top
:
6
0
,
left
:
20
})
.
margin
({
top
:
11
0
,
left
:
20
})
Button
(
'
next page
'
)
.
onClick
(()
=>
{
// 点击后
下滑到底部
.
onClick
(()
=>
{
// 点击后
滑到下一页
this
.
scroller
.
scrollPage
({
next
:
true
})
})
.
margin
({
top
:
1
1
0
,
left
:
20
})
.
margin
({
top
:
1
7
0
,
left
:
20
})
}.
width
(
'
100%
'
).
height
(
'
100%
'
).
backgroundColor
(
0xDCDCDC
)
}
}
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-sidebarcontainer.md
浏览文件 @
7a4f4d87
...
...
@@ -59,7 +59,12 @@ SideBarContainer( type?: SideBarContainerType )
| Start | 侧边栏位于容器左侧。 |
| End | 侧边栏位于容器右侧。 |
## SideBarPosition<sup>9+</sup>枚举说明
| 名称 | 描述 |
| -------- | -------- |
| Start | 侧边栏位于容器左侧。 |
| End | 侧边栏位于容器右侧。 |
## 事件
...
...
zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md
浏览文件 @
7a4f4d87
...
...
@@ -8,9 +8,9 @@
## 属性
| 名称 | 参数类型 | 默认值 | 描述 |
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| motionPath | {
<br/>
path:
string,
<br/>
from?:
number,
<br/>
to?:
number,
<br/>
rotatable?:
boolean
<br/>
}
<br/>
**说明:**
<br/>
path中支持通过start和end进行起点和终点的替代,如:
<br/>
'Mstart.x
start.y
L50
50
Lend.x
end.y
Z'| {
<br/>
"",
<br/>
0.0,
<br/>
1.0,
<br/>
false
<br/>
} | 设置组件的运动路径,入参说明如下:
<br/>
-
path:位移动画的运动路径,使用svg路径字符串。
<br/>
-
from:运动路径的起点,默认为0.0。
<br/>
-
to:运动路径的终点,默认为1.0。
<br/>
-
rotatable:是否跟随路径进行旋转。 |
| motionPath | {
<br/>
path:
string,
<br/>
from?:
number,
<br/>
to?:
number,
<br/>
rotatable?:
boolean
<br/>
}
<br/>
**说明:**
<br/>
path中支持通过start和end进行起点和终点的替代,如:
<br/>
'Mstart.x
start.y
L50
50
Lend.x
end.y
Z'| {
<br/>
"",
<br/>
0.0,
<br/>
1.0,
<br/>
false
<br/>
} | 设置组件的运动路径,入参说明如下:
<br/>
-
path:位移动画的运动路径,使用svg路径字符串。
<br/>
-
from:运动路径的起点,默认为0.0。
<br/>
-
to:运动路径的终点,默认为1.0。
<br/>
-
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
},
()
=>
{
...
...
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-focus.md
浏览文件 @
7a4f4d87
...
...
@@ -11,7 +11,7 @@
|
**名称**
|
**参数类型**
|
**描述**
|
| -------------------- | -------- | ---------------------------------------- |
| focusable | boolean | 设置当前组件是否可以获焦。
<br/>
默认值:false
|
| focusable | boolean | 设置当前组件是否可以获焦。
<br/>
**说明:**
<br/>
存在默认交互逻辑的组件例如Button、TextInput等,默认即为可获焦,Text、Image等组件则默认状态为不可获焦。
|
| tabIndex
<sup>
9+
<sup>
| number | 自定义组件tab键走焦能力,走焦顺序为:tabIndex大于0的组件依次递增走焦, tabIndex等于0的组件按组件树先后顺序走焦。
<br
/>
- tabIndex >= 0:表示元素是可聚焦的,并且可以通过tab键走焦来访问到该元素,按照tabIndex的数值递增而先后获焦。如果多个元素拥有相同的tabIndex,按照元素在当前组件树中的先后顺序获焦
<br
/>
- tabIndex
<
0(
通常是tabIndex =
-1):表示元素是可聚焦的,但是不能通过tab键走焦来访问到该元素。<br/
>
默认值:0 |
| defaultFocus
<sup>
9+
<sup>
| boolean | 设置当前组件是否为当前页面上的默认焦点,仅在初次创建的页面第一次进入时生效。
<br/>
默认值:false |
| groupDefaultFocus
<sup>
9+
<sup>
| boolean | 设置当前组件是否为当前组件所在容器获焦时的默认焦点,仅在初次创建容器节点第一次获焦时生效。
<br/>
默认值:false
<br/>
**说明:**
必须与tabIndex联合使用,当某个容器设置了tabIndex,且容器内某子组件设置了groupDefaultFocus,当该容器首次获焦时,会自动将焦点转移至该组件上。
<br/>
|
...
...
zh-cn/application-dev/reference/js-service-widget-ui/js-service-widget-configuration.md
浏览文件 @
7a4f4d87
...
...
@@ -32,3 +32,5 @@
}
}
```
可参考示例:
[
input
](
./js-service-widget-basic-input.md
)
与
[
list
](
js-service-widget-container-list.md
)
等组件中的用法。
\ No newline at end of file
zh-cn/application-dev/ui/ui-js-animate-component.md
浏览文件 @
7a4f4d87
...
...
@@ -346,7 +346,7 @@ export default {
![
zh-cn_image_0000001220635011
](
figures/zh-cn_image_0000001220635011.gif
)
通过改变playStat
的属性
实现动画状态的改变。
通过改变playStat
e的值
实现动画状态的改变。
```
html
<!-- xxx.hml -->
...
...
zh-cn/application-dev/ui/ui-ts-page-redirection-data-transmission.md
浏览文件 @
7a4f4d87
...
...
@@ -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
()
{
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录