StaggeredGridCells

public interface StaggeredGridCells

This class describes the count and the sizes of columns in vertical staggered grids, or rows in horizontal staggered grids.

Functions

calculateCrossAxisCellSizes

public fun Density.calculateCrossAxisCellSizes(availableSize: Int, spacing: Int): IntArray

Calculates the number of cells and their cross axis size based on availableSize and spacing.

For example, in vertical grids, spacing is passed from the grid's Arrangement.Horizontal. The Arrangement.Horizontal will also be used to arrange items in a row if the grid is wider than the calculated sum of columns.

Note that the calculated cross axis sizes will be considered in an RTL-aware manner -- if the staggered grid is vertical and the layout direction is RTL, the first width in the returned list will correspond to the rightmost column.

Parameters

Members

Fixed

public class Fixed(private val count: Int) : StaggeredGridCells

Defines a grid with fixed number of rows or columns.

For example, for the vertical LazyVerticalStaggeredGrid Fixed(3) would mean that there are 3 columns 1/3 of the parent width.

Functions

calculateCrossAxisCellSizes

override fun Density.calculateCrossAxisCellSizes(
            availableSize: Int,
            spacing: Int,
        ): IntArray

hashCode

override fun hashCode(): Int

equals

override fun equals(other: Any?): Boolean

Adaptive

public class Adaptive(private val minSize: Dp) : StaggeredGridCells

Defines a grid with as many rows or columns as possible on the condition that every cell has at least minSize space and all extra space distributed evenly.

For example, for the vertical LazyVerticalStaggeredGrid Adaptive(20.dp) would mean that there will be as many columns as possible and every column will be at least 20.dp and all the columns will have equal width. If the screen is 88.dp wide then there will be 4 columns 22.dp each.

Functions

calculateCrossAxisCellSizes

override fun Density.calculateCrossAxisCellSizes(
            availableSize: Int,
            spacing: Int,
        ): IntArray

hashCode

override fun hashCode(): Int

equals

override fun equals(other: Any?): Boolean

FixedSize

public class FixedSize(private val size: Dp) : StaggeredGridCells

Defines a grid with as many rows or columns as possible on the condition that every cell takes exactly size space. The remaining space will be arranged through LazyStaggeredGrid arrangements on corresponding axis. If size is larger than container size, the cell will be size to match the container.

For example, for the vertical LazyVerticalStaggeredGrid FixedSize(20.dp) would mean that there will be as many columns as possible and every column will be exactly 20.dp. If the screen is 88.dp wide tne there will be 4 columns 20.dp each with remaining 8.dp distributed through Arrangement.Horizontal.

Functions

calculateCrossAxisCellSizes

override fun Density.calculateCrossAxisCellSizes(
            availableSize: Int,
            spacing: Int,
        ): IntArray

hashCode

override fun hashCode(): Int

equals

override fun equals(other: Any?): Boolean