Google is committed to advancing racial equity for Black communities. See how.

Horizontal

@Immutable data class Horizontal : Alignment.Horizontal
kotlin.Any
   ↳ androidx.compose.ui.BiasAlignment.Horizontal

An Alignment.Horizontal specified by bias: for example, a bias of -1 represents alignment to the start, a bias of 0 will represent centering, and a bias of 1 will represent end. Any value can be specified to obtain an alignment. Inside the -1,1 range, the obtained alignment will position the aligned size fully inside the available space, while outside the range it will the aligned size will be positioned partially or completely outside.

Summary

Public constructors
<init>(bias: Float)

An Alignment.Horizontal specified by bias: for example, a bias of -1 represents alignment to the start, a bias of 0 will represent centering, and a bias of 1 will represent end.

Public methods
Int
align(size: Int, space: Int, layoutDirection: LayoutDirection)

Calculates the horizontal position of a box of width size relative to the left side of an area of width space.

Inherited functions

Public constructors

<init>

Horizontal(bias: Float)

An Alignment.Horizontal specified by bias: for example, a bias of -1 represents alignment to the start, a bias of 0 will represent centering, and a bias of 1 will represent end. Any value can be specified to obtain an alignment. Inside the -1,1 range, the obtained alignment will position the aligned size fully inside the available space, while outside the range it will the aligned size will be positioned partially or completely outside.

Public methods

align

fun align(
    size: Int,
    space: Int,
    layoutDirection: LayoutDirection
): Int

Calculates the horizontal position of a box of width size relative to the left side of an area of width 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.