ConstrainScope

Kotlin |Java

class ConstrainScope

kotlin.Any
↳	androidx.compose.foundation.layout.ConstrainScope

Scope used by Modifier.constrainAs.

Summary

Nested classes
inner	BaselineAnchorable Represents the FirstBaseline of a layout that can be anchored using linkTo in their Modifier.constrainAs blocks.
inner	HorizontalAnchorable Represents a horizontal side of a layout (i.
inner	VerticalAnchorable Represents a vertical side of a layout (i.

Public methods
Unit	centerAround(anchor: ConstraintLayoutBaseScope.VerticalAnchor) Adds start and end links towards a vertical anchor.
Unit	centerAround(anchor: ConstraintLayoutBaseScope.HorizontalAnchor) Adds top and bottom links towards a horizontal anchor.
Unit	centerHorizontallyTo(other: ConstrainedLayoutReference) Adds start and end links towards the corresponding anchors of other.
Unit	centerTo(other: ConstrainedLayoutReference) Adds all start, top, end, bottom links towards the corresponding anchors of other.
Unit	centerVerticallyTo(other: ConstrainedLayoutReference) Adds top and bottom links towards the corresponding anchors of other.
Unit	linkTo(start: ConstraintLayoutBaseScope.VerticalAnchor, end: ConstraintLayoutBaseScope.VerticalAnchor, startMargin: Dp = 0.dp, endMargin: Dp = 0.dp, @FloatRange(0.0, 1.0) bias: Float = 0.5f) Adds both start and end links towards other ConstraintLayoutBaseScope.HorizontalAnchors.
Unit	linkTo(top: ConstraintLayoutBaseScope.HorizontalAnchor, bottom: ConstraintLayoutBaseScope.HorizontalAnchor, topMargin: Dp = 0.dp, bottomMargin: Dp = 0.dp, @FloatRange(0.0, 1.0) bias: Float = 0.5f) Adds both top and bottom links towards other ConstraintLayoutBaseScope.HorizontalAnchors.
Unit	linkTo(start: ConstraintLayoutBaseScope.VerticalAnchor, top: ConstraintLayoutBaseScope.HorizontalAnchor, end: ConstraintLayoutBaseScope.VerticalAnchor, bottom: ConstraintLayoutBaseScope.HorizontalAnchor, startMargin: Dp = 0.dp, topMargin: Dp = 0.dp, endMargin: Dp = 0.dp, bottomMargin: Dp = 0.dp, @FloatRange(0.0, 1.0) horizontalBias: Float = 0.5f, @FloatRange(0.0, 1.0) verticalBias: Float = 0.5f) Adds all start, top, end, bottom links towards other ConstraintLayoutBaseScope.HorizontalAnchors.

Properties
ConstrainScope.VerticalAnchorable	absoluteLeft The left anchor of the layout - can be constrained using VerticalAnchorable.linkTo.
ConstrainScope.VerticalAnchorable	absoluteRight The right anchor of the layout - can be constrained using VerticalAnchorable.linkTo.
ConstrainScope.BaselineAnchorable	baseline The FirstBaseline of the layout - can be constrained using BaselineAnchorable.linkTo.
ConstrainScope.HorizontalAnchorable	bottom The bottom anchor of the layout - can be constrained using HorizontalAnchorable.linkTo.
ConstrainScope.VerticalAnchorable	end The end anchor of the layout - can be constrained using VerticalAnchorable.linkTo.
Dimension	height The height of the ConstraintLayout child.
ConstrainedLayoutReference	parent Reference to the ConstraintLayout itself, which can be used to specify constraints between itself and its children.
ConstrainScope.VerticalAnchorable	start The start anchor of the layout - can be constrained using VerticalAnchorable.linkTo.
ConstrainScope.HorizontalAnchorable	top The top anchor of the layout - can be constrained using HorizontalAnchorable.linkTo.
Dimension	width The width of the ConstraintLayout child.

Public methods

centerAround

fun centerAround(anchor: ConstraintLayoutBaseScope.VerticalAnchor): Unit

Adds start and end links towards a vertical anchor. This will center the current layout around the vertical anchor.

centerAround

fun centerAround(anchor: ConstraintLayoutBaseScope.HorizontalAnchor): Unit

Adds top and bottom links towards a horizontal anchor. This will center the current layout around the horizontal anchor.

centerHorizontallyTo

fun centerHorizontallyTo(other: ConstrainedLayoutReference): Unit

Adds start and end links towards the corresponding anchors of other. This will center horizontally the current layout inside or around (depending on size) other.

centerTo

fun centerTo(other: ConstrainedLayoutReference): Unit

Adds all start, top, end, bottom links towards the corresponding anchors of other. This will center the current layout inside or around (depending on size) other.

centerVerticallyTo

fun centerVerticallyTo(other: ConstrainedLayoutReference): Unit

Adds top and bottom links towards the corresponding anchors of other. This will center vertically the current layout inside or around (depending on size) other.

linkTo

fun linkTo(
    start: