FlexConfigScope

Artifact: androidx.compose.foundation:foundation-layout

Cmn

@ExperimentalFlexBoxApi
sealed interface FlexConfigScope : Density

Scope for configuring flex item properties. Properties are read during the layout/measure phase, not during composition.

See also
`FlexConfig`

Summary

Public functions
`Unit`	`alignSelfToBaseline(alignmentLine: AlignmentLine)` Aligns items to a specific baseline.	Cmn
`Unit`	`alignSelfToBaseline(alignmentLineBlock: (Measured) -> Int)` Aligns items to a custom baseline.	Cmn
`Unit`	`basis(value: Dp)` Sets the `basis` to a fixed Dp value.	Cmn
`Unit`	`basis(value: @FloatRange(from = 0.0, to = 1.0) Float)` Sets the `basis` to a percentage of the container's main axis size.	Cmn

Public properties
`FlexAlignSelf`	`alignSelf` Overrides the container's `FlexBoxConfigScope.alignItems` for this specific item.	Cmn
`FlexBasis`	`basis` The initial main size of this item before flex distribution.	Cmn
`Int`	`flexBoxCrossAxisMax` The maximum size of the FlexBox container along the cross axis.	Cmn
`Int`	`flexBoxCrossAxisMin` The minimum size of the FlexBox container along the cross axis.	Cmn
`Int`	`flexBoxMainAxisMax` The maximum size of the FlexBox container along the main axis.	Cmn
`Int`	`flexBoxMainAxisMin` The minimum size of the FlexBox container along the main axis.	Cmn
`Float`	`grow` The flex grow factor.	Cmn
`Int`	`order` The visual order of this item relative to siblings.	Cmn
`Float`	`shrink` The flex shrink factor.	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

alignSelfToBaseline

Cmn

Added in 1.11.0-alpha04

fun alignSelfToBaseline(alignmentLine: AlignmentLine): Unit

Aligns items to a specific baseline. Overrides alignSelf when set.

alignSelfToBaseline

Cmn

Added in 1.11.0-alpha04

fun alignSelfToBaseline(alignmentLineBlock: (Measured) -> Int): Unit

Aligns items to a custom baseline. Overrides alignSelf when set.

basis

Cmn

Added in 1.11.0-alpha04

fun basis(value: Dp): Unit

Sets the basis to a fixed Dp value.

basis

Cmn

Added in 1.11.0-alpha04

fun basis(value: @FloatRange(from = 0.0, to = 1.0) Float): Unit

Sets the basis to a percentage of the container's main axis size.

Parameters
`value: @FloatRange(from = 0.0, to = 1.0) Float`	A value between 0.0 and 1.0 representing the percentage.

Public properties

alignSelf

Cmn

var alignSelf: FlexAlignSelf

Overrides the container's FlexBoxConfigScope.alignItems for this specific item.

basis

Cmn

var basis: FlexBasis

The initial main size of this item before flex distribution.

flexBoxCrossAxisMax

Cmn

Added in 1.11.0-alpha04

val flexBoxCrossAxisMax: Int

The maximum size of the FlexBox container along the cross axis.

This corresponds to Constraints.maxHeight if the direction is FlexDirection.Row or FlexDirection.RowReverse, and Constraints.maxWidth if the direction is FlexDirection.Column or FlexDirection.ColumnReverse.

flexBoxCrossAxisMin

Cmn

Added in 1.11.0-alpha04

val flexBoxCrossAxisMin: Int

The minimum size of the FlexBox container along the cross axis.

This corresponds to Constraints.minHeight if the direction is FlexDirection.Row or FlexDirection.RowReverse, and Constraints.minWidth if the direction is FlexDirection.Column or FlexDirection.ColumnReverse.

flexBoxMainAxisMax

Cmn

Added in 1.11.0-alpha04

val flexBoxMainAxisMax: Int

The maximum size of the FlexBox container along the main axis.

This corresponds to Constraints.maxWidth if the direction is FlexDirection.Row or FlexDirection.RowReverse, and Constraints.maxHeight if the direction is FlexDirection.Column or FlexDirection.ColumnReverse.

flexBoxMainAxisMin

Cmn

Added in 1.11.0-alpha04

val flexBoxMainAxisMin: Int

The minimum size of the FlexBox container along the main axis.

This corresponds to Constraints.minWidth if the direction is FlexDirection.Row or FlexDirection.RowReverse, and Constraints.minHeight if the direction is FlexDirection.Column or FlexDirection.ColumnReverse.

grow

Cmn

Added in 1.11.0-alpha04

var grow: Float

The flex grow factor.

When positive, the item grows to absorb free space along the main axis. Growth is proportional to this value relative to siblings' grow factors.

Note: Items will grow even with explicit size constraints. Set grow = 0f to prevent growth.

order

Cmn

Added in 1.11.0-alpha04

var order: Int

The visual order of this item relative to siblings. Items are sorted by order in ascending order before layout, with lower values appearing first. Items with the same order maintain their original declaration order.

Default is 0. Use negative values to move items before default-ordered items, or positive values to move items after.

shrink

Cmn

Added in 1.11.0-alpha04

var shrink: Float

The flex shrink factor.

When positive, the item can shrink if items exceed the container's main axis size. Shrinking is proportional to this value and the item's base size.

Note: Items will not shrink below their minimum intrinsic size. Items with explicit size modifiers will not shrink at all.