Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
fb72280e
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看板
提交
fb72280e
编写于
7月 03, 2023
作者:
Y
yeyinglong
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
嵌套滚动文档说明
Signed-off-by:
N
yeyinglong
<
yeyinglong@hisilicon.com
>
上级
9266c59b
变更
5
隐藏空白更改
内联
并排
Showing
5 changed file
with
79 addition
and
1 deletion
+79
-1
zh-cn/application-dev/reference/arkui-ts/figures/NestedScroll2.gif
...lication-dev/reference/arkui-ts/figures/NestedScroll2.gif
+0
-0
zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md
...n/application-dev/reference/arkui-ts/ts-container-grid.md
+1
-0
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
...n/application-dev/reference/arkui-ts/ts-container-list.md
+1
-0
zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md
...application-dev/reference/arkui-ts/ts-container-scroll.md
+76
-1
zh-cn/application-dev/reference/arkui-ts/ts-container-waterflow.md
...lication-dev/reference/arkui-ts/ts-container-waterflow.md
+1
-0
未找到文件。
zh-cn/application-dev/reference/arkui-ts/figures/NestedScroll2.gif
0 → 100644
浏览文件 @
fb72280e
213.5 KB
zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md
浏览文件 @
fb72280e
...
...
@@ -61,6 +61,7 @@ Grid(scroller?: Scroller)
| supportAnimation
<sup>
8+
</sup>
| boolean | 是否支持动画。当前支持GridItem拖拽动画。
<br/>
默认值:false |
| edgeEffect
<sup>
10+
</sup>
|
[
EdgeEffect
](
ts-appendix-enums.md#edgeeffect
)
| 设置组件的滑动效果,支持弹簧效果和阴影效果。
<br/>
默认值:EdgeEffect.None
<br/>
|
| enableScrollInteraction
<sup>
10+
</sup>
| boolean | 设置是否支持滚动手势,当设置为false时,无法通过手指或者鼠标滚动,但不影响控制器的滚动接口。
<br/>
默认值:true |
| nestedScroll
<sup>
10+
</sup>
|
[
NestedScrollOptions
](
ts-container-scroll.md#nestedscrolloptions10对象说明
)
| 嵌套滚动选项。设置向前向后两个方向上的嵌套滚动模式,实现与父组件的滚动联动。 |
Grid组件根据rowsTemplate、columnsTemplate属性的设置情况,可分为以下三种布局模式:
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
浏览文件 @
fb72280e
...
...
@@ -64,6 +64,7 @@ List(value?:{space?: number | string, initialIndex?: number, scroller?
| alignListItem
<sup>
9+
</sup>
|
[
ListItemAlign
](
#listitemalign9枚举说明
)
| List交叉轴方向宽度大于ListItem交叉轴宽度
*
lanes时,ListItem在List交叉轴方向的布局方式,默认为首部对齐。
<br/>
默认值:ListItemAlign.Start
<br/>
该接口支持在ArkTS卡片中使用。 |
| sticky
<sup>
9+
</sup>
|
[
StickyStyle
](
#stickystyle9枚举说明
)
| 配合
[
ListItemGroup
](
ts-container-listitemgroup.md
)
组件使用,设置ListItemGroup中header和footer是否要吸顶或吸底。
<br/>
默认值:StickyStyle.None
<br/>
该接口支持在ArkTS卡片中使用。
<br/>
**说明:**
<br/>
sticky属性可以设置为 StickyStyle.Header
\|
StickyStyle.Footer 以同时支持header吸顶和footer吸底。 |
| enableScrollInteraction
<sup>
10+
</sup>
| boolean | 设置是否支持滚动手势,当设置为false时,无法通过手指或者鼠标滚动,但不影响控制器的滚动接口。
<br/>
默认值:true |
| nestedScroll
<sup>
10+
</sup>
|
[
NestedScrollOptions
](
ts-container-scroll.md#nestedscrolloptions10对象说明
)
| 嵌套滚动选项。设置向前向后两个方向上的嵌套滚动模式,实现与父组件的滚动联动。 |
## ListItemAlign<sup>9+</sup>枚举说明
...
...
zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md
浏览文件 @
fb72280e
...
...
@@ -36,6 +36,7 @@ Scroll(scroller?: Scroller)
| scrollBarWidth | string
\|
number | 设置滚动条的宽度,不支持百分比设置。
<br/>
默认值:4
<br/>
单位:vp
<br/>
**说明:**
<br/>
如果滚动条的宽度超过其高度,则滚动条的宽度会变为默认值。 |
| edgeEffect |
[
EdgeEffect
](
ts-appendix-enums.md#edgeeffect
)
| 设置滑动效果,目前支持的滑动效果参见EdgeEffect的枚举说明。
<br/>
默认值:EdgeEffect.None |
| enableScrollInteraction
<sup>
10+
</sup>
| boolean | 设置是否支持滚动手势,当设置为false时,无法通过手指或者鼠标滚动,但不影响控制器的滚动接口。
<br/>
默认值:true |
| nestedScroll
<sup>
10+
</sup>
|
[
NestedScrollOptions
](
#nestedscrolloptions10对象说明
)
| 嵌套滚动选项。设置向前向后两个方向上的嵌套滚动模式,实现与父组件的滚动联动。 |
## ScrollDirection枚举说明
| 名称 | 描述 |
...
...
@@ -54,7 +55,7 @@ Scroll(scroller?: Scroller)
| onScrollEdge(event: (side: Edge) => void) | 滚动到边缘事件回调。
<br/>
触发该事件的条件 :
<br/>
1、滚动组件滚动到边缘时触发,支持键鼠操作等其他触发滚动的输入设置。
<br/>
2、通过滚动控制器API接口调用。
<br/>
3、越界回弹。 |
| onScrollEnd
<sup>
(deprecated)
</sup>
(event: () => void) | 滚动停止事件回调。
<br>
该事件从API version 9开始废弃,使用onScrollStop事件替代。
<br/>
触发该事件的条件 :
<br/>
1、滚动组件触发滚动后停止,支持键鼠操作等其他触发滚动的输入设置。
<br/>
2、通过滚动控制器API接口调用后停止,带过渡动效。 |
| onScrollStart
<sup>
9+
</sup>
(event: () => void) | 滚动开始时触发。手指拖动Scroll或拖动Scroll的滚动条触发的滚动开始时,会触发该事件。使用
[
Scroller
](
#scroller
)
滚动控制器触发的带动画的滚动,动画开始时会触发该事件。
<br/>
触发该事件的条件 :
<br/>
1、滚动组件开始滚动时触发,支持键鼠操作等其他触发滚动的输入设置。
<br/>
2、通过滚动控制器API接口调用后开始,带过渡动效。 |
| onScrollStop
<sup>
9+
</sup>
(event: () => void) | 滚动停止时触发。手拖动Scroll或拖动Scroll的滚动条触发的滚动,手离开屏幕并且滚动停止时会触发该事件。使用
[
Scroller
](
#scroller
)
滚动控制器触发的带动画的滚动,动画停止时会触发该事件。
<br/>
触发该事件的条件 :
<br/>
1、滚动组件触发滚动后停止,支持键鼠操作等其他触发滚动的输入设置。
<br/>
2、通过滚动控制器API接口调用后开始,带过渡动效
,
。 |
| onScrollStop
<sup>
9+
</sup>
(event: () => void) | 滚动停止时触发。手拖动Scroll或拖动Scroll的滚动条触发的滚动,手离开屏幕并且滚动停止时会触发该事件。使用
[
Scroller
](
#scroller
)
滚动控制器触发的带动画的滚动,动画停止时会触发该事件。
<br/>
触发该事件的条件 :
<br/>
1、滚动组件触发滚动后停止,支持键鼠操作等其他触发滚动的输入设置。
<br/>
2、通过滚动控制器API接口调用后开始,带过渡动效。 |
> **说明:**
>
...
...
@@ -179,6 +180,20 @@ scrollBy(dx: Length, dy: Length): void
| END | 尾部对齐。指定item尾部与List尾部对齐。 |
| AUTO | 自动对齐。
<br/>
若指定item完全处于显示区,不做调整。否则依照滑动距离最短的原则,将指定item首部对齐或尾部对齐于List,使指定item完全处于显示区。|
## NestedScrollOptions<sup>10+ </sup>对象说明
| 名称 | 类型 | 描述 |
| ----- | ------ | ----------------- |
| scrollForward | NestedScrollMode | 可滚动组件往末尾端滚动时的嵌套滚动选项。 |
| scrollBackward | NestedScrollMode | 可滚动组件往起始端滚动时的嵌套滚动选项。 |
## NestedScrollMode<sup>10+ </sup>枚举说明
| 名称 | 描述 |
| ------ | ------------------------------ |
| SELF_ONLY | 只自身滚动,不与父组件联动。 |
| SELF_FIRST | 自身先滚动,自身滚动到边缘以后父组件滚动。父组件滚动到边缘以后,如果父组件有边缘效果,则父组件触发边缘效果,否则子组件触发边缘效果。 |
| PARENT_FIRST | 父组件先滚动,父组件滚动到边缘以后自身滚动。自身滚动到边缘后,人工有边缘效果,会触发自身的边缘效果,否则触发父组件的边缘效果。 |
| PARALLEL | 自身和父组件同时滚动,自身和父组件都到达边缘以后,如果自身有边缘效果,则自身触发边缘效果,否则父组件触发边缘效果。|
## 示例
### 示例1
...
...
@@ -312,3 +327,63 @@ struct NestedScroll {
```
![
NestedScroll
](
figures/NestedScroll.gif
)
### 示例3
```
ts
@
Entry
@
Component
struct
StickyNestedScroll
{
@
State
message
:
string
=
'
Hello World
'
@
State
arr
:
number
[]
=
[]
@
Styles
listCard
()
{
.
backgroundColor
(
Color
.
White
)
.
height
(
72
)
.
width
(
"
100%
"
)
.
borderRadius
(
12
)
}
build
()
{
Scroll
()
{
Column
()
{
Text
(
"
Scroll Area
"
)
.
width
(
"
100%
"
)
.
height
(
"
40%
"
)
.
backgroundColor
(
'
#0080DC
'
)
.
textAlign
(
TextAlign
.
Center
)
Tabs
({
barPosition
:
BarPosition
.
Start
})
{
TabContent
()
{
List
({
space
:
10
})
{
ForEach
(
this
.
arr
,
(
item
)
=>
{
ListItem
()
{
Text
(
"
item
"
+
item
)
.
fontSize
(
16
)
}.
listCard
()
},
item
=>
item
)
}.
width
(
"
100%
"
)
.
edgeEffect
(
EdgeEffect
.
Spring
)
.
nestedScroll
({
scrollForward
:
NestedScrollMode
.
PARENT_FIRST
,
scrollBackward
:
NestedScrollMode
.
SELF_FIRST
})
}.
tabBar
(
"
Tab1
"
)
TabContent
()
{
}.
tabBar
(
"
Tab2
"
)
}
.
vertical
(
false
)
.
height
(
"
100%
"
)
}.
width
(
"
100%
"
)
}
.
edgeEffect
(
EdgeEffect
.
Spring
)
.
backgroundColor
(
'
#DCDCDC
'
)
.
scrollBar
(
BarState
.
Off
)
.
width
(
'
100%
'
)
.
height
(
'
100%
'
)
}
aboutToAppear
()
{
for
(
let
i
=
0
;
i
<
30
;
i
++
)
{
this
.
arr
.
push
(
i
)
}
}
}
```
![
NestedScroll2
](
figures/NestedScroll2.gif
)
zh-cn/application-dev/reference/arkui-ts/ts-container-waterflow.md
浏览文件 @
fb72280e
...
...
@@ -45,6 +45,7 @@ WaterFlow(options?: {footer?: CustomBuilder, scroller?: Scroller})
| rowsGap | Length |设置行与行的间距。
<br>
默认值:0|
| layoutDirection |
[
FlexDirection
](
ts-appendix-enums.md#flexdirection
)
|设置布局的主轴方向。
<br/>
默认值:FlexDirection.Column|
| enableScrollInteraction
<sup>
10+
</sup>
| boolean | 设置是否支持滚动手势,当设置为false时,无法通过手指或者鼠标滚动,但不影响控制器的滚动接口。
<br/>
默认值:true |
| nestedScroll
<sup>
10+
</sup>
|
[
NestedScrollOptions
](
ts-container-scroll.md#nestedscrolloptions10对象说明
)
| 嵌套滚动选项。设置向前向后两个方向上的嵌套滚动模式,实现与父组件的滚动联动。 |
layoutDirection优先级高于rowsTemplate和columnsTemplate。根据layoutDirection设置情况,分为以下三种设置模式:
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录