Skip to content

Alignment

@Stable



fun interface Alignment

An interface to calculate the position of a sized box inside an available space. Alignment is often used to define the alignment of a layout inside a parent layout.

See also

Inheritors

Types

Companion

object Companion

A collection of common Alignments aware of layout direction.

Horizontal

@Stable



fun interface Horizontal

An interface to calculate the position of box of a certain width inside an available width. Alignment.Horizontal is often used to define the horizontal alignment of a layout inside a parent layout.

Vertical

@Stable



fun interface Vertical

An interface to calculate the position of a box of a certain height inside an available height. Alignment.Vertical is often used to define the vertical alignment of a layout inside a parent layout.

Functions

align

abstract fun align(
    size: IntSize, 
    space: IntSize, 
    layoutDirection: LayoutDirection
): IntOffset

Calculates the position of a box of size size relative to the top left corner of an area of size space. The returned offset can be negative or larger than space - size, meaning that the box will be positioned partially or completely outside the area.