List of Compose modifiers

Enable drag gestures between a set of predefined values.

This function is deprecated. startDragImmediately has been removed without replacement.

Enable drag gestures between a set of predefined values.

This function is deprecated. startDragImmediately has been removed without replacement.

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

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

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

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

Configure touch dragging for the UI element in both orientations.

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

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

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.

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.

This function is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.

Enable swipe gestures between a set of predefined states.

Configure component to make it toggleable via input and accessibility events

Configure component to make it toggleable via input and accessibility events.

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

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

The modifier that should be applied on a drag handle composable so the drag handle can be dragged and operate on the provided PaneExpansionState properly.

Align the element vertically within the Row.

Position the element vertically such that the alignment line for the content as determined by alignmentLineBlock aligns with sibling elements also configured to alignBy.

Position the element vertically such that its alignmentLine aligns with sibling elements also configured to alignBy.

Position the element vertically such that its first baseline aligns with sibling elements also configured to alignByBaseline or alignBy.

Align the element horizontally within the Column.

Position the element horizontally such that the alignment line for the content as determined by alignmentLineBlock aligns with sibling elements also configured to alignBy.

Position the element horizontally such that its alignmentLine aligns with sibling elements also configured to alignBy.

Pull the content element to a specific Alignment within the Box.

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

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

animateEnterExit modifier can be used for any direct or indirect children of AnimatedVisibility to create a different enter/exit animation than what's specified in AnimatedVisibility.

This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering).

This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering).

This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering).

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

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

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

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

Draws shape with a solid color behind the content.

Draws shape with brush behind the content.

Clip the content to shape.

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

Draw into a Canvas behind the modified content.

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.

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

Draws visual effects for this component when interactions occur.

Paint the content using painter.

Creates a graphicsLayer that draws a shadow.

Adds padding to accommodate the safe drawing insets.

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

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

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

This function is deprecated. Replaced by focusTarget

Add this modifier to a component to make it focusable.

This function is deprecated. Use focusProperties() instead

This function is deprecated. Use focusRequester() instead

This function is deprecated. Use focusProperties() and focusRequester() instead

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

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

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

This function is deprecated. Use focusRestorer(FocusRequester) instead

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

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

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

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

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

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

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.

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.

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

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

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

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

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

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

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.

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.

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

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

Apply PaddingValues to the component as additional space along each edge of the content's left, top, right and bottom.

Apply horizontal dp space along the left and right edges of the content, and vertical dp space along the top and bottom edges.

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

Adds padding to accommodate the caption bar insets.

Adds padding to accommodate the display cutout.

Adds padding to accommodate the ime insets.

Adds padding to accommodate the mandatory system gestures insets.

Adds padding to accommodate the navigation bars insets.

Adds padding to accommodate the safe content insets.

Adds padding to accommodate the safe gestures insets.

Adds padding to accommodate the status bars insets.

Adds padding to accommodate the system bars insets.

Adds padding to accommodate the system gestures insets.

Adds padding to accommodate the waterfall insets.

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

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

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

This function is deprecated. Modifier.pointerInput must provide one or more 'key' parameters that define the identity of the modifier and determine when its previous input processing coroutine should be cancelled and a new effect launched for the new key.

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

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

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

Offset the content by offset px.

Offset the content by (x dp, y dp).

Offset the content by offset px.

Offset the content by (x dp, y dp).

Modifier that takes up all the available width inside the TabRow, and then animates the offset of the indicator it is applied to, depending on the currentTabPosition.

Modifier that takes up all the available width inside the TabRow, and then animates the offset of the indicator it is applied to, depending on the currentTabPosition.

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

Contains the semantics required for a determinate progress indicator or the progress part of a slider, that represents progress within valueRange.

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

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

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

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

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

Renders overscroll from the provided overscrollEffect.

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.

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.

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

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

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

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

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

This function is deprecated. This overload is provided for backwards compatibility with Compose for Wear OS 1.1.A newer overload is available which uses ScalingLazyListState from wear.compose.foundation.lazy package

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

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

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

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

A modifier that enables Material3 Motion transformations for content within a TransformingLazyColumn item.

A modifier that enables Material3 Motion transformations for content within a TransformingLazyColumn item.

A modifier that enables Material3 Motion transformations for content within a TransformingLazyColumn item.

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

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

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

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.

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.

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.

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

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

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

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

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

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

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

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

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

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.

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.

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.

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.

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

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

Declare the height of the content to be exactly heightdp.

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

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

Declare the size of the content to be exactly size.

Declare the size of the content to be exactly widthdp and heightdp.

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

Declare the width of the content to be exactly widthdp.

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

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

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

Declare the preferred size of the content to be exactly widthdp by heightdp.

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.

Declare the preferred width of the content to be exactly widthdp.

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

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.

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.

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.

This modifier provides the height of the target composable to the scrollTransform during a morph transition and represents minimum height of the item when morphed.

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

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

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

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

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

Size the element's width proportional to its weight relative to other weighted sibling elements in the Row.

Size the element's height proportional to its weight relative to other weighted sibling elements in the Column.

Have the item fill (possibly only partially) the max height of the tallest item in the row it was placed in, within the FlowRow.

Have the item fill (possibly only partially) the max width of the widest item in the column it was placed in, within the FlowColumn.

Size the element to match the size of the Box after all other content elements have been measured.

Have the content fill the Constraints.maxHeight of the incoming measurement constraints by setting the minimum height to be equal to the maximum height multiplied by fraction.

Have the content fill the Constraints.maxWidth and Constraints.maxHeight of the parent measurement constraints by setting the minimum width to be equal to the maximum width multiplied by fraction and the minimum height to be equal to the maximum height multiplied by fraction.

Have the content fill the Constraints.maxWidth of the parent measurement constraints by setting the minimum width to be equal to the maximum width multiplied by fraction.

Modifier which should be applied to an ExposedDropdownMenu placed inside the scope.

Modifier which should be applied to a menu placed inside the ExposedDropdownMenuBoxScope.

This modifier specifies the preferred width for a pane, and the pane scaffold implementation will try its best to respect this width when the associated pane is rendered as a fixed pane, i.e., a pane that are not stretching to fill the remaining spaces.

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

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

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

Scale the contents of the composable by the following scale factors along the horizontal and vertical axis respectively.

Enable transformation gestures of the modified UI element.

Enable transformation gestures of the modified UI element.

This function is deprecated. Replaced by overload with a callback for obtain a transfer data,start detection is performed by Compose itself

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

Limits swipe to dismiss to be active from the edge of the viewport only.

Draw content blurred with the specified radii.

Draw content blurred with the specified radii.

Modifier that can be used to send bringIntoView requests.

This function is deprecated. Use BringIntoViewModifierNode instead

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

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

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

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

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

A Modifier that allows an element it is applied to be treated like a source for drag and drop operations.

This function is deprecated. Replaced by overload with a callback for obtain a transfer data,start detection is performed by Compose itself

A Modifier that allows an element it is applied to be treated like a source for drag and drop operations.

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

This function is deprecated. Use systemGestureExclusion

This function is deprecated. Use systemGestureExclusion

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

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.

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

This function is deprecated. This API will create more invalidations of your modifier than necessary, so it's use is discouraged.

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

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

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.

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.

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.

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

Draws a placeholder shape over the top of a composable and animates a wipe off effect to remove the placeholder.

Draws a placeholder shape over the top of a composable and animates a wipe off effect to remove the placeholder.

Modifier to draw a placeholder shimmer over a component.

Modifier to draw a placeholder shimmer over a component.

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

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

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

Mark a rectangle within the local layout coordinates preferring to stay clear of floating windows.

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

A nested scroll modifier that provides scroll events to state.

A nested scroll modifier that provides onPull and onRelease callbacks to aid building custom pull refresh components.

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

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

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.

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.

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.

This function is deprecated. SwipeToDismiss has been migrated to androidx.wear.compose.foundation.

Excludes the layout rectangle from the system gesture.

Excludes a rectangle within the local layout coordinates from the system gesture.

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

Consume paddingValues as insets as if the padding was added irrespective of insets.

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

This recalculates the WindowInsets based on the size and position.

This function is deprecated. Use overload that takes ExposedDropdownMenuAnchorType and enabled parameters

Modifier which should be applied to an element inside the ExposedDropdownMenuBoxScope, typically a text field or an icon within the text field.