Actions
|
Enable drag gestures between a set of predefined values. |
Scope: Any
|
|
Enable drag gestures between a set of predefined values. |
Scope: Any
|
|
Configure component to receive clicks via input or accessibility "click" event. |
Scope: Any
|
|
Configure component to receive clicks via input or accessibility "click" event. |
Scope: Any
|
|
Configure component to receive clicks, double clicks and long clicks via input or accessibility "click" event. |
Scope: Any
|
|
Configure component to receive clicks, double clicks and long clicks via input or accessibility "click" event. |
Scope: Any
|
|
Configure touch dragging for the UI element in both orientations. |
Scope: Any
|
|
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
|
|
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
|
|
Configure component to make it toggleable via input and accessibility events |
Scope: Any
|
|
Configure component to make it toggleable via input and accessibility events. |
Scope: Any
|
|
Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate. |
Scope: Any
|
|
Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate. |
Scope: Any
|
|
The modifier that should be applied on a drag handle composable so the drag handle can be dragged and operate on the provided |
Scope:
PaneScaffoldScope |
Alignment
|
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 |
|
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:
RowScope |
|
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 |
|
Position the element horizontally such that its |
Scope:
ColumnScope |
|
Pull the content element to a specific |
Scope:
BoxScope |
Animation
|
|
Scope: Any
|
|
Apply this modifier to a |
Scope: Any
|
|
|
Scope:
AnimatedVisibilityScope
|
|
This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering). |
Scope:
LazyItemScope
|
|
This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering). |
Scope:
LazyGridItemScope |
|
This modifier animates the item appearance (fade in), disappearance (fade out) and placement changes (such as an item reordering). |
Scope:
LazyStaggeredGridItemScope |
Border
|
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 |
Scope: Any
|
Drawing
|
Draw content with modified alpha that may be less than 1. |
Scope: Any
|
|
Draws |
Scope: Any
|
|
Draws |
Scope: Any
|
|
Clip the content to |
Scope: Any
|
|
Clip the content to the bounds of a layer defined at this modifier. |
Scope: Any
|
|
Draw into a |
Scope: Any
|
|
Draw into a |
Scope: Any
|
|
Creates a |
Scope: Any
|
|
Draws visual effects for this component when interactions occur. |
Scope: Any
|
|
Paint the content using |
Scope: Any
|
|
Draws a drop shadow behind the rest of the content with the geometry specified by the given shape and the shadow properties defined the |
Scope: Any
|
|
Draws a drop shadow behind the rest of the content with the geometry specified by the given shape and the shadow properties defined by the |
Scope: Any
|
|
Draws an inner shadow behind the rest of the content with the geometry specified by the given shape and the shadow properties defined the |
Scope: Any
|
|
Draws an inner shadow on top of the rest of the content with the geometry specified by the given shape and the shadow properties defined by the |
Scope: Any
|
|
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. |
Scope: Any
|
Focus
|
Add this modifier to a component to observe focus state events. |
Scope: Any
|
|
Add this modifier to a component to observe focus state events. |
Scope: Any
|
|
Add this modifier to a component to make it focusable. |
Scope: Any
|
|
This modifier allows you to specify properties that are accessible to |
Scope: Any
|
|
Add this modifier to a component to request changes to focus. |
Scope: Any
|
|
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
|
|
Configure component to be focusable via focus system or accessibility "focus" event. |
Scope: Any
|
Graphics
|
A |
Scope: Any
|
|
A |
Scope: Any
|
|
A |
Scope: Any
|
Keyboard
|
Adding this |
Scope: Any
|
|
Adding this |
Scope: Any
|
Layout
|
Alternative to |
Scope: Any
|
|
Tag the element with |
Scope: Any
|
|
Creates a |
Scope: Any
|
|
Invoke |
Scope: Any
|
Other
|
Set autofill hint with |
Scope: Any
|
|
Applies an animated marquee effect to the modified content if it's too wide to fit in the available space. |
Scope: Any
|
|
Draw content blurred with the specified radii. |
Scope: Any
|
|
Draw content blurred with the specified radii. |
Scope: Any
|
|
Modifier that can be used to send |
Scope: Any
|
|
Declare a just-in-time composition of a |
Scope: Any
|
|
Declare a just-in-time composition of a |
Scope: Any
|
|
Declare a just-in-time composition of a |
Scope: Any
|
|
Declare a just-in-time composition of a |
Scope: Any
|
|
Declare a just-in-time composition of a |
Scope: Any
|
|
A |
Scope: Any
|
|
A |
Scope: Any
|
|
A modifier that allows for receiving from a drag and drop gesture. |
Scope: Any
|
|
Set a requested frame rate on Composable |
Scope: Any
|
|
Set a requested frame rate on Composable |
Scope: Any
|
|
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
|
|
Configure component to be hoverable via pointer enter/exit events. |
Scope: Any
|
|
A modifier that keeps the device screen on as long as it is part of the composition on supported platforms. |
Scope: Any
|
|
This will map the |
Scope: Any
|
|
Creates an approach layout intended to help gradually approach the destination layout calculated in the lookahead pass. |
Scope: Any
|
|
Shows a |
Scope: Any
|
|
A Modifier that can be used to consume |
Scope: Any
|
|
A Modifier that can be used to provide |
Scope: Any
|
|
Invokes |
Scope: Any
|
|
Invoke |
Scope: Any
|
|
Registers a callback to monitor whether or not the node is inside of the viewport of the window or not. |
Scope: Any
|
|
Modifier that lets a developer define a pointer icon to display when a stylus is hovered over the element. |
Scope: Any
|
|
Calls |
Scope: Any
|
|
Mark the layout rectangle as preferring to stay clear of floating windows. |
Scope: Any
|
|
Mark a rectangle within the local layout coordinates preferring to stay clear of floating windows. |
Scope: Any
|
|
A Modifier that adds nested scroll to a container to support a pull-to-refresh gesture. |
Scope: Any
|
|
Configures the current node and any children nodes as a Content Receiver. |
Scope: Any
|
|
Fits the contents within |
Scope: Any
|
|
If one of the |
Scope: Any
|
|
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. |
Scope: Any
|
|
Adding this |
Scope: Any
|
|
Adding this |
Scope: Any
|
|
Modifier that creates a region that is styled by the given |
Scope: Any
|
|
Modifier that creates a region that is styled by the given |
Scope: Any
|
|
Excludes the layout rectangle from the system gesture. |
Scope: Any
|
|
Excludes a rectangle within the local layout coordinates from the system gesture. |
Scope: Any
|
|
Adds a |
Scope: Any
|
|
Adds a |
Scope: Any
|
|
A |
Scope: Any
|
|
Consume insets that haven't been consumed yet by other insets Modifiers similar to |
Scope: Any
|
|
Consume |
Scope: Any
|
|
Calls |
Scope: Any
|
|
This recalculates the |
Scope: Any
|
|
Renders the content in the |
Scope:
SharedTransitionScope |
|
|
Scope:
SharedTransitionScope |
|
|
Scope:
SharedTransitionScope |
|
|
Scope:
SharedTransitionScope |
|
A modifier that anchors a layout at the target position obtained from the lookahead pass during shared element transitions. |
Scope:
SharedTransitionScope
|
|
Modifier which should be applied to an element inside the |
Scope:
ExposedDropdownMenuBoxScope
|
|
This modifier specifies the associated pane's margins according to the provided |
Scope:
PaneScaffoldScope |
|
This modifier specifies the associated pane's margins according to specified fixed margins and the provided |
Scope:
PaneScaffoldScope |
Padding
|
A |
Scope: Any
|
|
A |
Scope: Any
|
|
A |
Scope: Any
|
|
A |
Scope: Any
|
|
Apply additional space along each edge of the content in |
Scope: Any
|
|
Apply |
Scope: Any
|
|
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
|
|
Adds padding so that the content doesn't enter |
Scope: Any
|
Pointer
|
A |
Scope: Any
|
|
Modifier that lets a developer define a pointer icon to display when the cursor is hovered over the element. |
Scope: Any
|
|
A special PointerInputModifier that provides access to the underlying |
Scope: Any
|
|
Create a modifier for processing pointer input within the region of the modified element. |
Scope: Any
|
|
Create a modifier for processing pointer input within the region of the modified element. |
Scope: Any
|
|
Create a modifier for processing pointer input within the region of the modified element. |
Scope: Any
|
Position
|
Offset the content by |
Scope: Any
|
|
Offset the content by ( |
Scope: Any
|
|
Offset the content by |
Scope: Any
|
|
Offset the content by ( |
Scope: Any
|
Scroll
|
Clips bounds of scrollable container on main axis while leaving space for background effects (like shadows) on cross axis. |
Scope: Any
|
|
Modify element to make it participate in the nested scrolling hierarchy. |
Scope: Any
|
|
Renders overscroll from the provided |
Scope: Any
|
|
Adding this |
Scope: Any
|
|
Adding this |
Scope: Any
|
|
Modify element to allow to scroll horizontally when width of the content is bigger than max constraints allow. |
Scope: Any
|
|
Modify element to allow to scroll horizontally when width of the content is bigger than max constraints allow. |
Scope: Any
|
|
Modify element to allow to scroll vertically when height of the content is bigger than max constraints allow. |
Scope: Any
|
|
Modify element to allow to scroll vertically when height of the content is bigger than max constraints allow. |
Scope: Any
|
|
Configure touch scrolling and flinging for the UI element in both XY orientations. |
Scope: Any
|
|
Configure a component to act as a scrollable area. |
Scope: Any
|
|
Configure a component to act as a scrollable area. |
Scope: Any
|
|
Configure touch scrolling and flinging for the UI element in a single |
Scope: Any
|
|
Configure touch scrolling and flinging for the UI element in a single |
Scope: Any
|
|
A visual-only scrollbar that represents the current scroll position of a scrolling component. |
Scope: Any
|
|
Controls the soft keyboard as a nested scrolling on Android |
Scope: Any
|
Semantics
|
Contains the |
Scope: Any
|
|
Contains the |
Scope: Any
|
|
Clears the semantics of all the descendant nodes and sets new semantics. |
Scope: Any
|
|
Add semantics key/value pairs to the layout node, for use in testing, accessibility, etc. |
Scope: Any
|
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. |
Scope: Any
|
|
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
|
|
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
|
|
Declare the preferred height of the content to be the same as the min or max intrinsic height of the content. |
Scope: Any
|
|
Declare the height of the content to be exactly the same as the min or max intrinsic height of the content. |
Scope: Any
|
|
Declare the width of the content to be exactly the same as the min or max intrinsic width of the content. |
Scope: Any
|
|
Declare the preferred width of the content to be the same as the min or max intrinsic width of the content. |
Scope: Any
|
|
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
|
|
Constrain the size of the wrapped layout only when it would be otherwise unconstrained: the |
Scope: Any
|
|
Have the content fill (possibly only partially) the |
Scope: Any
|
|
Have the content fill (possibly only partially) the |
Scope: Any
|
|
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
|
|
Declare the height of the content to be exactly |
Scope: Any
|
|
Constrain the height of the content to be between |
Scope: Any
|
|
Declare the size of the content to be exactly |
Scope: Any
|
|
Declare the size of the content to be exactly |
Scope: Any
|
|
Declare the size of the content to be exactly |
Scope: Any
|
|
Constrain the width of the content to be between |
Scope: Any
|
|
Declare the width of the content to be exactly |
Scope: Any
|
|
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
|
|
Allow the content to measure at its desired height without regard for the incoming measurement |
Scope: Any
|
|
Allow the content to measure at its desired size without regard for the incoming measurement |
Scope: Any
|
|
Allow the content to measure at its desired width without regard for the incoming measurement |
Scope: Any
|
|
Sets the height to that of |
Scope: Any
|
|
Sets the width to that of |
Scope: Any
|
|
Sets the width to that of |
Scope: Any
|
|
Sets the height to that of |
Scope: Any
|
|
Attempts to size the original content rectangle to be inscribed into a destination by applying a specified |
Scope: Any
|
|
|
Scope:
SharedTransitionScope |
|
Size the element's width proportional to its |
Scope:
RowScope |
|
Size the element's height proportional to its |
Scope:
ColumnScope |
|
Have the item fill (possibly only partially) the max height of the tallest item in the row it was placed in, within the |
Scope:
FlowRowScope |
|
Have the item fill (possibly only partially) the max width of the widest item in the column it was placed in, within the |
Scope:
FlowColumnScope |
|
Size the element to match the size of the |
Scope:
BoxScope |
|
Have the content fill the |
Scope:
LazyItemScope |
|
Have the content fill the |
Scope:
LazyItemScope |
|
Have the content fill the |
Scope:
LazyItemScope |
|
Modifier which should be applied to a menu placed inside the |
Scope:
ExposedDropdownMenuBoxScope
|
|
This modifier specifies the preferred height for a pane in |
Scope:
PaneScaffoldScope |
|
This modifier specifies the preferred height for a pane as a proportion of the overall scaffold height. |
Scope:
PaneScaffoldScope |
|
This modifier specifies the preferred width for a pane as a proportion of the overall scaffold width. |
Scope:
PaneScaffoldScope |
|
This modifier specifies the preferred width for a pane in |
Scope:
PaneScaffoldScope |
Testing
|
Applies a tag to allow modified element to be found in tests. |
Scope: Any
|
Transformations
|
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
|
|
Enable transformation gestures of the modified UI element. |
Scope: Any
|