GridConfigurationScope

Artifact: androidx.compose.foundation:foundation-layout

View Source

Added in 1.11.0-alpha04

Common/AllAndroid/JVM

• Cmn

  @LayoutScopeMarker
  @ExperimentalGridApi
  interface GridConfigurationScope : Density

---

Scope for configuring the structure of a Grid.

This interface is implemented by the configuration block in Grid. It allows defining columns, rows, and gaps.

Summary

Public functions
Unit	column(percentage: Float) Defines a percentage-based column.	Cmn
Unit	column(size: Dp) Defines a fixed-width column.	Cmn
Unit	column(size: GridTrackSize) Defines a new column track with the specified size.	Cmn
Unit	column(weight: Fr) Defines a flexible column.	Cmn
Unit	columnGap(gap: Dp) Sets the gap (gutter) size between columns.	Cmn
Unit	gap(all: Dp) Sets both the row and column gaps (gutters) to all.	Cmn
Unit	gap(row: Dp, column: Dp) Sets independent gaps for rows and columns.	Cmn
Unit	row(percentage: Float) Defines a percentage-based row.	Cmn
Unit	row(size: Dp) Defines a fixed-width row.	Cmn
Unit	row(size: GridTrackSize) Defines a new row track with the specified size.	Cmn
Unit	row(weight: Fr) Defines a flexible row.	Cmn
Unit	rowGap(gap: Dp) Sets the gap (gutter) size between rows.	Cmn

Public properties
GridFlow	flow The direction in which items that do not specify a position are placed.	Cmn
open Fr	@ExperimentalGridApi Double.fr Creates an Fr unit from a Double.	Cmn
open Fr	@ExperimentalGridApi Float.fr Creates an Fr unit from a Float.	Cmn
open Fr	@ExperimentalGridApi Int.fr Creates an Fr unit from an Int.	Cmn

Extension functions
Unit	@ExperimentalGridApi GridConfigurationScope.columns(vararg specs: GridTrackSpec) Adds multiple columns with the specified specs.	Cmn
Unit	@ExperimentalGridApi GridConfigurationScope.rows(vararg specs: GridTrackSpec) Adds multiple rows with the specified specs.	Cmn

Inherited functions
From androidx.compose.ui.unit.Density open Int Dp.roundToPx() Convert Dp to Int by rounding Cmn open Int TextUnit.roundToPx() Convert Sp to Int by rounding Cmn open Dp Int.toDp() Convert an Int pixel value to Dp. Cmn open Dp Float.toDp() Convert a Float pixel value to a Dp Cmn open DpSize Size.toDpSize() Convert a Size to a DpSize. Cmn open Float Dp.toPx() Convert Dp to pixels. Cmn open Float TextUnit.toPx() Convert Sp to pixels. Cmn open Rect DpRect.toRect() Convert a DpRect to a Rect. Cmn open Size DpSize.toSize() Convert a DpSize to a Size. Cmn open TextUnit Int.toSp() Convert an Int pixel value to Sp. Cmn open TextUnit Float.toSp() Convert a Float pixel value to a Sp Cmn
From androidx.compose.ui.unit.FontScaling open Dp TextUnit.toDp() Convert Sp to Dp. Cmn open TextUnit Dp.toSp() Convert Dp to Sp. Cmn

Inherited properties
From androidx.compose.ui.unit.Density Float density The logical density of the display. Cmn
From androidx.compose.ui.unit.FontScaling Float fontScale Current user preference for the scaling factor for fonts. Cmn

Public functions

column

Cmn

Added in 1.11.0-alpha04

fun column(percentage: Float): Unit

Defines a percentage-based column. Maps to GridTrackSize.Percentage.

column

Cmn

Added in 1.11.0-alpha04

fun column(size: Dp): Unit

Defines a fixed-width column. Maps to GridTrackSize.Fixed.

column

Cmn

Added in 1.11.0-alpha04

fun column(size: GridTrackSize): Unit

Defines a new column track with the specified size.

column

Cmn

Added in 1.11.0-alpha04

fun column(weight: Fr): Unit

Defines a flexible column. Maps to GridTrackSize.Flex.

columnGap

Cmn

Added in 1.11.0-alpha04

fun columnGap(gap: Dp): Unit

Sets the gap (gutter) size between columns.

Precedence: If this is called multiple times, the last call takes precedence. This call will overwrite the column component of any previous gap call.

Throws
kotlin.IllegalArgumentException	if gap is negative.

gap

Cmn

Added in 1.11.0-alpha04

fun gap(all: Dp): Unit

Sets both the row and column gaps (gutters) to all.

Precedence: If this is called multiple times, or mixed with columnGap or rowGap, the last call takes precedence.

Throws
kotlin.IllegalArgumentException	if all is negative.

gap

Cmn

Added in 1.11.0-alpha04

fun gap(row: Dp, column: Dp): Unit

Sets independent gaps for rows and columns.

Precedence: If this is called multiple times, or mixed with columnGap or rowGap, the last call takes precedence.

Throws
kotlin.IllegalArgumentException	if row or column is negative.

row

Cmn

Added in 1.11.0-alpha04

fun row(percentage: Float): Unit

Defines a percentage-based row. Maps to GridTrackSize.Percentage.

row

Cmn

Added in 1.11.0-alpha04

fun row(size: Dp): Unit

Defines a fixed-width row. Maps to GridTrackSize.Fixed.

row

Cmn

Added in 1.11.0-alpha04

fun row(size: GridTrackSize): Unit

Defines a new row track with the specified size.

row

Cmn

Added in 1.11.0-alpha04

fun row(weight: Fr): Unit

Defines a flexible row. Maps to GridTrackSize.Flex.

rowGap

Cmn

Added in 1.11.0-alpha04

fun rowGap(gap: Dp): Unit

Sets the gap (gutter) size between rows.

Precedence: If this is called multiple times, the last call takes precedence. This call will overwrite the row component of any previous gap call.

Throws
kotlin.IllegalArgumentException	if gap is negative.

Public properties

flow

Cmn

var flow: GridFlow

The direction in which items that do not specify a position are placed. Defaults to GridFlow.Row.

fr

Cmn

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalGridApi
open val Double.fr: Fr

Creates an Fr unit from a Double.

fr

Cmn

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalGridApi
open val Float.fr: Fr

Creates an Fr unit from a Float.

fr

Cmn

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalGridApi
open val Int.fr: Fr

Creates an Fr unit from an Int.

Extension functions

columns

Cmn

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalGridApi
fun GridConfigurationScope.columns(vararg specs: GridTrackSpec): Unit

Adds multiple columns with the specified specs.

rows

Cmn

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalGridApi
fun GridConfigurationScope.rows(vararg specs: GridTrackSpec): Unit

Adds multiple rows with the specified specs.