FlexBoxConfigScope

Artifact: androidx.compose.foundation:foundation-layout

View Source

Added in 1.11.0-alpha04

Common/AllAndroid/JVM

• Cmn

  @ExperimentalFlexBoxApi
  sealed interface FlexBoxConfigScope : Density

---

Scope for configuring FlexBox container properties.

Properties are read during the layout/measure phase, not during composition. Changes to state-backed properties trigger relayout, not recomposition.

See also
FlexBoxConfig

Summary

Public functions
Unit	alignItemsToBaseline(alignmentLine: AlignmentLine) Aligns items to a specific baseline.	Cmn
Unit	alignItemsToBaseline(alignmentLineBlock: (Measured) -> Int) Aligns items to a custom baseline.	Cmn
Unit	gap(value: Dp) Convenience function to set both rowGap and columnGap to the same value.	Cmn

Public properties
FlexAlignContent	alignContent How multiple lines are aligned along the cross axis.	Cmn
FlexAlignItems	alignItems Default alignment for children along the cross axis within each line.	Cmn
Dp	columnGap Horizontal spacing between columns of items.	Cmn
Constraints	constraints The layout constraints passed to this FlexBox from its parent.	Cmn
FlexDirection	direction The direction of the main axis along which children are laid out.	Cmn
FlexJustifyContent	justifyContent How children are distributed along the main axis.	Cmn
Dp	rowGap Vertical spacing between items (in Column) or lines (in Row with wrap).	Cmn
FlexWrap	wrap Whether children should wrap to new lines when they exceed the main axis size.	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

alignItemsToBaseline

Cmn

Added in 1.11.0-alpha04

fun alignItemsToBaseline(alignmentLine: AlignmentLine): Unit

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

Example:

FlexBox(
    flexBoxConfig = {
        alignItemsToBaseline(FirstBaseline)
        // or
        alignItemsToBaseline(LastBaseline)
        // or custom
        alignItemsToBaseline { measured ->
            measured[FirstBaseline] + 10
        }
    }
)

alignItemsToBaseline

Cmn

Added in 1.11.0-alpha04

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

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

gap

Cmn

Added in 1.11.0-alpha04

fun gap(value: Dp): Unit

Convenience function to set both rowGap and columnGap to the same value.

Parameters
value: Dp	The gap size to apply to both row and column gaps.

Public properties

alignContent

Cmn

var alignContent: FlexAlignContent

How multiple lines are aligned along the cross axis. Only applies when wrap is FlexWrap.Wrap or FlexWrap.WrapReverse with multiple lines.

alignItems

Cmn

var alignItems: FlexAlignItems

Default alignment for children along the cross axis within each line. Can be overridden per-child using FlexConfigScope.alignSelf.

columnGap

Cmn

var columnGap: Dp

Horizontal spacing between columns of items.

constraints

Cmn

val constraints: Constraints

The layout constraints passed to this FlexBox from its parent.

These constraints represent the minimum and maximum size limits that the parent has imposed on this FlexBox. This can be useful for creating responsive layouts that adapt based on available space.

See also
Constraints

direction

Cmn

var direction: FlexDirection

The direction of the main axis along which children are laid out.

justifyContent

Cmn

var justifyContent: FlexJustifyContent

How children are distributed along the main axis.

rowGap

Cmn

var rowGap: Dp

Vertical spacing between items (in Column) or lines (in Row with wrap).

wrap

Cmn

var wrap: FlexWrap

Whether children should wrap to new lines when they exceed the main axis size.