Modifier Index

absoluteOffset

Offset the content by offset px.

absolutePadding

Apply additional space along each edge of the content in Dp: left, top, right and bottom.

alpha

Draw content with modified alpha that may be less than 1.

anchoredDraggable

Enable drag gestures between a set of predefined values.

animateBounds

Modifier to animate layout changes (position and/or size) that occur within a LookaheadScope.

animateContentSize

This modifier animates its own size when its child modifier (or the child composable if it is already at the tail of the chain) changes size.

animateFloatingActionButton

Apply this modifier to a FloatingActionButton to show or hide it with an animation, typically based on the app's main content scrolling.

appendTextContextMenuComponents

Adds a builder to be run when the text context menu is shown within this hierarchy.

approachLayout

Creates an approach layout intended to help gradually approach the destination layout calculated in the lookahead pass.

aspectRatio

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 if matchHeightConstraintsFirst is false (which is the default), or Constraints.maxHeight, Constraints.maxWidth, Constraints.minHeight, Constraints.minWidth if matchHeightConstraintsFirst is true.

background

Draws shape with a solid color behind the content.

basicMarquee

Applies an animated marquee effect to the modified content if it's too wide to fit in the available space.

blur

Draw content blurred with the specified radii.

border

Modify element to add border with appearance specified with a border and a shape and clip it.

bringIntoViewRequester

Modifier that can be used to send bringIntoView requests.

bringIntoViewResponder

A parent that can respond to BringIntoViewRequester requests from its children, and adjust itself so that the item is visible on screen.

captionBarPadding

Adds padding to accommodate the caption bar insets.

clearAndSetSemantics

Clears the semantics of all the descendant nodes and sets new semantics.

clickable

Configure component to receive clicks via input or accessibility "click" event.

clip

Clip the content to shape.

clipScrollableContainer

Clips bounds of scrollable container on main axis while leaving space for background effects (like shadows) on cross axis.

clipToBounds

Clip the content to the bounds of a layer defined at this modifier.

combinedClickable

Configure component to receive clicks, double clicks and long clicks via input or accessibility "click" event.

composed

Declare a just-in-time composition of a Modifier that will be composed for each element it modifies.

consumeWindowInsets

Consume insets that haven't been consumed yet by other insets Modifiers similar to windowInsetsPadding without adding any padding.

contentColorProvider

Provides contentColor for text and iconography to consume.

contentReceiver

Configures the current node and any children nodes as a Content Receiver.

contentType

Set autofill hint with contentType.

defaultMinSize

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.

depthEffect

Renders shadows for the provided depthEffect.

displayCutoutPadding

Adds padding to accommodate the display cutout.

dragAndDropSource
dragAndDropTarget

A modifier that allows for receiving from a drag and drop gesture.

draggable

Configure touch dragging for the UI element in a single Orientation.

draggable2D

Configure touch dragging for the UI element in both orientations.

drawBehind

Draw into a Canvas behind the modified content.

drawWithCache

Draw into a DrawScope with content that is persisted across draw calls as long as the size of the drawing area is the same or any state objects that are read have not changed.

drawWithContent

Creates a DrawModifier that allows the developer to draw before or after the layout's contents.

dropShadow

Draws a drop shadow behind the rest of the content with the geometry specified by the given shape and the shadow properties defined the DropShadowScope.

edgeSwipeToDismiss

Handles swipe to dismiss from the edge of the viewport.

edgeSwipeToDismiss

Handles swipe to dismiss from the edge of the viewport.

excludeFromSystemGesture

Excludes the layout rectangle from the system gesture.

fillMaxHeight

Have the content fill (possibly only partially) the Constraints.maxHeight of the incoming measurement constraints, by setting the minimum height and the maximum height to be equal to the maximum height multiplied by fraction.

fillMaxSize

Have the content fill (possibly only partially) the Constraints.maxWidth and Constraints.maxHeight of the incoming measurement constraints, by setting the minimum width and the maximum width to be equal to the maximum width multiplied by fraction, as well as the minimum height and the maximum height to be equal to the maximum height multiplied by fraction.

fillMaxWidth

Have the content fill (possibly only partially) the Constraints.maxWidth of the incoming measurement constraints, by setting the minimum width and the maximum width to be equal to the maximum width multiplied by fraction.

filterTextContextMenuComponents

Adds a filter to be run when the text context menu is shown within this hierarchy.

fitInside

Fits the contents within rulers.

fitOutside

If one of the Rulers in rulers has a value within the bounds of the Layout, this sizes the content to that Ruler and the edge.

focusGroup

Creates a focus group or marks this component as a focus group.

focusModifier

Add this modifier to a component to make it focusable.

focusOrder

Use this modifier to specify a custom focus traversal order.

focusProperties

This modifier allows you to specify properties that are accessible to focusTargets further down the modifier chain or on child layout nodes.

focusRequester

Add this modifier to a component to request changes to focus.

focusRestorer

This modifier can be used to save and restore focus to a focus group.

focusTarget

Add this modifier to a component to make it focusable.

focusable

Configure component to be focusable via focus system or accessibility "focus" event.

graphicsLayer

A Modifier.Node that makes content draw into a draw layer.

handwritingDetector

Configures an element to act as a handwriting detector which detects stylus handwriting and delegates handling of the recognised text to another element.

handwritingHandler

Configures an element to act as a stylus handwriting handler which can handle text input from a handwriting session which was triggered by stylus handwriting on a handwriting detector.

height

Declare the preferred height of the content to be exactly heightdp.

heightIn

Constrain the height of the content to be between mindp and maxdp as permitted by the incoming measurement Constraints.

hierarchicalFocusGroup

hierarchicalFocusGroup is used to annotate composables in an application, so we can keep track of what is the active part of the composition.

horizontalScroll

Modify element to allow to scroll horizontally when width of the content is bigger than max constraints allow.

hoverable

Configure component to be hoverable via pointer enter/exit events.

imeNestedScroll

Controls the soft keyboard as a nested scrolling on Android R and later.

imePadding

Adds padding to accommodate the ime insets.

indication

Draws visual effects for this component when interactions occur.

innerShadow

Draws an inner shadow behind the rest of the content with the geometry specified by the given shape and the shadow properties defined the InnerShadowScope.

inspectable

Use this to group a common set of modifiers and provide InspectorInfo for the resulting modifier.

keepScreenOn

A modifier that keeps the device screen on as long as it is part of the composition on supported platforms.

layout

Creates a LayoutModifier that allows changing how the wrapped element is measured and laid out.

layoutBounds

This will map the RelativeLayoutBounds of the modifier into the provided LayoutBoundsHolder.

layoutId

Tag the element with layoutId to identify the element within its parent.

layoutId

Alternative to androidx.compose.ui.layout.layoutId that enables the use of tag.

magnifier

Shows a Magnifier widget that shows an enlarged version of the content at sourceCenter relative to the current layout node.

mandatorySystemGesturesPadding

Adds padding to accommodate the mandatory system gestures insets.

minimumInteractiveComponentSize

Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller.

minimumInteractiveComponentSize

Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller.

minimumInteractiveComponentSize

Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller.

modifierLocalConsumer

A Modifier that can be used to consume ModifierLocals that were provided by other modifiers to the left of this modifier, or above this modifier in the layout tree.

modifierLocalProvider

A Modifier that can be used to provide ModifierLocals that can be read by other modifiers to the right of this modifier, or modifiers that are children of the layout node that this modifier is attached to.

motionEventSpy

Calls watcher with each MotionEvent that the layout area or any child pointerInput receives.

navigationBarsPadding

Adds padding to accommodate the navigation bars insets.

nestedScroll

Modify element to make it participate in the nested scrolling hierarchy.

offset

Offset the content by offset px.

onConsumedWindowInsetsChanged

Calls block with the WindowInsets that have been consumed, either by consumeWindowInsets or one of the padding Modifiers, such as imePadding.

onFirstVisible

Registers a callback to monitor when the node is first inside of the viewport of the window or not.

onFocusChanged

Add this modifier to a component to observe focus state events.

onFocusEvent

Add this modifier to a component to observe focus state events.

onFocusedBoundsChanged

Calls onPositioned whenever the bounds of the currently-focused area changes.

onGloballyPositioned

Invoke onGloballyPositioned with the LayoutCoordinates of the element when the global position of the content may have changed.

onIndirectPointerGesture

A Modifier that detects high-level click and horizontal swipe gestures from an IndirectPointerEvent source.

onInterceptKeyBeforeSoftKeyboard

Adding this modifier to the modifier parameter of a component will allow it to intercept hardware key events before they are sent to the software keyboard.

onKeyEvent

Adding this modifier to the modifier parameter of a component will allow it to intercept hardware key events when it (or one of its children) is focused.

onLayoutRectChanged

Invokes callback with the position of this layout node relative to the coordinate system of the root of the composition, as well as in screen coordinates and window coordinates.

onPlaced

Invoke onPlaced after the parent LayoutModifier and parent layout has been placed and before child LayoutModifier is placed.

onPreInterceptKeyBeforeSoftKeyboard

Adding this modifier to the modifier parameter of a component will allow it to intercept hardware key events before they are sent to the software keyboard.

onPreRotaryScrollEvent

Adding this modifier to the modifier parameter of a component will allow it to intercept RotaryScrollEvents if it (or one of its children) is focused.

onPreviewKeyEvent

Adding this modifier to the modifier parameter of a component will allow it to intercept hardware key events when it (or one of its children) is focused.

onRotaryScrollEvent

Adding this modifier to the modifier parameter of a component will allow it to intercept RotaryScrollEvents if it (or one of its children) is focused.

onSizeChanged

Invoked with the size of the modified Compose UI element when the element is first measured or when the size of the element changes.

onVisibilityChanged

Registers a callback to monitor whether or not the node is inside of the viewport of the window or not.

overscroll

Renders overscroll from the provided overscrollEffect.

padding

Apply all dp of additional space along each edge of the content, left, top, right and bottom.

paddingFrom

A Modifier that can add padding to position the content according to specified distances from its bounds to an alignment line.

paddingFromBaseline

A Modifier that positions the content in a layout such that the distance from the top of the layout to the baseline of the first line of text in the content is top, and the distance from the baseline of the last line of text in the content to the bottom of the layout is bottom.

paint

Paint the content using painter.

pointerHoverIcon

Modifier that lets a developer define a pointer icon to display when the cursor is hovered over the element.

pointerInput

Create a modifier for processing pointer input within the region of the modified element.

pointerInteropFilter

A special PointerInputModifier that provides access to the underlying MotionEvents originally dispatched to Compose.

preferKeepClear

Mark the layout rectangle as preferring to stay clear of floating windows.

preferredFrameRate

Set a requested frame rate on Composable

progressSemantics

Contains the semantics required for an indeterminate progress indicator, that represents the fact of the in-progress operation.

pullRefresh

A nested scroll modifier that provides scroll events to state.

pullRefreshIndicatorTransform

A modifier for translating the position and scaling the size of a pull-to-refresh indicator based on the given PullRefreshState.

pullToRefresh

A Modifier that adds nested scroll to a container to support a pull-to-refresh gesture.

rangeSemantics

Modifier to add semantics signifying progress of the Stepper/Slider.

recalculateWindowInsets

This recalculates the WindowInsets based on the size and position.

requestFocusOnHierarchyActive

This Modifier is used in conjunction with hierarchicalFocusGroup and will request focus on the following focusable element when needed (i.e. this needs to be before that element in the Modifier chain).

requiredHeight

Declare the height of the content to be exactly heightdp.

requiredHeightIn

Constrain the height of the content to be between mindp and maxdp.

requiredSize

Declare the size of the content to be exactly sizedp width and height.

requiredSizeIn

Constrain the width of the content to be between minWidthdp and maxWidthdp, and the height of the content to be between minHeightdp and maxHeightdp.

requiredWidth

Declare the width of the content to be exactly the same as the min or max intrinsic width of the content.

requiredWidthIn

Constrain the width of the content to be between mindp and maxdp.

rotaryScrollable

A modifier which connects rotary events with scrollable containers such as Column, LazyList and others.

rotate

Sets the degrees the view is rotated around the center of the composable.

safeContentPadding

Adds padding to accommodate the safe content insets.

safeDrawingPadding

Adds padding to accommodate the safe drawing insets.

safeGesturesPadding

Adds padding to accommodate the safe gestures insets.

scale

Scale the contents of both the horizontal and vertical axis uniformly by the same scale factor.

scrollAway

Scroll an item vertically in/out of view based on a ScrollState.

scrollAway

Scroll an item vertically in/out of view based on scroll state provided by a scrolling list.

scrollable

Configure touch scrolling and flinging for the UI element in a single Orientation.

scrollable2D

Configure touch scrolling and flinging for the UI element in both XY orientations.

scrollableArea

Configure a component to act as a scrollable area.

selectable

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.

selectableGroup

Use this modifier to group a list of selectable items like Tabs or RadioButtons together for accessibility purpose.

semantics

Add semantics key/value pairs to the layout node, for use in testing, accessibility, etc.

sensitiveContent

This modifier hints that the composable renders sensitive content (i.e. username, password, credit card etc) on the screen, and the content should be protected during screen share in supported environments.

shadow

Creates a graphicsLayer that draws a shadow.

size

Declare the preferred size of the content to be exactly sizedp square.

sizeIn

Constrain the width of the content to be between minWidthdp and maxWidthdp and the height of the content to be between minHeightdp and maxHeightdp as permitted by the incoming measurement Constraints.

statusBarsPadding

Adds padding to accommodate the status bars insets.

styleable

Modifier that creates a region that is styled by the given Style object for the component this Modifier is attached to.

stylusHoverIcon

Modifier that lets a developer define a pointer icon to display when a stylus is hovered over the element.

swipeable

Enable swipe gestures between a set of predefined states.

swipeable

Enable swipe gestures between a set of predefined states.

systemBarsPadding

Adds padding to accommodate the system bars insets.

systemGestureExclusion

Excludes the layout rectangle from the system gesture.

systemGesturesPadding

Adds padding to accommodate the system gestures insets.

testTag

Applies a tag to allow modified element to be found in tests.

toggleable

Configure component to make it toggleable via input and accessibility events

toolingGraphicsLayer

A Modifier.Element that adds a draw layer such that tooling can identify an element in the drawn image.

touchTargetAwareSize

Modifier to set both the size and recommended touch target for IconButton and TextButton.

transformable

Enable transformation gestures of the modified UI element.

transformedHeight

Convenience modifier to calculate transformed height using TransformationSpec.

triStateToggleable

Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate.

verticalScroll

Modify element to allow to scroll vertically when height of the content is bigger than max constraints allow.

visible

A Modifier that controls the visibility of the Layout it is applied to.

waterfallPadding

Adds padding to accommodate the waterfall insets.

width

Declare the preferred width of the content to be the same as the min or max intrinsic width of the content.

widthIn

Constrain the width of the content to be between mindp and maxdp as permitted by the incoming measurement Constraints.

windowInsetsBottomHeight

Sets the height to that of insets at the bottom of the screen.

windowInsetsEndWidth

Sets the width to that of insets at the end of the screen, using either left or right, depending on the LayoutDirection.

windowInsetsPadding

Adds padding so that the content doesn't enter insets space.

windowInsetsStartWidth

Sets the width to that of insets at the start of the screen, using either left or right, depending on the LayoutDirection.

windowInsetsTopHeight

Sets the height to that of insets at the top of the screen.

wrapContentHeight

Allow the content to measure at its desired height without regard for the incoming measurement minimum height constraint, and, if unbounded is true, also without regard for the incoming measurement maximum height constraint.

wrapContentSize

Allow the content to measure at its desired size without regard for the incoming measurement minimum width or minimum height constraints, and, if unbounded is true, also without regard for the incoming maximum constraints.

wrapContentWidth

Allow the content to measure at its desired width without regard for the incoming measurement minimum width constraint, and, if unbounded is true, also without regard for the incoming measurement maximum width constraint.

zIndex

Creates a modifier that controls the drawing order for the children of the same layout parent.