{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

StaggeredGridCells

public interface StaggeredGridCells

Known direct subclasses
StaggeredGridCells.Adaptive

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.

StaggeredGridCells.FixedSize

Defines a grid with as many rows or columns as possible on the condition that every cell takes exactly size space.

StaggeredGridCells.Fixed

Defines a grid with fixed number of rows or columns.


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

Summary

Nested types

public final class StaggeredGridCells.Adaptive implements 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.

public final class StaggeredGridCells.Fixed implements StaggeredGridCells

Defines a grid with fixed number of rows or columns.

public final class StaggeredGridCells.FixedSize implements StaggeredGridCells

Defines a grid with as many rows or columns as possible on the condition that every cell takes exactly size space.

Public methods

abstract @NonNull int[]
calculateCrossAxisCellSizes(
    @NonNull Density receiver,
    int availableSize,
    int spacing
)

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

Public methods

calculateCrossAxisCellSizes

abstract @NonNull int[] calculateCrossAxisCellSizes(
    @NonNull Density receiver,
    int availableSize,
    int spacing
)

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
int availableSize

available size on cross axis, e.g. width of LazyVerticalStaggeredGrid.

int spacing

cross axis spacing, e.g. horizontal spacing for LazyVerticalStaggeredGrid. The spacing is passed from the corresponding Arrangement param of the lazy grid.