ConstraintLayoutScope

Kotlin |Java

class ConstraintLayoutScope : ConstraintLayoutBaseScope

kotlin.Any
↳	androidx.compose.foundation.layout.ConstraintLayoutBaseScope
	↳	androidx.compose.foundation.layout.ConstraintLayoutScope

Scope used by the inline DSL of ConstraintLayout.

Summary

Nested classes
inner	`ConstrainedLayoutReferences` Convenience API for creating multiple ConstrainedLayoutReference via createRefs.

Public methods
Modifier	`Modifier.constrainAs(ref: ConstrainedLayoutReference, constrainBlock: ConstrainScope.() -> Unit)` Modifier that defines the constraints, as part of a ConstraintLayout, of the layout element.
ConstrainedLayoutReference	`createRef()` Creates one ConstrainedLayoutReference, which needs to be assigned to a layout within the ConstraintLayout as part of Modifier.constrainAs.
ConstraintLayoutScope.ConstrainedLayoutReferences	`createRefs()` Convenient way to create multiple ConstrainedLayoutReferences, which need to be assigned to layouts within the ConstraintLayout as part of Modifier.constrainAs.

Inherited functions

From class ConstraintLayoutBaseScope

`Unit`	`applyTo(state: State)`
`ConstraintLayoutBaseScope.VerticalAnchor`	`createAbsoluteLeftBarrier(vararg elements: ConstrainedLayoutReference, margin: Dp = 0.dp)` Creates and returns a left barrier, containing the specified elements.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createAbsoluteRightBarrier(vararg elements: ConstrainedLayoutReference, margin: Dp = 0.dp)` Creates and returns a right barrier, containing the specified elements.
`ConstraintLayoutBaseScope.HorizontalAnchor`	`createBottomBarrier(vararg elements: ConstrainedLayoutReference, margin: Dp = 0.dp)` Creates and returns a bottom barrier, containing the specified elements.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createEndBarrier(vararg elements: ConstrainedLayoutReference, margin: Dp = 0.dp)` Creates and returns an end barrier, containing the specified elements.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromAbsoluteLeft(offset: Dp)` Creates a guideline at a specific offset from the left of the ConstraintLayout.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromAbsoluteLeft(fraction: Float)` Creates a guideline at a width fraction from the left of the ConstraintLayout. A fraction of 0f will correspond to the left of the ConstraintLayout, while 1f will correspond to the right.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromAbsoluteRight(offset: Dp)` Creates a guideline at a specific offset from the right of the ConstraintLayout.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromAbsoluteRight(fraction: Float)` Creates a guideline at a width fraction from the right of the ConstraintLayout. A fraction of 0f will correspond to the right of the ConstraintLayout, while 1f will correspond to the left.
`ConstraintLayoutBaseScope.HorizontalAnchor`	`createGuidelineFromBottom(offset: Dp)` Creates a guideline at a specific offset from the bottom of the ConstraintLayout.
`ConstraintLayoutBaseScope.HorizontalAnchor`	`createGuidelineFromBottom(fraction: Float)` Creates a guideline at a height percenide from the bottom of the ConstraintLayout. A fraction of 0f will correspond to the bottom of the ConstraintLayout, while 1f will correspond to the top.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromEnd(offset: Dp)` Creates a guideline at a specific offset from the end of the ConstraintLayout.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromEnd(fraction: Float)` Creates a guideline at a width fraction from the end of the ConstraintLayout. A fraction of 0f will correspond to the end of the ConstraintLayout, while 1f will correspond to the start.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromStart(offset: Dp)` Creates a guideline at a specific offset from the start of the ConstraintLayout.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createGuidelineFromStart(fraction: Float)` Creates a guideline at a specific offset from the start of the ConstraintLayout. A fraction of 0f will correspond to the start of the ConstraintLayout, while 1f will correspond to the end.
`ConstraintLayoutBaseScope.HorizontalAnchor`	`createGuidelineFromTop(offset: Dp)` Creates a guideline at a specific offset from the top of the ConstraintLayout.
`ConstraintLayoutBaseScope.HorizontalAnchor`	`createGuidelineFromTop(fraction: Float)` Creates a guideline at a height percenide from the top of the ConstraintLayout. A fraction of 0f will correspond to the top of the ConstraintLayout, while 1f will correspond to the bottom.
`Unit`	`createHorizontalChain(vararg elements: ConstrainedLayoutReference, chainStyle: ChainStyle = ChainStyle.Spread)` Creates a horizontal chain including the referenced layouts.
`ConstraintLayoutBaseScope.VerticalAnchor`	`createStartBarrier(vararg elements: ConstrainedLayoutReference, margin: Dp = 0.dp)` Creates and returns a start barrier, containing the specified elements.
`ConstraintLayoutBaseScope.HorizontalAnchor`	`createTopBarrier(vararg elements: ConstrainedLayoutReference, margin: Dp = 0.dp)` Creates and returns a top barrier, containing the specified elements.
`Unit`	`createVerticalChain(vararg elements: ConstrainedLayoutReference, chainStyle: ChainStyle = ChainStyle.Spread)` Creates a vertical chain including the referenced layouts.
`Unit`