Flex/com.j0y.flex

Package-level declarations

Types

Aligns flex lines when there is extra space on the cross axis. Only has effect when FlexWrap is not FlexWrap.NoWrap and there are multiple lines. Mirrors CSS align-content.

AlignItems

enum AlignItems : Enum<AlignItems>

Aligns flex items along the cross axis. Mirrors CSS align-items.

AlignSelf

enum AlignSelf : Enum<AlignSelf>

Overrides AlignItems for individual flex items. Mirrors CSS align-self.

FlexBasis

sealed class FlexBasis

Represents the flex-basis value, which can be auto, an explicit size, or a percentage.

FlexboxCalculator

class FlexboxCalculator(val containerStyle: FlexContainerStyle)

Kotlin/Native entry point for iOS consumers that want to use the Flex flexbox algorithm from SwiftUI's Layout protocol.

FlexboxEngine

object FlexboxEngine

FlexBoxScope

class FlexBoxScope

Scope for FlexBox content — provides Modifier.flexItem to configure per-child flex properties.

FlexboxSwiftItem

data class FlexboxSwiftItem(val style: FlexItemStyle, val preferredWidth: Float, val preferredHeight: Float)

Describes a flex item for use from Swift when implementing SwiftUI's Layout protocol.

FlexContainerStyle

data class FlexContainerStyle(val flexDirection: FlexDirection = FlexDirection.Row, val flexWrap: FlexWrap = FlexWrap.NoWrap, val justifyContent: JustifyContent = JustifyContent.FlexStart, val alignItems: AlignItems = AlignItems.Stretch, val alignContent: AlignContent = AlignContent.Stretch, val rowGap: Float = 0.0f, val columnGap: Float = 0.0f, val overflow: Overflow = Overflow.Visible)

Holds the flex layout properties for a flex container.

FlexDirection

enum FlexDirection : Enum<FlexDirection>

Defines the direction flex items are placed in the flex container. Mirrors CSS flex-direction.

FlexItemInput

data class FlexItemInput(val style: FlexItemStyle, val measurer: FlexMeasurer)

Input descriptor for a single flex item.

FlexItemLayout

data class FlexItemLayout(val x: Float, val y: Float, val width: Float, val height: Float)

Layout result for a single flex item — all values are in pixels from the container's top-left.

FlexItemStyle

data class FlexItemStyle(val order: Int = 0, val flexGrow: Float = 0.0f, val flexShrink: Float = 1.0f, val flexBasis: FlexBasis = FlexBasis.Auto, val alignSelf: AlignSelf = AlignSelf.Auto, val position: Position = Position.Static)

Holds the flex layout properties for a flex item.

FlexMeasurer

fun interface FlexMeasurer

Callback used by FlexboxEngine to determine an item's size.

FlexWrap

enum FlexWrap : Enum<FlexWrap>

Controls whether flex items are forced onto a single line or can wrap. Mirrors CSS flex-wrap.

JustifyContent

enum JustifyContent : Enum<JustifyContent>

Aligns flex items along the main axis. Mirrors CSS justify-content.

Overflow

enum Overflow : Enum<Overflow>

Controls how content that overflows the flex container is handled. Mirrors CSS overflow.

Position

sealed interface Position

Defines how a flex item is positioned within or relative to the flex container. Mirrors CSS position.

Functions

FlexBox

@Composable

fun FlexBox(modifier: Modifier = Modifier, containerStyle: FlexContainerStyle = FlexContainerStyle(), content: @Composable FlexBoxScope.() -> Unit)

A composable that lays out its content children following CSS Flexbox rules.

@Composable

fun FlexBox(modifier: Modifier = Modifier, flexDirection: FlexDirection = FlexDirection.Row, flexWrap: FlexWrap = FlexWrap.NoWrap, justifyContent: JustifyContent = JustifyContent.FlexStart, alignItems: AlignItems = AlignItems.Stretch, alignContent: AlignContent = AlignContent.Stretch, rowGap: Float = 0.0f, columnGap: Float = 0.0f, overflow: Overflow = Overflow.Visible, content: @Composable FlexBoxScope.() -> Unit)

Overload of FlexBox that accepts FlexContainerStyle parameters directly instead of a pre-built FlexContainerStyle instance.

withGap

fun FlexContainerStyle.withGap(gap: Float): FlexContainerStyle

Returns a copy of this style with both FlexContainerStyle.rowGap and FlexContainerStyle.columnGap set to gap. Mirrors CSS gap: <length>.