Actions
Scope: Any
|
@ExperimentalFoundationApi
Enable drag gestures between a set of predefined values. |
Scope: Any
|
@ExperimentalFoundationApi
Enable drag gestures between a set of predefined values. |
Scope: Any
|
Configure component to receive clicks via input or accessibility "click" event. |
Scope: Any
|
Modifier.clickable(
Configure component to receive clicks via input or accessibility "click" event. |
Scope: Any
|
@ExperimentalFoundationApi
Configure component to receive clicks, double clicks and long clicks via input or accessibility "click" event. |
Scope: Any
|
@ExperimentalFoundationApi
Configure component to receive clicks, double clicks and long clicks via input or accessibility "click" event. |
Scope: Any
|
@ExperimentalFoundationApi
Creates modifier similar to |
Scope: Any
|
@ExperimentalFoundationApi
Configure touch dragging for the UI element in both orientations. |
Scope: Any
|
Modifier.draggable(
Configure touch dragging for the UI element in a single |
Scope: Any
|
Use this modifier to group a list of |
Scope: Any
|
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. |
Scope: Any
|
Modifier.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. |
Scope: Any
|
@ExperimentalMaterialApi
This function is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. |
Scope: Any
|
@ExperimentalWearMaterialApi
Enable swipe gestures between a set of predefined states. |
Scope: Any
|
Modifier.toggleable(
Configure component to make it toggleable via input and accessibility events |
Scope: Any
|
Modifier.toggleable(
Configure component to make it toggleable via input and accessibility events. |
Scope: Any
|
Modifier.triStateToggleable(
Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate. |
Scope: Any
|
Modifier.triStateToggleable(
Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate. |
Alignment
Scope:
RowScope
|
Modifier.align(alignment: Alignment.Vertical)
Align the element vertically within the |
Scope:
RowScope
|
Position the element vertically such that the alignment line for the content as determined by |
Scope:
RowScope
|
Modifier.alignBy(alignmentLine: HorizontalAlignmentLine)
Position the element vertically such that its |
Scope:
RowScope
|
Position the element vertically such that its first baseline aligns with sibling elements also configured to |
Scope:
ColumnScope
|
Modifier.align(alignment: Alignment.Horizontal)
Align the element horizontally within the |
Scope:
ColumnScope
|
Position the element horizontally such that the alignment line for the content as determined by |
Scope:
ColumnScope
|
Modifier.alignBy(alignmentLine: VerticalAlignmentLine)
Position the element horizontally such that its |
Scope:
BoxScope
|
Pull the content element to a specific |
Animation
Scope:
AnimatedVisibilityScope open |
Modifier.animateEnterExit(
|
Scope:
LazyItemScope open |
Modifier.animateItem(
This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering). |
Scope:
LazyItemScope open |
@ExperimentalFoundationApi
This function is deprecated. Use Modifier.animateItem() instead |
Scope:
LazyStaggeredGridItemScope
|
Modifier.animateItem(
This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering). |
Scope:
LazyStaggeredGridItemScope open |
@ExperimentalFoundationApi
This function is deprecated. Use Modifier.animateItem() instead |
Border
Scope: Any
|
Modifier.border(border: BorderStroke, shape: Shape)
Modify element to add border with appearance specified with a |
Scope: Any
|
Modify element to add border with appearance specified with a |
Scope: Any
|
Modify element to add border with appearance specified with a |
Drawing
Scope: Any
|
Draw content with modified alpha that may be less than 1. |
Scope: Any
|
Modifier.background(color: Color, shape: Shape)
|
Scope: Any
|
Modifier.background(
|
Scope: Any
|
Clip the content to |
Scope: Any
|
Clip the content to the bounds of a layer defined at this modifier. |
Scope: Any
|
Modifier.drawBehind(onDraw: DrawScope.() -> Unit)
Draw into a |
Scope: Any
|
Modifier.drawWithCache(onBuildDrawCache: CacheDrawScope.() -> DrawResult)
Draw into a |
Scope: Any
|
Modifier.drawWithContent(onDraw: ContentDrawScope.() -> Unit)
Creates a |
Scope: Any
|
Modifier.indication(
Draws visual effects for this component when interactions occur. |
Scope: Any
|
Modifier.paint(
Paint the content using |
Scope: Any
|
Modifier.shadow(
Creates a |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Creates a modifier that controls the drawing order for the children of the same layout parent. |
Focus
Scope: Any
|
Modifier.onFocusChanged(onFocusChanged: (FocusState) -> Unit)
Add this modifier to a component to observe focus state events. |
Scope: Any
|
Modifier.onFocusEvent(onFocusEvent: (FocusState) -> Unit)
Add this modifier to a component to observe focus state events. |
Scope: Any
|
This function is deprecated. Replaced by focusTarget |
Scope: Any
|
Add this modifier to a component to make it focusable. |
Scope: Any
|
Modifier.
This function is deprecated. Use focusProperties() instead |
Scope: Any
|
Modifier.
This function is deprecated. Use focusRequester() instead |
Scope: Any
|
Modifier.
This function is deprecated. Use focusProperties() and focusRequester() instead |
Scope: Any
|
Modifier.focusProperties(scope: FocusProperties.() -> Unit)
This modifier allows you to specify properties that are accessible to |
Scope: Any
|
Modifier.focusRequester(focusRequester: FocusRequester)
Add this modifier to a component to request changes to focus. |
Scope: Any
|
@ExperimentalComposeUiApi
This modifier can be used to save and restore focus to a focus group. |
Scope: Any
|
Creates a focus group or marks this component as a focus group. |
Scope: Any
|
Modifier.focusable(
Configure component to be focusable via focus system or accessibility "focus" event. |
Scope: Any
|
@ExperimentalFoundationApi
Calls |
Graphics
Scope: Any
|
Modifier.graphicsLayer(block: GraphicsLayerScope.() -> Unit)
A |
Scope: Any
|
Modifier.graphicsLayer(
A |
Scope: Any
|
A |
Keyboard
Scope: Any
|
Modifier.onKeyEvent(onKeyEvent: (KeyEvent) -> Boolean)
Adding this |
Scope: Any
|
Modifier.onPreviewKeyEvent(onPreviewKeyEvent: (KeyEvent) -> Boolean)
Adding this |
Layout
Scope: Any
|
Alternative to |
Scope: Any
|
Tag the element with |
Scope: Any
|
Modifier.layout(measure: MeasureScope.(Measurable, Constraints) -> MeasureResult)
Creates a |
Scope: Any
|
Modifier.onGloballyPositioned(
Invoke |
Padding
Scope: Any
|
Modifier.paddingFrom(alignmentLine: AlignmentLine, before: Dp, after: Dp)
A |
Scope: Any
|
Modifier.paddingFrom(
A |
Scope: Any
|
Modifier.paddingFromBaseline(top: Dp, bottom: Dp)
A |
Scope: Any
|
Modifier.paddingFromBaseline(top: TextUnit, bottom: TextUnit)
A |
Scope: Any
|
Apply additional space along each edge of the content in |
Scope: Any
|
Apply |
Scope: Any
|
Modifier.padding(paddingValues: PaddingValues)
Apply |
Scope: Any
|
Apply |
Scope: Any
|
Apply additional space along each edge of the content in |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Adds padding to accommodate the |
Scope: Any
|
Modifier.windowInsetsPadding(insets: WindowInsets)
Adds padding so that the content doesn't enter |
Pointer
Scope: Any
|
Modifier.pointerHoverIcon(
Modifier that lets a developer define a pointer icon to display when the cursor is hovered over the element. |
Scope: Any
|
@ExperimentalComposeUiApi
A special PointerInputModifier that provides access to the underlying |
Scope: Any
|
@ExperimentalComposeUiApi
Modifier allowing to track pointer (i.e. mouse or trackpad) move events. |
Scope: Any
|
Modifier.
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. |
Scope: Any
|
Modifier.pointerInput(key1: Any?, block: suspend PointerInputScope.() -> Unit)
Create a modifier for processing pointer input within the region of the modified element. |
Scope: Any
|
Modifier.pointerInput(vararg keys: Any?, block: suspend PointerInputScope.() -> Unit)
Create a modifier for processing pointer input within the region of the modified element. |
Scope: Any
|
Modifier.pointerInput(key1: Any?, key2: Any?, block: suspend PointerInputScope.() -> Unit)
Create a modifier for processing pointer input within the region of the modified element. |
Position
Scope: Any
|
Modifier.absoluteOffset(offset: Density.() -> IntOffset)
Offset the content by |
Scope: Any
|
Modifier.absoluteOffset(x: Dp, y: Dp)
|
Scope: Any
|
Offset the content by |
Scope: Any
|
|
Scope:
TabRowDefaults
|
Modifier.tabIndicatorOffset(currentTabPosition: TabPosition)
|
Scope:
TabRowDefaults
|
Modifier.tabIndicatorOffset(currentTabPosition: TabPosition)
|
Semantics
Scope: Any
|
Contains the |
Scope: Any
|
Modifier.progressSemantics(
Contains the |
Scope: Any
|
Modifier.rangeSemantics(
Modifier to add semantics signifying progress of the Stepper/Slider. |
Scope: Any
|
Modifier.clearAndSetSemantics(properties: SemanticsPropertyReceiver.() -> Unit)
Clears the semantics of all the descendant nodes and sets new semantics. |
Scope: Any
|
Modifier.semantics(mergeDescendants: Boolean, properties: SemanticsPropertyReceiver.() -> Unit)
Add semantics key/value pairs to the layout node, for use in testing, accessibility, etc. |
Scroll
Scope: Any
|
Modifier.clipScrollableContainer(orientation: Orientation)
Clips bounds of scrollable container on main axis while leaving space for background effects (like shadows) on cross axis. |
Scope: Any
|
Modifier.
This function is deprecated. Use Modifier.pointerInput + PointerEventType.Scroll |
Scope: Any
|
Modifier.nestedScroll(
Modify element to make it participate in the nested scrolling hierarchy. |
Scope: Any
|
@ExperimentalFoundationApi
Renders overscroll from the provided |
Scope: Any
|
Modifier.onPreRotaryScrollEvent(
Adding this |
Scope: Any
|
Modifier.onRotaryScrollEvent(
Adding this |
Scope: Any
|
Modifier.rotaryScrollable(
A modifier which connects rotary events with scrollable containers such as Column, LazyList and others. |
Scope: Any
|
Modifier.scrollAway(scrollState: ScrollState, offset: Dp)
Scroll an item vertically in/out of view based on a |
Scope: Any
|
Modifier.scrollAway(
Scroll an item vertically in/out of view based on a |
Scope: Any
|
Modifier.scrollAway(
Scroll an item vertically in/out of view based on a |
Scope: Any
|
Modifier.
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 |
Scope: Any
|
Modifier.horizontalScroll(
Modify element to allow to scroll horizontally when width of the content is bigger than max constraints allow. |
Scope: Any
|
Modifier.verticalScroll(
Modify element to allow to scroll vertically when height of the content is bigger than max constraints allow. |
Scope: Any
|
Modifier.scrollable(
Configure touch scrolling and flinging for the UI element in a single |
Scope: Any
|
@ExperimentalFoundationApi
Configure touch scrolling and flinging for the UI element in a single |
Scope: Any
|
@ExperimentalTvFoundationApi
This function is deprecated. scrollableWithPivot has been deprecated. |
Scope: Any
|
Controls the soft keyboard as a nested scrolling on Android |
Size
Scope: Any
|
Modifier.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. |
Scope: Any
|
Modifier.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. |
Scope: Any
|
Modifier.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: |
Scope: Any
|
Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller. |
Scope: Any
|
Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller. |
Scope: Any
|
Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller. |
Scope: Any
|
Reserves at least 48.dp in size to disambiguate touch interactions if the element would measure smaller. |
Scope: Any
|
Modifier.height(intrinsicSize: IntrinsicSize)
Declare the preferred height of the content to be the same as the min or max intrinsic height of the content. |
Scope: Any
|
Modifier.requiredHeight(intrinsicSize: IntrinsicSize)
Declare the height of the content to be exactly the same as the min or max intrinsic height of the content. |
Scope: Any
|
Modifier.requiredWidth(intrinsicSize: IntrinsicSize)
Declare the width of the content to be exactly the same as the min or max intrinsic width of the content. |
Scope: Any
|
Modifier.width(intrinsicSize: IntrinsicSize)
Declare the preferred width of the content to be the same as the min or max intrinsic width of the content. |
Scope: Any
|
Modifier.onSizeChanged(onSizeChanged: (IntSize) -> Unit)
Invoked with the size of the modified Compose UI element when the element is first measured or when the size of the element changes. |
Scope: Any
|
Modifier.defaultMinSize(minWidth: Dp, minHeight: Dp)
Constrain the size of the wrapped layout only when it would be otherwise unconstrained: the |
Scope: Any
|
Modifier.fillMaxHeight(fraction: @FloatRange(from = 0.0, to = 1.0) Float)
Have the content fill (possibly only partially) the |
Scope: Any
|
Modifier.fillMaxSize(fraction: @FloatRange(from = 0.0, to = 1.0) Float)
Have the content fill (possibly only partially) the |
Scope: Any
|
Modifier.fillMaxWidth(fraction: @FloatRange(from = 0.0, to = 1.0) Float)
Have the content fill (possibly only partially) the |
Scope: Any
|
Declare the preferred height of the content to be exactly |
Scope: Any
|
Constrain the height of the content to be between |
Scope: Any
|
Modifier.requiredHeight(height: Dp)
Declare the height of the content to be exactly |
Scope: Any
|
Modifier.requiredHeightIn(min: Dp, max: Dp)
Constrain the height of the content to be between |
Scope: Any
|
Modifier.requiredSize(size: Dp)
Declare the size of the content to be exactly |
Scope: Any
|
Modifier.requiredSize(size: DpSize)
Declare the size of the content to be exactly |
Scope: Any
|
Modifier.requiredSize(width: Dp, height: Dp)
Declare the size of the content to be exactly |
Scope: Any
|
Constrain the width of the content to be between |
Scope: Any
|
Modifier.requiredWidth(width: Dp)
Declare the width of the content to be exactly |
Scope: Any
|
Modifier.requiredWidthIn(min: Dp, max: Dp)
Constrain the width of the content to be between |
Scope: Any
|
Declare the preferred size of the content to be exactly |
Scope: Any
|
Declare the preferred size of the content to be exactly |
Scope: Any
|
Declare the preferred size of the content to be exactly |
Scope: Any
|
Constrain the width of the content to be between |
Scope: Any
|
Declare the preferred width of the content to be exactly |
Scope: Any
|
Constrain the width of the content to be between |
Scope: Any
|
Modifier.wrapContentHeight(
Allow the content to measure at its desired height without regard for the incoming measurement |
Scope: Any
|
Modifier.wrapContentSize(align: Alignment, unbounded: Boolean)
Allow the content to measure at its desired size without regard for the incoming measurement |
Scope: Any
|
Modifier.wrapContentWidth(
Allow the content to measure at its desired width without regard for the incoming measurement |
Scope: Any
|
Modifier.touchTargetAwareSize(size: Dp)
Modifier to set both the size and recommended touch target for |
Scope: Any
|
Modifier.windowInsetsBottomHeight(insets: WindowInsets)
Sets the height to that of |
Scope: Any
|
Modifier.windowInsetsEndWidth(insets: WindowInsets)
Sets the width to that of |
Scope: Any
|
Modifier.windowInsetsStartWidth(insets: WindowInsets)
Sets the width to that of |
Scope: Any
|
Modifier.windowInsetsTopHeight(insets: WindowInsets)
|
Scope:
RowScope
|
Modifier.weight(
Size the element's width proportional to its |
Scope:
ColumnScope
|
Modifier.weight(
Size the element's height proportional to its |
Scope:
BoxScope
|
Size the element to match the size of the |
Scope:
LazyItemScope
|
Modifier.fillParentMaxHeight(
Have the content fill the |
Scope:
LazyItemScope
|
Modifier.fillParentMaxSize(
Have the content fill the |
Scope:
LazyItemScope
|
Modifier.fillParentMaxWidth(
Have the content fill the |
Scope:
ExposedDropdownMenuBoxScope abstract |
Modifier.exposedDropdownSize(matchTextFieldWidth: Boolean)
Modifier which should be applied to an |
Scope:
ExposedDropdownMenuBoxScope abstract |
Modifier.exposedDropdownSize(matchTextFieldWidth: Boolean)
Modifier which should be applied to a menu placed inside the |
Testing
Scope: Any
|
Applies a tag to allow modified element to be found in tests. |
Transformations
Scope: Any
|
Sets the degrees the view is rotated around the center of the composable. |
Scope: Any
|
Scale the contents of both the horizontal and vertical axis uniformly by the same scale factor. |
Scope: Any
|
Scale the contents of the composable by the following scale factors along the horizontal and vertical axis respectively. |
Scope: Any
|
Modifier.transformable(
Enable transformation gestures of the modified UI element. |
Scope: Any
|
@ExperimentalFoundationApi
Enable transformation gestures of the modified UI element. |
Other
Scope: Any
|
@ExperimentalFoundationApi
A Modifier that allows an element it is applied to to be treated like a source for drag and drop operations. |
Scope: Any
|
Modifier.basicMarquee(
Applies an animated marquee effect to the modified content if it's too wide to fit in the available space. |
Scope: Any
|
Modifier.edgeSwipeToDismiss(
Limits swipe to dismiss to be active from the edge of the viewport only. |
Scope: Any
|
Modifier.blur(radius: Dp, edgeTreatment: BlurredEdgeTreatment)
Draw content blurred with the specified radii. |
Scope: Any
|
Modifier.blur(
Draw content blurred with the specified radii. |
Scope: Any
|
@ExperimentalFoundationApi
Modifier that can be used to send |
Scope: Any
|
A parent that can respond to |
Scope: Any
|
Modifier.composed(
Declare a just-in-time composition of a |
Scope: Any
|
@ExperimentalComposeUiApi
Declare a just-in-time composition of a |
Scope: Any
|
@ExperimentalComposeUiApi
Declare a just-in-time composition of a |
Scope: Any
|
@ExperimentalComposeUiApi
Declare a just-in-time composition of a |
Scope: Any
|
@ExperimentalComposeUiApi
Declare a just-in-time composition of a |
Scope: Any
|
@ExperimentalFoundationApi
A Modifier that allows an element it is applied to to be treated like a source for drag and drop operations. |
Scope: Any
|
@ExperimentalFoundationApi
A modifier that allows for receiving from a drag and drop gesture. |
Scope: Any
|
This function is deprecated. Use systemGestureExclusion |
Scope: Any
|
Modifier.
This function is deprecated. Use systemGestureExclusion |
Scope: Any
|
Modifier.handwritingDetector(callback: () -> Unit)
Configures an element to act as a handwriting detector which detects stylus handwriting and delegates handling of the recognised text to another element. |
Scope: Any
|
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. |
Scope: Any
|
Modifier.hoverable(
Configure component to be hoverable via pointer enter/exit events. |
Scope: Any inline |
Modifier.
This function is deprecated. This API will create more invalidations of your modifier than necessary, so it's use is discouraged. |
Scope: Any
|
Modifier.approachLayout(
Creates an approach layout intended to help gradually approach the destination layout calculated in the lookahead pass. |
Scope: Any
|
Modifier.magnifier(
Shows a |
Scope: Any
|
@ExperimentalComposeUiApi
A Modifier that can be used to consume |
Scope: Any
|
@ExperimentalComposeUiApi
A Modifier that can be used to provide |
Scope: Any
|
Modifier.onPlaced(onPlaced: (LayoutCoordinates) -> Unit)
Invoke |
Scope: Any
|
@ExperimentalWearMaterialApi
Draws a placeholder shape over the top of a composable and animates a wipe off effect to remove the placeholder. |
Scope: Any
|
@ExperimentalWearMaterialApi
Modifier to draw a placeholder shimmer over a component. |
Scope: Any
|
@ExperimentalComposeUiApi
Calls |
Scope: Any
|
Mark the layout rectangle as preferring to stay clear of floating windows. |
Scope: Any
|
Modifier.preferKeepClear(rectProvider: (LayoutCoordinates) -> Rect)
Mark a rectangle within the local layout coordinates preferring to stay clear of floating windows. |
Scope: Any
|
@ExperimentalMaterialApi
A modifier for translating the position and scaling the size of a pull-to-refresh indicator based on the given |
Scope: Any
|
@ExperimentalMaterialApi
A nested scroll modifier that provides scroll events to |
Scope: Any
|
@ExperimentalMaterialApi
A nested scroll modifier that provides |
Scope: Any
|
@ExperimentalMaterial3Api
A Modifier that adds nested scroll to a container to support a pull-to-refresh gesture. |
Scope: Any
|
@ExperimentalMaterial3Api
A Modifier that handles the size, offset, clipping, shadow, and background drawing of a pull-to-refresh indicator, useful when implementing custom indicators. |
Scope: Any
|
@ExperimentalFoundationApi
Configures the current node and any children nodes as a Content Receiver. |
Scope: Any
|
@ExperimentalComposeUiApi
Adding this |
Scope: Any
|
@ExperimentalComposeUiApi
Adding this |
Scope: Any
|
Modifier.
This function is deprecated. SwipeToDismiss has been migrated to androidx.wear.compose.foundation. |
Scope: Any
|
Excludes the layout rectangle from the system gesture. |
Scope: Any
|
Modifier.systemGestureExclusion(exclusion: (LayoutCoordinates) -> Rect)
Excludes a rectangle within the local layout coordinates from the system gesture. |
Scope: Any
|
Modifier.consumeWindowInsets(insets: WindowInsets)
Consume insets that haven't been consumed yet by other insets Modifiers similar to |
Scope: Any
|
Modifier.consumeWindowInsets(paddingValues: PaddingValues)
Consume |
Scope: Any
|
Modifier.onConsumedWindowInsetsChanged(
Calls |
Scope:
TooltipBoxScope
|
|
Scope:
ExposedDropdownMenuBoxScope
|
This function is deprecated. Use overload that takes MenuAnchorType and enabled parameters |
Scope:
ExposedDropdownMenuBoxScope abstract |
Modifier.menuAnchor(type: MenuAnchorType, enabled: Boolean)
Modifier which should be applied to an element inside the |