- addPathNodes
-
addPointerInputChange
Track the positions and timestamps inside this event change.
-
anyChangeConsumed
True if any aspect of this PointerInputChange has been consumed.
-
boundsInParent
Returns the bounding box of the child in the parent's content area, including any clipping done with respect to the parent.
-
boundsInRoot
The boundaries of this layout inside the root composable.
- boundsInWindow
-
bringIntoView
Bring this node into visible bounds.
- CacheDrawModifierNode
-
captureFocus
Deny requests to clear focus.
-
changedToDown
True if this PointerInputChange represents a pointer coming in contact with the screen and that change has not been consumed.
-
changedToDownIgnoreConsumed
True if this PointerInputChange represents a pointer coming in contact with the screen, whether or not that change has been consumed.
-
changedToUp
True if this PointerInputChange represents a pointer breaking contact with the screen and that change has not been consumed.
-
changedToUpIgnoreConsumed
True if this PointerInputChange represents a pointer breaking contact with the screen, whether or not that change has been consumed.
-
clearTextSubstitution
Action to clear the text substitution of this node.
-
collapse
Action to collapse an expandable node.
-
consumeAllChanges
Consumes all changes associated with the PointerInputChange
-
consumeDownChange
Consume the up or down change of this PointerInputChange if there is an up or down change to consume.
-
consumePositionChange
Consume position change if there is any
- ContentDataType
-
ContentType
Create a custom `ContentType` with contentHint.
-
copyText
Action to copy the text to the clipboard.
-
createFromAutofillValue
Creates a FillableData from the platform AutofillValue type.
-
createFromBoolean
Creates a FillableData instance from a Boolean.
-
createFromDateMillis
Creates a FillableData instance from a Long.
-
createFromListIndex
Creates a FillableData instance from an Int.
-
createFromText
Creates a FillableData instance from a CharSequence.
-
createLifecycleAwareWindowRecomposer
Create a Lifecycle and window attachment[View.
-
currentValueOf
Returns the current value of local at the position in the composition hierarchy of this modifier's attached layout node.
-
cutText
Action to cut the text and copy it to the clipboard.
-
debugInspectorInfo
Use this to specify modifier information for compose tooling.
-
dialog
Whether this element is a Dialog.
-
disabled
Whether this semantics node is disabled.
-
disableWindowInsetsRulers
Used to disable [androidx.
-
dismiss
Action to dismiss a dismissible node.
-
dispatchDraw
If the node implements DrawModifierNode, then this will just call [DrawModifierNode.
-
dispatchOnScrollChanged
Call this function whenever a scroll chang happened in the LayoutNode that this DelegatableNode is attached to to let the underlying platform know that a scroll event happened in…
-
div
Division operator with Size
-
DpTouchBoundsExpansion
Creates a DpTouchBoundsExpansion that's aware of LayoutDirection.
-
DragAndDropModifierNode
Creates a [Modifier.
-
DragAndDropSourceModifierNode
Creates a DragAndDropSourceModifierNode for starting platform drag and drop sessions with the intention of transferring data.
-
DragAndDropTargetModifierNode
Creates a DragAndDropTargetModifierNode for receiving transfer data from platform drag and drop sessions.
-
error
Mark semantics node that contains invalid input or error.
-
establishTextInputSession
Starts a new text input session and suspends until the session is closed.
-
expand
Action to expand an expandable node.
-
findNearestAncestor
Finds the nearest traversable ancestor with a matching key.
-
findNearestBeyondBoundsLayoutAncestor
Call this function to find the nearest BeyondBoundsLayout to the current node.
-
findRootCoordinates
Walks up the LayoutCoordinates hierarchy to find the LayoutCoordinates whose [LayoutCoordinates.
-
findViewTreeComposeViewContext
Returns the ComposeViewContext used in this View's part of the hierarchy, or `null` if one cannot be found or it doesn't match the values set for [View.
-
findViewTreeCompositionContext
Returns the parent CompositionContext for this point in the view hierarchy, or `null` if none can be found.
-
firstUriOrNull
Returns the first non-null Uri from the list of [ClipData.
-
FocusTargetModifierNode
Create a FocusTargetModifierNode that can be delegated to in order to create a modifier that makes a component focusable.
-
freeFocus
Use this function to send a request to free focus when one of the components associated with this FocusRequester is in a Captured state.
-
getAllSemanticsNodes
Finds all SemanticsNodes in the tree owned by this SemanticsOwner.
-
getDisplayCutoutBounds
Returns a List of RectRulers, one RectRulers for each display cutout.
-
getFocusedRect
Calculates the rectangular area in this node's coordinates that corresponds to the focus area of the focused node under this FocusTargetModifierNode, including itself.
- getOrNull
-
getScrollViewportLength
Action to get a scrollable's active view port amount for scrolling actions.
-
getTextLayoutResult
Action to get a Text/TextField node's TextLayoutResult.
-
GraphicsLayerScope
Creates simple GraphicsLayerScope.
-
group
DSL extension for adding a VectorGroup to this.
-
heading
The node is marked as heading for accessibility.
-
hideFromAccessibility
If present, this node is considered hidden from accessibility services.
-
imageResource
Load an ImageBitmap from an image resource.
-
indexForKey
The index of an item identified by a given key.
-
indexOfFirstPressed
Returns the index of first button pressed as used in isPressed or `-1` if no button is pressed.
-
indexOfLastPressed
Returns the index of last button pressed as used in isPressed or `-1` if no button is pressed.
-
IndirectPointerEvent
Allows creation of a IndirectPointerEvent from a MotionEvent for cross module testing.
-
innermostOf
Merges multiple RectRulers into a single RectRulers, using the inner-most value.
-
insertTextAtCursor
Action to insert text into this node at the current cursor position, or replacing the selection if text is selected.
-
invalidateDraw
Invalidates this modifier's draw layer, ensuring that a draw pass will be run on the next frame.
-
invalidateDrawForSubtree
Invalidates draw for the entire subtree of this node.
- invalidateFocusProperties
-
invalidateLayer
This will invalidate the current node's layer, and ensure that the layer is redrawn for the next frame.
-
invalidateMeasurement
This invalidates the current node's measure result, and ensures that a re-measurement (the measurement block rerun) of this node will happen for the next frame.
-
invalidateMeasurementForSubtree
Invalidates measurements for the entire subtree of this node.
-
invalidateParentData
This invalidates the current node's parent data, and ensures that layouts that utilize it will be scheduled to relayout for the next frame.
-
invalidatePlacement
This will invalidate the current node's placement result, and ensure that relayout (the placement block rerun) of this node will happen for the next frame .
-
invalidateSemantics
Invalidate semantics associated with this node.
-
invalidateSubtree
Invalidates the subtree of this layout, including layout, drawing, parent data, etc.
-
invisibleToUser
Whether this node is specially known to be invisible to the user.
-
isOutOfBounds
Returns `true` if the pointer has moved outside of the region of `(0, 0, size.
-
isPopupLayout
Returns whether the given view is an underlying decor view of a popup.
-
isPressed
Returns `true` when the button at buttonIndex is pressed and `false` when it isn't pressed.
- Key
-
lerp
Linearly interpolate between two ScaleFactor parameters
-
lookaheadScopeCoordinates
Obtains the LayoutCoordinates for the given LookaheadScope using a LayoutCoordinates within the LookaheadScope.
-
materialize
Materialize any instance-specific composed modifierscomposed for applying to a raw tree node.
-
materializeWithCompositionLocalInjection
This function exists solely for solving a backwards-incompatibility with older compilations that used an older version of the `Layout` composable.
-
mediaQuery
Evaluates a boolean query against the current UiMediaScope from a CompositionLocalAccessorScope.
-
mimeTypes
The mime types present in a DragAndDropEvent
-
modifierLocalMapOf
Creates an empty ModifierLocalMap
-
modifierLocalOf
Creates a ProvidableModifierLocal and specifies a default factory.
-
nestedScrollModifierNode
This creates a Nested Scroll Modifier node that can be delegated to.
-
observeReads
Use this function to observe snapshot reads for any target within the specified block.
-
onAutofillText
Action to autofill a TextField.
-
onClick
Action to be performed when the node is clicked (single-tapped).
-
onFillData
Action that an autofill service can invoke to fill the component with data.
-
onImeAction
Action to invoke the IME action handler configured on the node, as well as specify the type of IME action provided by the node.
-
onLongClick
Action to be performed when the node is long clicked (long-pressed).
-
onVisibilityChangedNode
Creates a DelegatableNode for a modifier node, implementing the contract of onVisibilityChanged Modifier.
-
outermostOf
Merges multiple RectRulers into a single RectRulers, using the outer-most value.
-
pageDown
Action to page down.
-
pageLeft
Action to page left.
-
pageRight
Action to page right.
-
pageUp
Action to page up.
-
password
The node is marked as a password.
-
pasteText
This function adds the [SemanticsActions.
-
path
DSL extension for adding a VectorPath to this.
- PathData
- performImeAction
-
PointerIcon
Creates PointerIcon from [android.
-
popup
Whether this semantics node represents a Popup.
-
positionChange
The distance that the pointer has moved on the screen minus any distance that has been consumed.
-
positionChangeConsumed
True if this PointerInputChange's movement has been consumed.
-
positionChanged
True if this PointerInputChange represents a pointer moving on the screen and some of that movement has not been consumed.
-
positionChangedIgnoreConsumed
True if this PointerInputChange represents a pointer moving on the screen ignoring how much of that movement may have been consumed.
-
positionChangeIgnoreConsumed
The distance that the pointer has moved on the screen, ignoring the fact that it might have been consumed.
-
positionInParent
Returns the position of the top-left in the parent's content area or (0, 0) for the root.
-
positionInRoot
The position of this layout inside the root composable.
-
positionInWindow
The position of this layout relative to the window.
-
positionOnScreen
The position of this layout on the device's screen.
-
RectRulers
Creates a RectRulers.
-
registerOnGlobalLayoutListener
Registers a callback to be executed with the position of this modifier node relative to the coordinate system of the root of the composition, as well as in screen coordinates and…
-
registerOnLayoutRectChanged
Registers a callback to be executed with the position of this modifier node relative to the coordinate system of the root of the composition, as well as in screen coordinates and…
-
remeasureSync
Performs the node remeasuring synchronously even if the node was not marked as needs remeasure before.
-
requestAutofill
Requests autofill for the LayoutNode that this DelegatableNode is attached to.
-
requestFocus
Action that gives input focus to this node.
-
requestFocusForChildInRootBounds
Attempts to request focus for the most suitable focusable child node that overlaps with the given rect area (left, top, right, bottom).
-
requireDensity
Returns the current Density of the LayoutNode that this DelegatableNode is attached to.
-
requireGraphicsContext
Returns the current GraphicsContext of the Owner
-
requireLayoutCoordinates
Returns the LayoutCoordinates of this node.
-
requireLayoutDirection
Returns the current LayoutDirection of the LayoutNode that this DelegatableNode is attached to.
-
requireView
The Android View hosting the composition.
-
restoreFocusedChild
Use this function to restore focus to one of the children of the node pointed to by this FocusRequester.
-
saveFocusedChild
Use this function to request the focus target to save a reference to the currently focused child in its saved instance state.
-
ScaleFactor
Constructs a ScaleFactor from the given x and y scale values
-
scrollBy
Action to asynchronously scroll by a specified amount.
-
scrollByOffset
Action to scroll by a specified amount and return how much of the offset was actually consumed.
-
scrollToIndex
Action to scroll a container to the index of one of its items.
-
selectableGroup
The node is marked as a collection of horizontally or vertically stacked selectable elements.
-
SemanticsPropertyKey
Creates a SemanticsPropertyKey that allows declaring Android-specific semantics properties (key/value pairs set inside semantics blocks in a type-safe way) that are made available…
-
setProgress
Action to set the current value of the progress bar.
-
setSelection
Action to set text selection by character index range.
-
setText
Action to set the text contents of this node.
-
setTextSubstitution
Action to set the text substitution of this node.
-
showTextSubstitution
Action to show or hide the text substitution of this node.
-
SubcomposeSlotReusePolicy
Creates SubcomposeSlotReusePolicy which retains the fixed amount of slots.
-
SuspendingPointerInputModifierNode
Deprecated, use SuspendingPointerInputModifierNode instead.
-
takeOrElse
If this ScaleFactor isSpecified then this is returned, otherwise block is executed and its result is returned.
-
textEntryKey
The node is marked as a text entry key for accessibility.
-
times
Multiplication operator with Size.
-
toAndroidDragEvent
Returns the backing DragEvent to read platform specific data
-
toAutofillValue
Retrieves the underlying platform AutofillValue from the FillableData.
- toClipEntry
- toClipMetadata
-
ToggleableState
Return corresponding ToggleableState based on a Boolean representation
-
TouchBoundsExpansion
Creates a TouchBoundsExpansion that's aware of LayoutDirection.
-
TransformOrigin
Constructs a TransformOrigin from the given fractional values from the Layer's width and height
-
traverseAncestors
Executes block for all ancestors with a matching key.
-
traverseChildren
Executes block for all direct children of the node with a matching key.
-
traverseDescendants
Conditionally executes block for each descendant with a matching key.
-
updateLayerBlock
Updates the layer block of the LayoutModifierNode.
- vectorResource
Compose UI
Jetpack Compose API reference for ui.