LayoutModifier

Kotlin |Java

interface LayoutModifier : Modifier.Element

androidx.ui.core.LayoutModifier

A Modifier.Element that changes how its wrapped content is measured and laid out. It has the same measurement and layout functionality as the androidx.ui.core.Layout component, while wrapping exactly one layout due to it being a modifier. In contrast, the androidx.ui.core.Layout component is used to define the layout behavior of multiple children.

Summary

Public methods
open Int	`IntrinsicMeasureScope.maxIntrinsicHeight(measurable: IntrinsicMeasurable, width: Int, layoutDirection: LayoutDirection)` The lambda used to calculate IntrinsicMeasurable.maxIntrinsicHeight.
open Int	`IntrinsicMeasureScope.maxIntrinsicWidth(measurable: IntrinsicMeasurable, height: Int, layoutDirection: LayoutDirection)` The function used to calculate IntrinsicMeasurable.maxIntrinsicWidth.
abstract MeasureScope.MeasureResult	`MeasureScope.measure(measurable: Measurable, constraints: Constraints, layoutDirection: LayoutDirection)` The function used to measure the modifier.
open Int	`IntrinsicMeasureScope.minIntrinsicHeight(measurable: IntrinsicMeasurable, width: Int, layoutDirection: LayoutDirection)` The lambda used to calculate IntrinsicMeasurable.minIntrinsicHeight.
open Int	`IntrinsicMeasureScope.minIntrinsicWidth(measurable: IntrinsicMeasurable, height: Int, layoutDirection: LayoutDirection)` The function used to calculate IntrinsicMeasurable.minIntrinsicWidth.

Inherited functions

From class Element

`Boolean`	`all(predicate: (Modifier.Element) -> Boolean)` Returns `true` if predicate returns true for all Elements in this Modifier or if this Modifier contains no Elements.
`Boolean`	`any(predicate: (Modifier.Element) -> Boolean)` Returns `true` if predicate returns true for any Element in this Modifier.
`R`	`foldIn(initial: R, operation: (R, Modifier.Element) -> R)` Accumulates a value starting with initial and applying operation to the current value and each element from outside in. Elements wrap one another in a chain from left to right; an Element that appears to the left of another in a `+` expression or in operation's parameter order affects all of the elements that appear after it. foldIn may be used to accumulate a value starting from the parent or head of the modifier chain to the final wrapped child.
`R`	`foldOut(initial: R, operation: (Modifier.Element, R) -> R)` Accumulates a value starting with initial and applying operation to the current value and each element from inside out. Elements wrap one another in a chain from left to right; an Element that appears to the left of another in a `+` expression or in operation's parameter order affects all of the elements that appear after it. foldOut may be used to accumulate a value starting from the child or tail of the modifier chain up to the parent or head of the chain.

From class Modifier

Modifier

plus(other: Modifier)

Concatenates this modifier with another.

Returns a Modifier representing this modifier followed by other in sequence.

Inherited extension functions

From androidx.ui.layout

Modifier	`Modifier.absolutePadding(left: Dp = 0.dp, top: Dp = 0.dp, right: Dp = 0.dp, bottom: Dp = 0.dp)` Apply additional space along each edge of the content in Dp: left, top, right and bottom.
Modifier	`Modifier.aspectRatio(@FloatRange(0.0, false) ratio: Float)` Attempts to size the content to match a specified aspect ratio by trying to match one of the incoming constraints in the following order: Constraints.maxWidth, Constraints.maxHeight, Constraints.minWidth, Constraints.minHeight.
Modifier	`Modifier.defaultMinSizeConstraints(minWidth: Dp = Dp.Unspecified, minHeight: Dp = Dp.Unspecified)` Constrain the size of the wrapped layout only when it would be otherwise unconstrained: the minWidth and minHeight constraints are only applied when the incoming corresponding constraint is `0`.
Modifier	`Modifier.fillMaxHeight()` Have the content fill the Constraints.maxHeight of the incoming measurement constraints by setting the minimum height to be equal to the maximum height.
Modifier	`Modifier.fillMaxSize()` Have the content fill the Constraints.maxWidth and Constraints.maxHeight of the incoming measurement constraints by setting the minimum width to be equal to the maximum width and the minimum height to be equal to the maximum height.
Modifier	`Modifier.fillMaxWidth()` Have the content fill the Constraints.maxWidth of the incoming measurement constraints by setting the minimum width to be equal to the maximum width.
Modifier	`Modifier.height(height: Dp)` Declare the height of the content to be exactly heightdp.
Modifier	`Modifier.heightIn(minHeight: Dp = Dp.Unspecified, maxHeight: Dp = Dp.Unspecified)` Constrain the height of the content to be between minHeightdp and maxHeightdp.
Modifier	`Modifier.offset(x: Dp = 0.dp, y: Dp = 0.dp)` Offset the content by (x dp, y dp).
Modifier	`Modifier.offsetPx(x: State<Float> = mutableStateOf(0f), y: State<Float> = mutableStateOf(0f))` Offset the content by (x px, ypx).
Modifier	`Modifier.padding(start: Dp = 0.dp, top: Dp = 0.dp, end: Dp = 0.dp, bottom: Dp = 0.dp)` Apply additional space along each edge of the content in Dp: start, top, end and bottom.
Modifier	`Modifier.padding(horizontal: Dp = 0.dp, vertical: Dp = 0.dp)` Apply horizontal dp space along the left and right edges of the content, and vertical dp space along the top and bottom edges.
Modifier	`Modifier.padding(all: Dp)` Apply all dp of additional space along each edge of the content, left, top, right and bottom.
Modifier	`Modifier.padding(padding: InnerPadding)` Apply InnerPadding to the component as additional space along each edge of the content's left, top, right and bottom.
Modifier	`Modifier.preferredHeight(intrinsicSize: IntrinsicSize)` Declare the preferred height of the content to be the same as the min or max intrinsic height of the content.
Modifier	`Modifier.preferredHeight(height: Dp)` Declare the preferred height of the content to be exactly heightdp.
Modifier	`Modifier.preferredHeightIn(minHeight: Dp = Dp.Unspecified, maxHeight: Dp = Dp.Unspecified)` Constrain the height of the content to be between minHeightdp and maxHeightdp as permitted by the incoming measurement Constraints.
Modifier	`Modifier.preferredSize(size: Dp)` Declare the preferred size of the content to be exactly sizedp square.
Modifier	`Modifier.preferredSize(width: Dp, height: Dp)` Declare the preferred size of the content to be exactly widthdp by heightdp.
Modifier	`Modifier.preferredSizeIn(constraints: DpConstraints)` Constrain the size of the content to be within constraints as permitted by the incoming measurement Constraints.
Modifier	`Modifier.preferredSizeIn(minWidth: Dp = Dp.Unspecified, minHeight: Dp = Dp.Unspecified, maxWidth: Dp = Dp.Unspecified, maxHeight: Dp = Dp.Unspecified)` Constrain the width of the content to be between minWidthdp and maxWidthdp and the height of the content to be between minHeight and maxHeight as permitted by the incoming measurement Constraints.
Modifier	`Modifier.preferredWidth(intrinsicSize: IntrinsicSize)` Declare the preferred width of the content to be the same as the min or max intrinsic width of the content.
Modifier	`Modifier.preferredWidth(width: Dp)` Declare the preferred width of the content to be exactly widthdp.
Modifier	`Modifier.preferredWidthIn(minWidth: Dp = Dp.Unspecified, maxWidth: Dp = Dp.Unspecified)` Constrain the width of the content to be between minWidthdp and maxWidthdp as permitted by the incoming measurement Constraints.
Modifier	`Modifier.relativePaddingFrom(alignmentLine: AlignmentLine, before: Dp = 0.dp, after: Dp = 0.dp)` Allow the content to be positioned according to the specified offset relative to the alignment line, subject to the incoming layout constraints.
Modifier	`Modifier.size(size: Dp)` Declare the size of the content to be exactly sizedp width and height.
Modifier	`Modifier.size(width: Dp, height: Dp)` Declare the size of the content to be exactly widthdp and heightdp.
Modifier	`Modifier.sizeIn(constraints: DpConstraints)` Constrain the size of the content to be within constraints.
Modifier	`Modifier.sizeIn(minWidth: Dp = Dp.Unspecified, minHeight: Dp = Dp.Unspecified, maxWidth: Dp = Dp.Unspecified, maxHeight: Dp = Dp.Unspecified)` Constrain the width of the content to be between minWidthdp and maxWidthdp, and the height of the content to be between minHeightdp and maxHeightdp.
Modifier	`Modifier.width(width: Dp)` Declare the width of the content to be exactly widthdp.
Modifier	`Modifier.widthIn(minWidth: Dp = Dp.Unspecified, maxWidth: Dp = Dp.Unspecified)` Constrain the width of the content to be between minWidthdp and maxWidthdp.
Modifier	`Modifier.wrapContentHeight(align: Alignment.Vertical = Alignment.CenterVertically)` Allow the content to measure at its desired height without regard for the incoming measurement minimum height constraint.
Modifier	`Modifier.wrapContentSize(align: Alignment = Alignment.Center)` Allow the content to measure at its desired size without regard for the incoming measurement minimum width or minimum height constraints.
Modifier	`Modifier.wrapContentWidth(align: Alignment.Horizontal = Alignment.CenterHorizontally)` Allow the content to measure at its desired width without regard for the incoming measurement minimum width constraint.

From androidx.ui.foundation

Modifier	`Modifier.clickable(enabled: Boolean = true, onClickLabel: String? = null, interactionState: InteractionState = remember { InteractionState() }, indication: Indication? = IndicationAmbient.current(), onLongClick: () -> Unit = null, onDoubleClick: () -> Unit = null, onClick: () -> Unit)` Configure component to receive clicks via input or accessibility "click" event.
Modifier	`Modifier.determinateProgressIndicator(@FloatRange(0.0, 1.0) progress: Float)` Contains the Semantics required for a determinate progress indicator, that represents progress ranging from 0.
Modifier	`Modifier.drawBackground(color: Color, shape: Shape = RectangleShape, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DrawScope.DefaultBlendMode)` Draws shape with a solid color behind the content.
Modifier	`Modifier.drawBackground(brush: Brush, shape: Shape = RectangleShape, @FloatRange(0.0, 1.0) alpha: Float = 1.0f, style: DrawStyle = Fill, colorFilter: ColorFilter? = null, blendMode: BlendMode = DrawScope.DefaultBlendMode)` Draws shape with brush behind the content.
Modifier	`Modifier.drawBorder(border: Border, shape: Shape = RectangleShape)` Returns a Modifier that adds border with appearance specified with a border and a shape
Modifier	`Modifier.drawBorder(size: Dp, color: Color, shape: Shape = RectangleShape)` Returns a Modifier that adds border with appearance specified with size, color and a shape
Modifier	`Modifier.drawBorder(size: Dp, brush: Brush, shape: Shape)` Returns a Modifier that adds border with appearance specified with size, brush and a shape
Modifier	`Modifier.indication(interactionState: InteractionState, indication: Indication? = null)` Show visual indicator for an InteractionState.

From androidx.ui.core

Modifier	`Modifier.clip(shape: Shape)` Clip the content to shape.
Modifier	`Modifier.clipToBounds()` Clip the content to the bounds of a layer defined at this modifier.
Modifier	`Modifier.composed(factory: Modifier.() -> Modifier)` Declare a just-in-time composition of a Modifier that will be composed for each element it modifies.
Modifier	`Modifier.drawBehind(onDraw: DrawScope.() -> Unit)` Draw into a Canvas behind the modified content.
Modifier	`Modifier.drawLayer(scaleX: Float = 1f, scaleY: Float = 1f, alpha: Float = 1f, translationX: Float = 0f, translationY: Float = 0f, shadowElevation: Float = 0f, rotationX: Float = 0f, rotationY: Float = 0f, rotationZ: Float = 0f, transformOrigin: TransformOrigin = TransformOrigin.Center, shape: Shape = RectangleShape, clip: Boolean = false)` Draw the content into a layer.
Modifier	`Modifier.drawOpacity(@FloatRange(0.0, 1.0) opacity: Float)` Draw content with modified opacity (alpha) that may be less than 1.
Modifier	`Modifier.drawShadow(elevation: Dp, shape: Shape = RectangleShape, clip: Boolean = elevation > 0.dp, @FloatRange(0.0, 1.0) opacity: Float = 1f)` Creates a DrawLayerModifier that draws the shadow.
Modifier	`Modifier.drawWithContent(onDraw: ContentDrawScope.() -> Unit)` Creates a DrawModifier that allows the developer to draw before or after the layout's contents.
Modifier	`Modifier.onChildPositioned(onChildPositioned: (LayoutCoordinates) -> Unit)` Invoke onChildPositioned with the LayoutCoordinates of each child element after each one is positioned.
Modifier	`Modifier.onPositioned(onPositioned: (LayoutCoordinates) -> Unit)` Invoke onPositioned with the LayoutCoordinates of the element after positioning.
Modifier	`Modifier.paint(painter: Painter, sizeToIntrinsics: Boolean = true, alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Inside, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null)` Paint the content using painter.
Modifier	`Modifier.tag(tag: Any)` Tag the element with tag to identify the element within its parent.
Modifier	`Modifier.testTag(tag: String)` Applies a tag to allow modified element to be found in tests.
Modifier	`Modifier.zIndex(zIndex: Float)` Creates a ZIndexModifier that controls the drawing order for the children of the same layout parent.

From androidx.ui.core.gesture

Modifier	`Modifier.doubleTapGestureFilter(onDoubleTap: (Offset) -> Unit)` Responds to pointers going down and up (tap) and then down and up again (another tap) with minimal gap of time between the first up and the second down.
Modifier	`Modifier.dragGestureFilter(dragObserver: DragObserver, canDrag: (Direction) -> Boolean = null, startDragImmediately: Boolean = false)` This gesture detector detects dragging in any direction.
Modifier	`Modifier.dragSlopExceededGestureFilter(onDragSlopExceeded: () -> Unit, canDrag: (Direction) -> Boolean = null)` This gesture filter detects when the average distance change of all pointers surpasses touch slop.
Modifier	`Modifier.longPressDragGestureFilter(longPressDragObserver: LongPressDragObserver)` This gesture detector detects dragging in any direction, but only after a long press has first occurred.
Modifier	`Modifier.longPressGestureFilter(onLongPress: (Offset) -> Unit)` Responds to a pointer being "down" for an extended amount of time.
Modifier	`Modifier.pressIndicatorGestureFilter(onStart: (Offset) -> Unit = null, onStop: () -> Unit = null, onCancel: () -> Unit = null, enabled: Boolean = true)` This gesture detector has callbacks for when a press gesture starts and ends for the purposes of displaying visual feedback for those two states.
Modifier	`Modifier.rawDragGestureFilter(dragObserver: DragObserver, canStartDragging: () -> Boolean = null)` This gesture detector detects dragging in any direction.
Modifier	`Modifier.rawPressStartGestureFilter(onPressStart: (Offset) -> Unit, enabled: Boolean = false, executionPass: PointerEventPass = PointerEventPass.PostUp)` Reacts if the first pointer input change it sees is an unconsumed down change, and if it reacts, consumes all further down changes.
Modifier	`Modifier.rawScaleGestureFilter(scaleObserver: RawScaleObserver, canStartScaling: () -> Boolean = null)` This gesture detector detects scaling.
Modifier	`Modifier.scaleGestureFilter(scaleObserver: ScaleObserver)` This gesture detector detects scaling.
Modifier	`Modifier.scaleSlopExceededGestureFilter(onScaleSlopExceeded: () -> Unit)` This gesture detector detects when a user's pointer input is intended to include scaling.
Modifier	`Modifier.tapGestureFilter(onTap: (Offset) -> Unit)` This gesture detector fires a callback when a traditional press is being released.

From androidx.ui.foundation.gestures

Modifier	`Modifier.draggable(dragDirection: DragDirection, onDragStarted: (startedPosition: Offset) -> Unit = {}, onDragStopped: (velocity: Float) -> Unit = {}, enabled: Boolean = true, interactionState: InteractionState? = null, startDragImmediately: Boolean = false, onDragDeltaConsumptionRequested: (Float) -> Float)` Configure touch dragging for the UI element in a single DragDirection.
Modifier	`Modifier.scrollable(dragDirection: DragDirection, scrollableState: ScrollableState, onScrollStarted: (startedPosition: Offset) -> Unit = {}, onScrollStopped: (velocity: Float) -> Unit = {}, enabled: Boolean = true)` Enable scrolling and flinging of the modified UI element.
Modifier	`Modifier.zoomable(zoomableState: ZoomableState, onZoomStopped: () -> Unit = null)` Enable zooming of the modified UI element.
Modifier	`Modifier.zoomable(onZoomStopped: () -> Unit = null, onZoomDelta: (Float) -> Unit)` Enable zooming of the modified UI element.

From androidx.ui.core.keyinput

Modifier	`Modifier.keyInputFilter(onKeyEvent: (KeyEvent) -> Boolean)` Adding this modifier to the modifier parameter of a component will allow it to intercept hardware key events.
Modifier	`Modifier.previewKeyInputFilter(onPreviewKeyEvent: (KeyEvent) -> Boolean)` Adding this modifier to the modifier parameter of a component will allow it to intercept hardware key events.

From androidx.ui.material.ripple

Modifier

Modifier.ripple(bounded: Boolean = true, radius: Dp? = null, color: Color = Color.Unset, enabled: Boolean = true, clock: AnimationClockObservable? = null)

Ripple is a Modifier which draws the visual indicator for a pressed state.

From androidx.ui.foundation.selection

Modifier	`Modifier.selectable(selected: Boolean, enabled: Boolean = true, inMutuallyExclusiveGroup: Boolean = true, interactionState: InteractionState = remember { InteractionState() }, indication: Indication? = IndicationAmbient.current(), onClick: () -> Unit)` Configure component to be selectable, usually as a part of a mutually exclusive group, where only one item can be selected at any point in time.
Modifier	`Modifier.toggleable(value: Boolean, enabled: Boolean = true, interactionState: InteractionState = remember { InteractionState() }, indication: Indication? = IndicationAmbient.current(), onValueChange: (Boolean) -> Unit)` Configure component to make it toggleable via input and accessibility events
Modifier	`Modifier.triStateToggleable(state: ToggleableState, enabled: Boolean = true, interactionState: InteractionState = remember { InteractionState() }, indication: Indication? = IndicationAmbient.current(), onClick: () -> Unit)` Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate.

From androidx.ui.core.semantics

Modifier

Modifier.semantics(applyToChildLayoutNode: Boolean = false, mergeAllDescendants: Boolean = false, properties: SemanticsPropertyReceiver.() -> Unit = null)

Add semantics key/value for use in testing, accessibility, and similar use cases.

Inherited extension properties

From androidx.ui.layout

Modifier	`ltr` Modifier that changes the LayoutDirection of the wrapped layout to LayoutDirection.Ltr.
Modifier	`rtl` Modifier that changes the LayoutDirection of the wrapped layout to LayoutDirection.Rtl.

Public methods

maxIntrinsicHeight

open fun IntrinsicMeasureScope.maxIntrinsicHeight(
    measurable: IntrinsicMeasurable, 
    width: Int, 
    layoutDirection: LayoutDirection
): Int

The lambda used to calculate IntrinsicMeasurable.maxIntrinsicHeight.

maxIntrinsicWidth

open fun IntrinsicMeasureScope.maxIntrinsicWidth(
    measurable: IntrinsicMeasurable, 
    height: Int, 
    layoutDirection: LayoutDirection
): Int

The function used to calculate IntrinsicMeasurable.maxIntrinsicWidth.

measure

abstract fun MeasureScope.measure(
    measurable: Measurable, 
    constraints: Constraints, 
    layoutDirection: LayoutDirection
): MeasureScope.MeasureResult

The function used to measure the modifier. The measurable corresponds to the wrapped content, and it can be measured with the desired constraints according to the logic of the LayoutModifier. The modifier needs to choose its own size, which can depend on the size chosen by the wrapped content (the obtained Placeable), if the wrapped content was measured. The size needs to be returned as part of a MeasureScope.MeasureResult, alongside the placement logic of the Placeable, which defines how the wrapped content should be positioned inside the LayoutModifier. A convenient way to create the MeasureScope.MeasureResult is to use the MeasureScope.layout factory function.

minIntrinsicHeight

open fun IntrinsicMeasureScope.minIntrinsicHeight(
    measurable: IntrinsicMeasurable, 
    width: Int, 
    layoutDirection: LayoutDirection
): Int

The lambda used to calculate IntrinsicMeasurable.minIntrinsicHeight.

minIntrinsicWidth

open fun IntrinsicMeasureScope.minIntrinsicWidth(
    measurable: IntrinsicMeasurable, 
    height: Int, 
    layoutDirection: LayoutDirection
): Int

The function used to calculate IntrinsicMeasurable.minIntrinsicWidth.