harmony 鸿蒙Grid
Grid
网格容器，由“行”和“列”分割的单元格所组成，通过指定“项目”所在的单元格做出各种各样的布局。
说明：
该组件从API version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
子组件
仅支持GridItem子组件，支持通过渲染控制类型（if/else、ForEach、LazyForEach和Repeat）动态生成子组件，更推荐使用LazyForEach或Repeat以优化性能。
说明：
Grid子组件的索引值计算规则：
按子组件的顺序依次递增。
if/else语句中，只有条件成立分支内的子组件会参与索引值计算，条件不成立分支内的子组件不计算索引值。
ForEach/LazyForEach和Repeat语句中，会计算展开所有子节点索引值。
if/else、ForEach、LazyForEach和Repeat发生变化以后，会更新子节点索引值。
Grid子组件的visibility属性设置为Hidden或None时依然会计算索引值。
Grid子组件的visibility属性设置为None时不显示，但依然会占用子组件对应的网格。
Grid子组件设置position属性，会占用子组件对应的网格，子组件将显示在相对Grid左上角偏移position的位置。该子组件不会随其对应网格滚动，在对应网格滑出Grid显示范围外后不显示。
当Grid子组件之间留有空隙时，会根据当前的展示区域尽可能填补空隙，因此GridItem可能会随着网格滚动而改变相对位置。
接口
Grid(scroller?: Scroller, layoutOptions?: GridLayoutOptions)
创建网格容器。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scroller | Scroller | 否 | 可滚动组件的控制器。用于与可滚动组件进行绑定。 说明： 不允许和其他滚动类组件，如：ArcList、List、Grid、Scroll和WaterFlow绑定同一个滚动控制对象。 |
| layoutOptions10+ | GridLayoutOptions | 否 | Grid布局选项。 |
GridLayoutOptions10+对象说明
Grid布局选项。其中，irregularIndexes和onGetIrregularSizeByIndex可对仅设置rowsTemplate或columnsTemplate的Grid使用，可以指定一个index数组，并为其中的index对应的GridItem设置其占据的行数与列数，使用方法参见示例3；onGetRectByIndex可对同时设置rowsTemplate和columnsTemplate的Grid使用，为指定的index对应的GridItem设置位置和大小，使用方法参见示例1。
为提高Grid在跳转、列数变化等场景的性能，应该尽量使用GridLayoutOptions。即使Grid中没有任何特殊的跨行跨列节点，也可以通过使用’Grid(this.scroller, {regularSize: [1, 1]})‘的方式提高跳转性能。参考使用GridLayoutOptions提升Grid性能。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| regularSize | [number, number] | 是 | 大小规则的GridItem在Grid中占的行数和列数，只支持占1行1列即[1, 1]。 原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。 |
| irregularIndexes | number[] | 否 | 指定的GridItem索引在Grid中的大小是不规则的。当不设置onGetIrregularSizeByIndex时，irregularIndexes中GridItem的默认大小为垂直滚动Grid的一整行或水平滚动Grid的一整列。 原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。 |
| onGetIrregularSizeByIndex | (index: number) => [number, number] | 否 | 配合irregularIndexes使用，设置不规则GridItem占用的行数和列数。开发者可为irregularIndexes中指明的index对应的GridItem设置占用的行数和列数。在API version 12之前，垂直滚动Grid不支持GridItem占多行，水平滚动Grid不支持GridItem占多列。 原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。 |
| onGetRectByIndex11+ | (index: number) => [number, number,number,number] | 否 | 设置指定索引index对应的GridItem的位置及大小[rowStart,columnStart,rowSpan,columnSpan]。 其中rowStart为行起始位置，columnStart为列起始位置，无单位。 rowSpan为GridItem占用的行数，columnSpan为GridItem占用的列数，无单位。 rowStart和columnStart取大于等于0的自然数，若取负数时，rowStart和columnStart默认为0。 rowSpan和columnSpan取大于等于1的自然数，若取小数则向下取整，若小于1则按1计算。 说明： 第一种情况：某个GridItem发现给它指定的起始位置被占据了，则从起始位置[0,0]开始按顺序从左到右，从上到下寻找起始的放置位置。 第二种情况：如果起始位置没有被占据，但其他位置被占据了，无法显示全部的GridItem大小，则只会布局一部分。 原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。 |
属性
除支持通用属性和滚动组件通用属性外，还支持以下属性： > 说明： > > Grid组件使用通用属性clip12+和通用属性clip18+时默认值都为true。
columnsTemplate
columnsTemplate(value: string)
设置当前网格布局列的数量、固定列宽或最小列宽值，不设置时默认1列。
例如， ‘1fr 1fr 2fr’ 是将父组件分3列，将父组件允许的宽分为4等份，第1列占1份，第2列占1份，第3列占2份。
columnsTemplate(‘repeat(auto-fit, track-size)’)是设置最小列宽值为track-size，自动计算列数和实际列宽。
columnsTemplate(‘repeat(auto-fill, track-size)’)是设置固定列宽值为track-size，自动计算列数。
columnsTemplate(‘repeat(auto-stretch, track-size)’)是设置固定列宽值为track-size，使用columnsGap为最小列间距，自动计算列数和实际列间距。
其中repeat、auto-fit、auto-fill、auto-stretch为关键字。track-size为列宽，支持的单位包括px、vp、%或有效数字，默认单位为vp，track-size至少包括一个有效列宽。
auto-stretch模式只支持track-size为一个有效列宽值，并且track-size只支持px、vp和有效数字，不支持%。
使用效果可以参考示例8。
设置为’0fr’时，该列的列宽为0，不显示GridItem。设置为其他非法值时，GridItem显示为固定1列。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | string | 是 | 当前网格布局列的数量或最小列宽值。 |
rowsTemplate
rowsTemplate(value: string)
设置当前网格布局行的数量、固定行高或最小行高值，不设置时默认1行。
例如， ‘1fr 1fr 2fr’是将父组件分3行，将父组件允许的高分为4等份，第1行占1份，第2行占1份，第3行占2份。
rowsTemplate(‘repeat(auto-fit, track-size)’)是设置最小行高值为track-size，自动计算行数和实际行高。
rowsTemplate(‘repeat(auto-fill, track-size)’)是设置固定行高值为track-size，自动计算行数。
rowsTemplate(‘repeat(auto-stretch, track-size)’)是设置固定行高值为track-size，使用rowsGap为最小行间距，自动计算行数和实际行间距。
其中repeat、auto-fit、auto-fill、auto-stretch为关键字。track-size为行高，支持的单位包括px、vp、%或有效数字，默认单位为vp，track-size至少包括一个有效行高。
auto-stretch模式只支持track-size为一个有效行高值，并且track-size只支持px、vp和有效数字，不支持%。
设置为’0fr’，则这一行的行宽为0，这一行GridItem不显示。设置为其他非法值，按固定1行处理。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | string | 是 | 当前网格布局行的数量或最小行高值。 |
说明：
Grid组件根据rowsTemplate、columnsTemplate属性的设置情况，可分为以下三种布局模式：
1、rowsTemplate、columnsTemplate同时设置：
- Grid只展示固定行列数的元素，其余元素不展示，且Grid不可滚动。
- 此模式下以下属性不生效：layoutDirection、maxCount、minCount、cellLength。
- Grid的宽高没有设置时，默认适应父组件尺寸。
- Grid网格列大小按照Grid自身内容区域大小减去所有行列Gap后按各个行列所占比重分配。
- GridItem默认填满网格大小。
2、rowsTemplate、columnsTemplate仅设置其中的一个：
- 元素按照设置的方向进行排布，超出Grid显示区域后，Grid可通过滚动的方式展示。
- 如果设置了columnsTemplate，Grid滚动方向为垂直方向，主轴方向为垂直方向，交叉轴方向为水平方向。
- 如果设置了rowsTemplate，Grid滚动方向为水平方向，主轴方向为水平方向，交叉轴方向为垂直方向。
- 此模式下以下属性不生效：layoutDirection、maxCount、minCount、cellLength。
- 网格交叉轴方向尺寸根据Grid自身内容区域交叉轴尺寸减去交叉轴方向所有Gap后按所占比重分配。
- 网格主轴方向尺寸取当前网格交叉轴方向所有GridItem主轴方向尺寸最大值。
3、rowsTemplate、columnsTemplate都不设置：
- 元素在layoutDirection方向上排布，列数由Grid的宽度、首个元素的宽度、minCount、maxCount、columnsGap共同决定。
- 行数由Grid高度、首个元素高度、cellLength、rowsGap共同决定。超出行列容纳范围的元素不显示，也不能通过滚动进行展示。
- 此模式下仅生效以下属性：layoutDirection、maxCount、minCount、cellLength、editMode、columnsGap、rowsGap。
- 当前layoutDirection设置为Row时，先从左到右排列，排满一行再排下一行。剩余高度不足时不再布局，整体内容顶部居中。
- 当前layoutDirection设置为Column时，先从上到下排列，排满一列再排下一列，剩余宽度不足时不再布局。整体内容顶部居中。
- 当前Grid下面没有GridItem时，Grid的宽高为0。
columnsGap
columnsGap(value: Length)
设置列与列的间距。设置为小于0的值时，按默认值显示。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | Length | 是 | 列与列的间距。 默认值：0 取值范围：[0, +∞) |
rowsGap
rowsGap(value: Length)
设置行与行的间距。设置为小于0的值时，按默认值显示。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | Length | 是 | 行与行的间距。 默认值：0 取值范围：[0, +∞) |
scrollBar
scrollBar(value: BarState)
设置滚动条状态。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | BarState | 是 | 滚动条状态。 默认值：BarState.Auto 说明： API version 9及以下版本默认值为BarState.Off，API version 10及以上版本的默认值为BarState.Auto。 |
scrollBarColor
scrollBarColor(value: Color|number|string)
设置滚动条的颜色。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | Color | number | string | 是 | 滚动条的颜色。 默认值：’#182431’（40%不透明度） number为HEX格式颜色，支持rgb或者argb，示例：0xffffff。string为rgb或者argb格式颜色，示例：’#ffffff’。 |
scrollBarWidth
scrollBarWidth(value: number|string)
设置滚动条的宽度，不支持百分比设置。宽度设置后，滚动条正常状态和按压状态宽度均为滚动条的宽度值。如果滚动条的宽度超过Grid组件主轴方向的高度，则滚动条的宽度会变为默认值。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | string | 是 | 滚动条的宽度。 默认值：4 单位：vp 取值范围：设置为小于0的值时，按默认值处理。设置为0时，不显示滚动条。 |
cachedCount
cachedCount(value: number)
设置预加载的GridItem的数量，只在LazyForEach和开启了virtualScroll开关的Repeat中生效。具体使用可参考减少应用白块说明。
设置缓存后会在Grid显示区域上下各缓存cachedCount*列数个GridItem。
LazyForEach和开启了virtualScroll开关的Repeat超出显示和缓存范围的GridItem会被释放。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | 是 | 预加载的GridItem的数量。 默认值：垂直滚动时为一个屏幕内可显示的行数，水平滚动时为一个屏幕内可显示的列数，最大值为16。 取值范围：[0, +∞)，设置为小于0的值时，按1处理。 |
cachedCount14+
cachedCount(count: number, show: boolean)
设置预加载的GridItem数量，并配置是否显示预加载节点。
设置缓存后会在Grid显示区域上下各缓存cachedCount*列数个GridItem。配合裁剪或内容裁剪属性可以显示出预加载节点。
原子化服务API： 从API version 14开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| count | number | 是 | 预加载的GridItem的数量。 默认值：垂直滚动时为一个屏幕内可显示的行数，水平滚动时为一个屏幕内可显示的列数，最大值为16。 取值范围：[0, +∞)，设置为小于0的值时，按1处理。 |
| show | boolean | 是 | 被预加载的GridItem是否需要显示。设置为true时显示预加载的GridItem，设置为false时不显示预加载的GridItem。 默认值：false |
editMode8+
editMode(value: boolean)
设置Grid是否进入编辑模式，进入编辑模式可以拖拽Grid组件内部GridItem。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | boolean | 是 | Grid是否进入编辑模式。设置为true时当前Grid组件处于可编辑模式，设置为false时当前Grid组件处于不可编辑模式。 默认值：false |
layoutDirection8+
layoutDirection(value: GridDirection)
设置布局的主轴方向。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | GridDirection | 是 | 布局的主轴方向。 默认值：GridDirection.Row |
maxCount8+
maxCount(value: number)
设置可显示的最大行数或列数。设置为小于1的值时，按默认值显示。
当layoutDirection是Row/RowReverse时，表示可显示的最大列数。
当layoutDirection是Column/ColumnReverse时，表示可显示的最大行数。
当maxCount小于minCount时，maxCount和minCount都按默认值处理。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | 是 | 可显示的最大行数或列数。 默认值：Infinity |
minCount8+
minCount(value: number)
设置可显示的最小行数或列数。设置为小于1的值时，按默认值显示。
当layoutDirection是Row/RowReverse时，表示可显示的最小列数。
当layoutDirection是Column/ColumnReverse时，表示可显示的最小行数。
当minCount大于maxCount时，minCount和maxCount都按默认值处理。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | 是 | 可显示的最小行数或列数。 默认值：1 |
cellLength8+
cellLength(value: number)
设置一行的高度或者一列的宽度。
当layoutDirection是Row/RowReverse时，表示一行的高度。
当layoutDirection是Column/ColumnReverse时，表示一列的宽度。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | 是 | 一行的高度或者一列的宽度。 默认值：第一个元素的大小 单位：vp 取值范围：[0, +∞)，设置为小于0的值时，按默认值显示。 |
multiSelectable8+
multiSelectable(value: boolean)
设置是否开启鼠标框选。开启框选后，可以配合GridItem的selected属性和onSelect事件获取GridItem的选中状态，还可以设置选中态样式（无默认选中样式）。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | boolean | 是 | 是否开启鼠标框选。 默认值：false false：关闭框选。true：开启框选。 |
supportAnimation8+
supportAnimation(value: boolean)
设置是否支持动画。当前支持GridItem拖拽动画。仅在滚动模式下（只设置rowsTemplate、columnsTemplate其中一个）支持动画。
仅在大小规则的Grid中支持拖拽动画，跨行或跨列场景不支持。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | boolean | 是 | 是否支持动画。设置为true时支持GridItem拖拽动画，设置为false时不支持GridItem拖拽动画。 默认值：false |
edgeEffect10+
edgeEffect(value: EdgeEffect, options?: EdgeEffectOptions)
设置边缘滑动效果。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | EdgeEffect | 是 | Grid组件的边缘滑动效果，支持弹簧效果和阴影效果。 默认值：EdgeEffect.None |
| options11+ | EdgeEffectOptions | 否 | 组件内容大小小于组件自身时，是否开启滑动效果。设置为{ alwaysEnabled: true }会开启滑动效果，{ alwaysEnabled: false }不开启。 默认值：{ alwaysEnabled: false } |
enableScrollInteraction10+
enableScrollInteraction(value: boolean)
设置是否支持滚动手势。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | boolean | 是 | 是否支持滚动手势。设置为true时可以通过手指或者鼠标滚动，设置为false时无法通过手指或者鼠标滚动，但不影响控制器Scroller的滚动接口。 默认值：true |
说明：
组件无法通过鼠标按下拖动操作进行滚动。
nestedScroll10+
nestedScroll(value: NestedScrollOptions)
设置嵌套滚动选项。设置前后两个方向的嵌套滚动模式，实现与父组件的滚动联动。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | NestedScrollOptions | 是 | 嵌套滚动选项。 |
friction10+
friction(value: number|Resource)
设置摩擦系数，手动划动滚动区域时生效，仅影响惯性滚动过程，对惯性滚动过程中的链式效果有间接影响。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | number | Resource | 是 | 摩擦系数。 默认值：非可穿戴设备为0.6，可穿戴设备为0.9。 从API version 11开始，非可穿戴设备默认值为0.7。 从API version 12开始，非可穿戴设备默认值为0.75。 取值范围：(0, +∞)，设置为小于等于0的值时，按默认值处理。 |
alignItems12+
alignItems(alignment: Optional<GridItemAlignment>)
设置Grid中GridItem的对齐方式， 使用方法可以参考示例9。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| alignment | Optional<GridItemAlignment> | 是 | 设置Grid中GridItem的对齐方式。 默认值：GridItemAlignment.DEFAULT |
focusWrapMode20+
focusWrapMode(mode: Optional<FocusWrapMode>)
设置方向键走焦模式。
原子化服务API： 从API version 20开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mode | Optional<FocusWrapMode> | 是 | 交叉轴方向键走焦模式。 默认值：FocusWrapMode.DEFAULT 说明： 异常值按默认值处理，即交叉轴方向键不能换行。 |
GridItemAlignment12+枚举说明
GridItem的对齐方式枚举。
原子化服务API： 从API version 12开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 值 | 说明 |
|---|---|---|
| DEFAULT | 0 | 使用Grid的默认对齐方式。 |
| STRETCH | 1 | 以一行中的最高的GridItem作为其他GridItem的高度。 |
说明：
1、只有可滚动的Grid中，设置STRETCH参数会生效，其他场景不生效。
2、在Grid的一行中，如果每个GridItem都是大小规律的（只占一行一列），设置STRETCH参数会生效，存在跨行或跨列的GridItem的场景不生效。
3、设置STRETCH后，只有不设置高度的GridItem才会以当前行中最高的GridItem作为自己的高度，设置过高度的GridItem高度不会变化。
4、设置STRETCH后，Grid布局时会有额外的布局流程，可能会带来额外的性能开销。
GridDirection8+枚举说明
主轴布局方向枚举。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 值 | 说明 |
|---|---|---|
| Row | 0 | 主轴布局方向沿水平方向布局，即自左往右先填满一行，再去填下一行。 |
| Column | 1 | 主轴布局方向沿垂直方向布局，即自上往下先填满一列，再去填下一列。 |
| RowReverse | 2 | 主轴布局方向沿水平方向反向布局，即自右往左先填满一行，再去填下一行。 |
| ColumnReverse | 3 | 主轴布局方向沿垂直方向反向布局，即自下往上先填满一列，再去填下一列。 |
事件
onScrollIndex
onScrollIndex(event: (first: number, last: number) => void)
当前网格显示的起始位置/终止位置的item发生变化时触发。网格初始化时会触发一次。Grid显示区域上第一个子组件/最后一个组件的索引值有变化就会触发。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| first | number | 是 | 当前显示的网格起始位置的索引值。 |
| last10+ | number | 是 | 当前显示的网格终止位置的索引值。 |
onItemDragStart8+
onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any) |void)
开始拖拽网格元素时触发。返回void表示不能拖拽。
手指长按GridItem时触发该事件。
由于拖拽检测也需要长按，且事件处理机制优先触发子组件事件，GridItem上绑定LongPressGesture时无法触发拖拽。如有长按和拖拽同时使用的需求可以使用通用拖拽事件。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | ItemDragInfo | 是 | 拖拽点的信息。 |
| itemIndex | number | 是 | 被拖拽网格元素索引值。 |
onItemDragEnter8+
onItemDragEnter(event: (event: ItemDragInfo) => void)
拖拽进入网格元素范围内时触发。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | ItemDragInfo | 是 | 拖拽点的信息。 |
onItemDragMove8+
onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void)
拖拽在网格元素范围内移动时触发。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | ItemDragInfo | 是 | 拖拽点的信息。 |
| itemIndex | number | 是 | 拖拽起始位置。 |
| insertIndex | number | 是 | 拖拽插入位置。 |
onItemDragLeave8+
onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void)
拖拽离开网格元素时触发。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | ItemDragInfo | 是 | 拖拽点的信息。 |
| itemIndex | number | 是 | 拖拽离开的网格元素索引值。 |
onItemDrop8+
onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void)
绑定该事件的网格元素可作为拖拽释放目标，当GridItem停止拖拽时触发。
当拖拽释放位置在网格元素之内时，isSuccess会返回true；在网格元素之外时，isSuccess会返回false。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| event | ItemDragInfo | 是 | 拖拽点的信息。 |
| itemIndex | number | 是 | 拖拽起始位置。 |
| insertIndex | number | 是 | 拖拽插入位置。 |
| isSuccess | boolean | 是 | 是否成功释放 |
onScrollBarUpdate10+
onScrollBarUpdate(event: (index: number, offset: number) => ComputedBarAttribute)
在Grid每帧布局结束时触发，可通过该回调设置滚动条的位置及长度。
该接口只用作设置Grid的滚动条位置，不建议开发者在此接口中做业务逻辑处理。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| index | number | 是 | 当前显示的网格起始位置的索引值。 |
| offset | number | 是 | 当前显示的网格起始位置元素相对网格显示起始位置的偏移，单位vp。 |
返回值：
| 类型 | 说明 |
|---|---|
| ComputedBarAttribute | 滚动条的位置及长度。 |
onReachStart10+
onReachStart(event: () => void)
网格到达起始位置时触发。
Grid初始化时会触发一次，Grid滚动到起始位置时触发一次。Grid边缘效果为弹簧效果时，划动经过起始位置时触发一次，回弹回起始位置时再触发一次。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
onReachEnd10+
onReachEnd(event: () => void)
网格到达末尾位置时触发。不满一屏并且最后一个子组件末端在Grid内时触发。
Grid边缘效果为弹簧效果时，划动经过末尾位置时触发一次，回弹回末尾位置时再触发一次。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
onScrollFrameBegin10+
onScrollFrameBegin(event: (offset: number, state: ScrollState) => { offsetRemain: number })
该接口回调时，事件参数传入即将发生的滑动量，事件处理函数中可根据应用场景计算实际需要的滑动量并作为事件处理函数的返回值返回，网格将按照返回值的实际滑动量进行滑动。
满足以下任一条件时触发该事件：
- 用户交互（如手指滑动、键鼠操作等）触发滚动。
- Grid惯性滚动。
- 调用fling接口触发滚动。
不触发该事件的条件：
- 调用除fling接口外的其他滚动控制接口。
- 越界回弹。
- 拖动滚动条。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| offset | number | 是 | 即将发生的滑动量，单位vp。 |
| state | ScrollState | 是 | 当前滑动状态。 |
返回值：
| 类型 | 说明 |
|---|---|
| { offsetRemain: number } | 实际滑动量，单位vp。 |
onScrollStart10+
onScrollStart(event: () => void)
网格滑动开始时触发。手指拖动网格或网格的滚动条触发的滑动开始时，会触发该事件。使用Scroller滑动控制器触发的带动画的滑动，动画开始时会触发该事件。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
onScrollStop10+
onScrollStop(event: () => void)
网格滑动停止时触发。手指拖动网格或网格的滚动条触发的滑动，手指离开屏幕并且滑动停止时会触发该事件。使用Scroller滑动控制器触发的带动画的滑动，动画停止会触发该事件。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
onScroll(deprecated)
onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void)
网格滑动时触发。
从API version 10开始使用。
从API version 12开始废弃不再使用，建议使用onDidScroll替代。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scrollOffset | number | 是 | 每帧滚动的偏移量，Grid的内容向上滚动时偏移量为正，向下滚动时偏移量为负。 单位vp。 |
| scrollState | ScrollState | 是 | 当前滑动状态。 |
ComputedBarAttribute10+对象说明
滚动条位置和长度对象。
原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 只读 | 可选 | 说明 |
|---|---|---|---|---|
| totalOffset | number | 否 | 否 | Grid内容相对显示区域的总偏移，单位px。 |
| totalLength | number | 否 | 否 | Grid内容总长度，单位px。 |
UIGridEvent19+
frameNode中getEvent(‘Grid’)方法的返回值，可用于给Grid节点设置滚动事件。
UIGridEvent继承于UIScrollableCommonEvent。
setOnWillScroll19+
setOnWillScroll(callback: OnWillScrollCallback|undefined): void
设置onWillScroll事件的回调。
方法入参为undefined时，会重置事件回调。
原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | OnWillScrollCallback | undefined | 是 | onWillScroll事件的回调函数。 |
setOnDidScroll19+
setOnDidScroll(callback: OnScrollCallback|undefined): void
设置onDidScroll事件的回调。
方法入参为undefined时，会重置事件回调。
原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | OnScrollCallback | undefined | 是 | onDidScroll事件的回调函数。 |
setOnScrollIndex19+
setOnScrollIndex(callback: OnGridScrollIndexCallback|undefined): void
设置onScrollIndex事件的回调。
方法入参为undefined时，会重置事件回调。
原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callback | OnGridScrollIndexCallback | undefined | 是 | onScrollIndex事件的回调函数。 |
OnGridScrollIndexCallback19+
type OnGridScrollIndexCallback = (first: number, last: number) => void
Grid组件可见区域item变化事件的回调类型。
原子化服务API： 从API version 19开始，该接口支持在原子化服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| first | number | 是 | 当前显示的Grid起始位置的索引值。 |
| last | number | 是 | 当前显示的Grid终止位置的索引值。 |
示例
示例1（固定行列Grid）
可以使用GridLayoutOptions中的onGetRectByIndex指定GridItem的位置和大小。
// xxx.ets
@Entry
@Component
struct GridExample {
@State numbers1: String[] = ['0', '1', '2', '3', '4'];
@State numbers2: String[] = ['0', '1', '2', '3', '4', '5'];
layoutOptions3: GridLayoutOptions = {
regularSize: [1, 1],
onGetRectByIndex: (index: number) => {
if (index == 0) {
return [0, 0, 1, 1];
} else if (index == 1) {
return [0, 1, 2, 2];
} else if (index == 2) {
return [0, 3, 3, 3];
} else if (index == 3) {
return [3, 0, 3, 3];
} else if (index == 4) {
return [4, 3, 2, 2];
} else {
return [5, 5, 1, 1];
}
}
};
build() {
Column({ space: 5 }) {
Grid() {
ForEach(this.numbers1, (day: string) => {
ForEach(this.numbers1, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height('100%')
.textAlign(TextAlign.Center)
}
}, (day: string) => day)
}, (day: string) => day)
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.rowsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
Text('GridLayoutOptions的使用：onGetRectByIndex。').fontColor(0xCCCCCC).fontSize(9).width('90%')
Grid(undefined, this.layoutOptions3) {
ForEach(this.numbers2, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height("100%")
.textAlign(TextAlign.Center)
}
.height("100%")
.width('100%')
}, (day: string) => day)
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr 1fr')
.rowsTemplate('1fr 1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
}.width('100%').margin({ top: 5 })
}
}
示例2（可滚动Grid和滚动事件）
可滚动Grid，包括所有滚动属性和事件。
// GridDataSource.ets
export class GridDataSource implements IDataSource {
private list: string[] = [];
private listeners: DataChangeListener[] = [];
constructor(list: string[]) {
this.list = list;
}
totalCount(): number {
return this.list.length;
}
getData(index: number): string {
return this.list[index];
}
registerDataChangeListener(listener: DataChangeListener): void {
if (this.listeners.indexOf(listener) < 0) {
this.listeners.push(listener);
}
}
unregisterDataChangeListener(listener: DataChangeListener): void {
const pos = this.listeners.indexOf(listener);
if (pos >= 0) {
this.listeners.splice(pos, 1);
}
}
// 通知控制器数据位置变化
notifyDataMove(from: number, to: number): void {
this.listeners.forEach(listener => {
listener.onDataMove(from, to);
})
}
// 交换元素位置
public swapItem(from: number, to: number): void {
let temp: string = this.list[from];
this.list[from] = this.list[to];
this.list[to] = temp;
this.notifyDataMove(from, to);
}
}
// xxx.ets
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
numbers: GridDataSource = new GridDataSource([]);
scroller: Scroller = new Scroller();
@State gridPosition: number = 0; //0代表滚动到grid顶部，1代表中间值，2代表滚动到grid底部。
aboutToAppear() {
let list: string[] = [];
for (let i = 0; i < 5; i++) {
for (let j = 0; j < 5; j++) {
list.push(j.toString());
}
}
this.numbers = new GridDataSource(list);
}
build() {
Column({ space: 5 }) {
Text('scroll').fontColor(0xCCCCCC).fontSize(9).width('90%')
Grid(this.scroller) {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}, (index: number) => index.toString())
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.friction(0.6)
.enableScrollInteraction(true)
.supportAnimation(false)
.multiSelectable(false)
.edgeEffect(EdgeEffect.Spring)
.scrollBar(BarState.On)
.scrollBarColor(Color.Grey)
.scrollBarWidth(4)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
.onScrollIndex((first: number, last: number) => {
console.info(first.toString());
console.info(last.toString());
})
.onScrollBarUpdate((index: number, offset: number) => {
console.info("XXX" + 'Grid onScrollBarUpdate,index : ' + index.toString() + ",offset" + offset.toString());
return { totalOffset: (index / 5) * (80 + 10) - offset, totalLength: 80 * 5 + 10 * 4 };
}) //只适用于当前示例代码数据源，如果数据源有变化，则需要修改该部分代码，或者删掉此属性
.onDidScroll((scrollOffset: number, scrollState: ScrollState) => {
console.info(scrollOffset.toString());
console.info(scrollState.toString());
})
.onScrollStart(() => {
console.info("XXX" + "Grid onScrollStart");
})
.onScrollStop(() => {
console.info("XXX" + "Grid onScrollStop");
})
.onReachStart(() => {
this.gridPosition = 0;
console.info("XXX" + "Grid onReachStart");
})
.onReachEnd(() => {
this.gridPosition = 2;
console.info("XXX" + "Grid onReachEnd");
})
Button('next page')
.onClick(() => { // 点击后滑到下一页
this.scroller.scrollPage({ next: true });
})
}.width('100%').margin({ top: 5 })
}
}
示例3（可滚动Grid设置跨行跨列节点）
GridLayoutOptions的使用：irregularIndexes与onGetIrregularSizeByIndex。
// xxx.ets
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
numbers: GridDataSource = new GridDataSource([]);
scroller: Scroller = new Scroller();
layoutOptions1: GridLayoutOptions = {
regularSize: [1, 1], // 只支持[1, 1]
irregularIndexes: [0, 6], // 索引为0和6的GridItem占用一行
};
layoutOptions2: GridLayoutOptions = {
regularSize: [1, 1],
irregularIndexes: [0, 7], // 索引为0和7的GridItem占用的列数由onGetIrregularSizeByIndex指定
onGetIrregularSizeByIndex: (index: number) => {
if (index === 0) {
return [1, 5];
}
return [1, index % 6 + 1];
}
};
aboutToAppear() {
let list: string[] = [];
for (let i = 0; i < 5; i++) {
for (let j = 0; j < 5; j++) {
list.push(j.toString());
}
}
this.numbers = new GridDataSource(list);
}
build() {
Column({ space: 5 }) {
Grid(this.scroller, this.layoutOptions1) {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}.selectable(false)
}, (index: number) => index.toString())
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.multiSelectable(true)
.scrollBar(BarState.Off)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
Text('scroll').fontColor(0xCCCCCC).fontSize(9).width('90%')
// 不使用scroll，需要undefined占位
Grid(undefined, this.layoutOptions2) {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}, (index: number) => index.toString())
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.scrollBar(BarState.Off)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
}.width('100%').margin({ top: 5 })
}
}
示例4（Grid嵌套滚动）
nestedScroll和onScrollFrameBegin的使用。
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
@State colors: number[] = [0xFFC0CB, 0xDA70D6, 0x6B8E23, 0x6A5ACD, 0x00FFFF, 0x00FF7F];
numbers: GridDataSource = new GridDataSource([]);
@State translateY: number = 0;
private scroller: Scroller = new Scroller();
private gridScroller: Scroller = new Scroller();
private touchDown: boolean = false;
private listTouchDown: boolean = false;
private scrolling: boolean = false;
aboutToAppear() {
let list: string[] = [];
for (let i = 0; i < 100; i++) {
list.push(i.toString());
}
this.numbers = new GridDataSource(list);
}
build() {
Stack() {
Column() {
Row() {
Text('Head')
}
Column() {
List({ scroller: this.scroller }) {
ListItem() {
Grid() {
GridItem() {
Text('GoodsTypeList1')
}
.backgroundColor(this.colors[0])
.columnStart(0)
.columnEnd(1)
GridItem() {
Text('GoodsTypeList2')
}
.backgroundColor(this.colors[1])
.columnStart(0)
.columnEnd(1)
GridItem() {
Text('GoodsTypeList3')
}
.backgroundColor(this.colors[2])
.columnStart(0)
.columnEnd(1)
GridItem() {
Text('GoodsTypeList4')
}
.backgroundColor(this.colors[3])
.columnStart(0)
.columnEnd(1)
GridItem() {
Text('GoodsTypeList5')
}
.backgroundColor(this.colors[4])
.columnStart(0)
.columnEnd(1)
}
.scrollBar(BarState.Off)
.columnsGap(15)
.rowsGap(10)
.rowsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsTemplate('1fr')
.width('100%')
.height(200)
}
ListItem() {
Grid(this.gridScroller) {
LazyForEach(this.numbers, (item: number) => {
GridItem() {
Text(item + '')
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height('100%')
.textAlign(TextAlign.Center)
}
.width('100%')
.height(40)
.shadow({ radius: 10, color: '#909399', offsetX: 1, offsetY: 1 })
.borderRadius(10)
.translate({ x: 0, y: this.translateY })
}, (item: string) => item)
}
.columnsTemplate('1fr 1fr')
.friction(0.3)
.columnsGap(15)
.rowsGap(10)
.scrollBar(BarState.Off)
.width('100%')
.height('100%')
.layoutDirection(GridDirection.Column)
.nestedScroll({
scrollForward: NestedScrollMode.PARENT_FIRST,
scrollBackward: NestedScrollMode.SELF_FIRST
})
.onTouch((event: TouchEvent) => {
if (event.type == TouchType.Down) {
this.listTouchDown = true;
} else if (event.type == TouchType.Up) {
this.listTouchDown = false;
}
})
}
}
.scrollBar(BarState.Off)
.edgeEffect(EdgeEffect.None)
.onTouch((event: TouchEvent) => {
if (event.type == TouchType.Down) {
this.touchDown = true;
} else if (event.type == TouchType.Up) {
this.touchDown = false;
}
})
.onScrollFrameBegin((offset: number, state: ScrollState) => {
if (this.scrolling && offset > 0) {
let newOffset = this.scroller.currentOffset().yOffset;
if (newOffset >= 590) {
this.gridScroller.scrollBy(0, offset);
return { offsetRemain: 0 };
} else if (newOffset + offset > 590) {
this.gridScroller.scrollBy(0, newOffset + offset - 590);
return { offsetRemain: 590 - newOffset };
}
}
return { offsetRemain: offset };
})
.onScrollStart(() => {
if (this.touchDown && !this.listTouchDown) {
this.scrolling = true;
}
})
.onScrollStop(() => {
this.scrolling = false;
})
}
.width('100%')
.height('100%')
.padding({ left: 10, right: 10 })
}
Row() {
Text('Top')
.width(30)
.height(30)
.borderRadius(50)
}
.padding(5)
.borderRadius(50)
.backgroundColor('#ffffff')
.shadow({ radius: 10, color: '#909399', offsetX: 1, offsetY: 1 })
.margin({ right: 22, bottom: 15 })
.onClick(() => {
this.scroller.scrollTo({ xOffset: 0, yOffset: 0 });
this.gridScroller.scrollTo({ xOffset: 0, yOffset: 0 });
})
}
.align(Alignment.BottomEnd)
}
}
示例5（Grid拖拽场景）
- 设置属性editMode(true)设置Grid是否进入编辑模式，进入编辑模式可以拖拽Grid组件内部GridItem。
- 在onItemDragStart回调中设置拖拽过程中显示的图片。
- 在onItemDrop中获取拖拽起始位置，和拖拽插入位置，并在onItemDrop中完成交换数组位置逻辑。
说明：
预览器窗口不支持显示拖拽跟手。
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
numbers: GridDataSource = new GridDataSource([]);
scroller: Scroller = new Scroller();
@State text: string = 'drag';
@Builder pixelMapBuilder() { //拖拽过程样式
Column() {
Text(this.text)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width(80)
.height(80)
.textAlign(TextAlign.Center)
}
}
aboutToAppear() {
let list: string[] = [];
for (let i = 1; i <= 15; i++) {
list.push(i + '');
}
this.numbers = new GridDataSource(list);
}
changeIndex(index1: number, index2: number) { //交换数组位置
this.numbers.swapItem(index1, index2);
}
build() {
Column({ space: 5 }) {
Grid(this.scroller) {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width(80)
.height(80)
.textAlign(TextAlign.Center)
}
}, (day: string) => day)
}
.columnsTemplate('1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
.editMode(true) //设置Grid是否进入编辑模式，进入编辑模式可以拖拽Grid组件内部GridItem
.onItemDragStart((event: ItemDragInfo, itemIndex: number) => { //第一次拖拽此事件绑定的组件时，触发回调。
this.text = this.numbers.getData(itemIndex);
return this.pixelMapBuilder(); //设置拖拽过程中显示的图片。
})
.onItemDrop((event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => { //绑定此事件的组件可作为拖拽释放目标，当在本组件范围内停止拖拽行为时，触发回调。
// isSuccess=false时，说明drop的位置在grid外部；insertIndex > length时，说明有新增元素的事件发生
if (!isSuccess||insertIndex >= this.numbers.totalCount()) {
return;
}
console.info('beixiang' + itemIndex + '', insertIndex + ''); //itemIndex拖拽起始位置，insertIndex拖拽插入位置
this.changeIndex(itemIndex, insertIndex);
})
}.width('100%').margin({ top: 5 })
}
}
示例图：
网格子组件开始拖拽：
网格子组件拖拽过程中：
网格子组件1与子组件6拖拽交换位置后：
示例6（自适应Grid）
layoutDirection、maxCount、minCount、cellLength的使用。
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
numbers: GridDataSource = new GridDataSource([]);
aboutToAppear() {
let list: string[] = [];
for (let i = 1; i <= 30; i++) {
list.push(i + '');
}
this.numbers = new GridDataSource(list);
}
build() {
Scroll() {
Column({ space: 5 }) {
Blank()
Text('rowsTemplate、columnsTemplate都不设置layoutDirection、maxCount、minCount、cellLength才生效')
.fontSize(15).fontColor(0xCCCCCC).width('90%')
Grid() {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day).fontSize(16).backgroundColor(0xF9CF93)
}.width(40).height(80).borderWidth(2).borderColor(Color.Red)
}, (day: string) => day)
}
.height(300)
.columnsGap(10)
.rowsGap(10)
.backgroundColor(0xFAEEE0)
.maxCount(6)
.minCount(2)
.cellLength(0)
.layoutDirection(GridDirection.Row)
}
.width('90%').margin({ top: 5, left: 5, right: 5 })
.align(Alignment.Center)
}
}
}
示例7（双指缩放修改Grid列数）
双指缩放修改Grid列数。
// xxx.ets
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
numbers: GridDataSource = new GridDataSource([]);
@State columns: number = 2;
aboutToAppear() {
let lastCount = AppStorage.get<number>('columnsCount');
if (typeof lastCount != 'undefined') {
this.columns = lastCount;
}
let list: string[] = [];
for (let i = 0; i < 20; i++) {
for (let j = 0; j < 20; j++) {
list.push(j.toString());
}
}
this.numbers = new GridDataSource(list);
}
build() {
Column({ space: 5 }) {
Row() {
Text('双指缩放改变列数')
.height('5%')
.margin({ top: 10, left: 20 })
}
Grid() {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}, (index: number) => index.toString())
}
.columnsTemplate('1fr '.repeat(this.columns))
.columnsGap(10)
.rowsGap(10)
.width('90%')
.scrollBar(BarState.Off)
.backgroundColor(0xFAEEE0)
.height('100%')
.cachedCount(3)
// 切换列数item位置重排动画
.animation({
duration: 300,
curve: Curve.Smooth
})
.priorityGesture(
PinchGesture()
.onActionEnd((event: GestureEvent) => {
console.info('end scale:' + event.scale);
// 手指分开，减少列数以放大Item，触发阈值可以自定义，示例为2
if (event.scale > 2) {
this.columns--;
} else if (event.scale < 0.6) {
this.columns++;
}
// 可以根据设备屏幕宽度设定最大和最小列数，此处以最小1列最大4列为例
this.columns = Math.min(4, Math.max(1, this.columns));
AppStorage.setOrCreate<number>('columnsCount', this.columns);
})
)
}.width('100%').margin({ top: 5 })
}
}
示例8（设置自适应列数）
属性columnsTemplate中auto-fill、auto-fit和auto-stretch的使用示例。
@Entry
@Component
struct GridColumnsTemplate {
data: number[] = [0, 1, 2, 3, 4, 5];
data1: number[] = [0, 1, 2, 3, 4, 5];
data2: number[] = [0, 1, 2, 3, 4, 5];
build() {
Column({ space: 10 }) {
Text('auto-fill 根据设定的列宽自动计算列数').width('90%')
Grid() {
ForEach(this.data, (item: number) => {
GridItem() {
Text('N' + item).height(80)
}
.backgroundColor(Color.Orange)
})
}
.width('90%')
.border({ width: 1, color: Color.Black })
.columnsTemplate('repeat(auto-fill, 70)')
.columnsGap(10)
.rowsGap(10)
.height(150)
Text('auto-fit 先根据设定的列宽计算列数，余下的空间会均分到每一列中').width('90%')
Grid() {
ForEach(this.data1, (item: number) => {
GridItem() {
Text('N' + item).height(80)
}
.backgroundColor(Color.Orange)
})
}
.width('90%')
.border({ width: 1, color: Color.Black })
.columnsTemplate('repeat(auto-fit, 70)')
.columnsGap(10)
.rowsGap(10)
.height(150)
Text('auto-stretch 先根据设定的列宽计算列数，余下的空间会均分到每个列间距中').width('90%')
Grid() {
ForEach(this.data2, (item: number) => {
GridItem() {
Text('N' + item).height(80)
}
.backgroundColor(Color.Orange)
})
}
.width('90%')
.border({ width: 1, color: Color.Black })
.columnsTemplate('repeat(auto-stretch, 70)')
.columnsGap(10)
.rowsGap(10)
.height(150)
}
.width('100%')
.height('100%')
}
}
示例9（以当前行最高的GridItem的高度为其他GridItem的高度）
下面的Grid中包含两列，每列中的GridItem包括高度确定的两个Column和一个高度不确定的Text共三个子组件。
在默认情况下，左右两个GridItem的高度可能是不同的；在设置了Grid的alignItems属性为GridItemAlignment.STRETCH后，一行左右两个GridItem中原本高度较小的GridItem会以另一个高度较大的GridItem的高度作为自己的高度。
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct Index {
data: GridDataSource = new GridDataSource([]);
@State items: number[] = [];
aboutToAppear(): void {
let list: string[] = [];
for (let i = 0; i < 100; i++) {
list.push(i.toString());
this.items.push(this.getSize());
}
this.data= new GridDataSource(list);
}
getSize() {
let ret = Math.floor(Math.random() * 5);
return Math.max(1, ret);
}
build() {
Column({ space: 10 }) {
Text('Grid alignItems示例代码')
Grid() {
LazyForEach(this.data, (item: number) => {
// GridItem和Column不设置高度，默认会自适应子组件大小，设置STRETCH的场景下，会变成与当前行最高节点同高。
// 若设置高度，则会保持已设置的高度，不会与当前行最高节点同高。
GridItem() {
Column() {
Column().height(100).backgroundColor('#D5D5D5').width('100%')
// 中间的Text设置flexGrow(1)来自适应填满父组件的空缺
Text('这是一段文字。'.repeat(this.items[item]))
.flexGrow(1).width('100%').align(Alignment.TopStart)
.backgroundColor('#F7F7F7')
Column().height(50).backgroundColor('#707070').width('100%')
}
}
.border({ color: Color.Black, width: 1 })
})
}
.columnsGap(10)
.rowsGap(5)
.columnsTemplate('1fr 1fr')
.width('80%')
.height('100%')
// Grid设置alignItems为STRETCH，以当前行最高的GridItem的高度为其他GridItem的高度。
.alignItems(GridItemAlignment.STRETCH)
.scrollBar(BarState.Off)
}
.height('100%')
.width('100%')
}
}
示例10（设置边缘渐隐）
通过fadingEdge属性来设置边缘渐隐效果。
// xxx.ets
//该示例实现了Grid组件开启边缘渐隐效果并设置边缘渐隐长度
import { LengthMetrics } from '@kit.ArkUI';
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
numbers: GridDataSource = new GridDataSource([]);
scroller: Scroller = new Scroller();
aboutToAppear() {
let list: string[] = [];
for (let i = 0; i <= 10; i++) {
for (let j = 0; j < 5; j++) {
list.push(j.toString());
}
}
this.numbers = new GridDataSource(list);
}
build() {
Column({ space: 5 }) {
Text('scroll').fontColor(0xCCCCCC).fontSize(9).width('90%')
Grid(this.scroller) {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}, (index: number) => index.toString())
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(20)
.height('90%')
.fadingEdge(true, { fadingEdgeLength: LengthMetrics.vp(80) })
}.width('100%').margin({ top: 5 })
}
}
示例11（单边边缘效果）
该示例通过edgeEffect接口，实现了Grid组件设置单边边缘效果。
// xxx.ets
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridExample {
numbers: GridDataSource = new GridDataSource([]);
scroller: Scroller = new Scroller();
aboutToAppear() {
let list: string[] = [];
for (let i = 0; i <= 10; i++) {
for (let j = 0; j < 5; j++) {
list.push(j.toString());
}
}
this.numbers = new GridDataSource(list);
}
build() {
Column({ space: 5 }) {
Grid(this.scroller) {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}, (index: number) => index.toString())
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(20)
.edgeEffect(EdgeEffect.Spring, { alwaysEnabled: true, effectEdge: EffectEdge.START })
.width('90%')
.backgroundColor(0xDCDCDC)
.height('80%')
}.width('100%').margin({ top: 5 })
}
}
示例12（方向键走焦换行模式）
该示例通过focusWrapMode接口，实现了Grid组件方向键走焦换行效果。
// xxx.ets
@Entry
@Component
struct GridExample {
scroller: Scroller = new Scroller()
build() {
Column() {
Grid(this.scroller) {
GridItem() {
Text('A')
.focusable(true)
.fontSize(18)
.fontWeight(5)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
GridItem() {
Text('B')
.focusable(true)
.fontSize(18)
.fontWeight(5)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
GridItem() {
Text('C')
.focusable(true)
.fontSize(18)
.fontWeight(5)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
GridItem() {
Text('D')
.focusable(true)
.fontSize(18)
.fontWeight(5)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
GridItem() {
Text('E')
.focusable(true)
.fontSize(18)
.fontWeight(5)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
GridItem() {
Text('F')
.focusable(true)
.fontSize(18)
.fontWeight(5)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}
.focusWrapMode(FocusWrapMode.WRAP_WITH_ARROW)
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(20)
.backgroundColor(0xDCDCDC)
}.width('100%').margin({ top: 5 })
}
}
示例13（滚动事件）
import { NodeController, FrameNode, typeNode } from '@kit.ArkUI';
class MyNodeController extends NodeController {
public rootNode: FrameNode|null = null;
makeNode(uiContext: UIContext): FrameNode|null {
this.rootNode = new FrameNode(uiContext);
this.rootNode.commonAttribute.width(100)
return this.rootNode;
}
addCommonEvent(frameNode: FrameNode) {
let gridEvent: UIGridEvent|undefined = typeNode.getEvent(frameNode, "Grid");
gridEvent?.setOnWillScroll((scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => {
console.log(`onWillScroll scrollOffset = ${scrollOffset}, scrollState = ${scrollState}, scrollSource = ${scrollSource}`)
})
gridEvent?.setOnDidScroll((scrollOffset: number, scrollState: ScrollState) => {
console.log(`onDidScroll scrollOffset = ${scrollOffset}, scrollState = ${scrollState}`)
})
gridEvent?.setOnReachStart(() => {
console.log(`onReachStart`)
})
gridEvent?.setOnReachEnd(() => {
console.log(`onReachEnd`)
})
gridEvent?.setOnScrollStart(() => {
console.log(`onScrollStart`)
})
gridEvent?.setOnScrollStop(() => {
console.log(`onScrollStop`)
})
gridEvent?.setOnScrollFrameBegin((offset: number, state: ScrollState) => {
console.log(`onScrollFrameBegin offset = ${offset}, state = ${state}`)
return undefined;
})
gridEvent?.setOnScrollIndex((first: number, last: number) => {
console.log(`onScrollIndex start = ${first}, end = ${last}`)
})
}
}
@Entry
@Component
struct Index {
@State index: number = 0;
private myNodeController: MyNodeController = new MyNodeController();
@State numbers: string[] = []
aboutToAppear() {
for (let i = 0; i < 5; i++) {
for (let j = 0; j < 5; j++) {
this.numbers.push(j.toString());
}
}
}
build() {
Column() {
Button("add CommonEvent to Grid")
.onClick(() => {
this.myNodeController!.addCommonEvent(this.myNodeController!.rootNode!.getParent()!.getPreviousSibling()!)
})
Grid() {
ForEach(this.numbers, (day: string, index: number) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}, (day: string, index: number) => index.toString() + day)
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.enableScrollInteraction(true)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
NodeContainer(this.myNodeController)
}.width("100%")
}
}
示例14（滚动到指定位置）
该示例通过scrollToIndex接口，实现了Grid组件滚动到指定位置。
import { GridDataSource } from './GridDataSource';
@Entry
@Component
struct GridScrollToIndexSample {
numbers: GridDataSource = new GridDataSource([]);
scroller: Scroller = new Scroller();
aboutToAppear(): void {
let list: string[] = [];
for (let i = 0; i < 10; i++) {
for (let j = 0; j < 10; j++) {
list.push((i * 5 + j + 1).toString());
}
}
this.numbers = new GridDataSource(list);
}
build() {
Column({ space: 5 }) {
Button('scrollToIndex')
.onClick(() => { // 滚动到对应的位置
this.scroller.scrollToIndex(25, true, ScrollAlign.START);
})
Grid(this.scroller) {
LazyForEach(this.numbers, (day: string) => {
GridItem() {
Text(day)
.fontSize(16)
.backgroundColor(0xF9CF93)
.width('100%')
.height(80)
.textAlign(TextAlign.Center)
}
}, (index: number) => index.toString())
}
.columnsTemplate('1fr 1fr 1fr 1fr 1fr')
.columnsGap(10)
.rowsGap(10)
.friction(0.6)
.enableScrollInteraction(true)
.supportAnimation(false)
.multiSelectable(false)
.edgeEffect(EdgeEffect.Spring)
.scrollBar(BarState.On)
.scrollBarColor(Color.Grey)
.scrollBarWidth(4)
.width('90%')
.backgroundColor(0xFAEEE0)
.height(300)
}.width('100%').margin({ top: 5 })
}
}
你可能感兴趣的鸿蒙文章
- 所属分类： 后端技术
- 本文标签：
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦