StaggeredGridCells

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.3.0

Common/All

• Cmn

  interface StaggeredGridCells

Known direct subclasses

StaggeredGridCells.Adaptive, StaggeredGridCells.FixedSize, StaggeredGridCells.Fixed

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
class StaggeredGridCells.Adaptive : 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.
class StaggeredGridCells.Fixed : StaggeredGridCells Defines a grid with fixed number of rows or columns.
class StaggeredGridCells.FixedSize : StaggeredGridCells Defines a grid with as many rows or columns as possible on the condition that every cell takes exactly size space.

Public functions
IntArray	Density.calculateCrossAxisCellSizes(availableSize: Int, spacing: Int) Calculates the number of cells and their cross axis size based on availableSize and spacing.	Cmn

Public functions

calculateCrossAxisCellSizes

Cmn

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.3.0

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
availableSize: Int	available size on cross axis, e.g. width of LazyVerticalStaggeredGrid.
spacing: Int	cross axis spacing, e.g. horizontal spacing for LazyVerticalStaggeredGrid. The spacing is passed from the corresponding Arrangement param of the lazy grid.