{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

Class Index

These are all the API classes. See all API packages.

A  B  C  D  E  F  G  H  I  K  L  M  N  O  P  R  S  T  U  V  W  

A

AbsoluteAlignment

A collection of common Alignments unaware of the layout direction.

AbsoluteCutCornerShape

A shape describing the rectangle with cut corners.

AbsoluteRoundedCornerShape

A shape describing the rectangle with rounded corners.

AbstractApplier

An abstract Applier implementation.

AbstractComposeView

Base class for custom android.view.Views implemented using Jetpack Compose UI.

AccessibilityAction

Standard accessibility action.

AccessibilityManager

Interface for managing accessibility.

Adaptation

List of adaptation matrices that can be used for chromatic adaptation using the von Kries transform.

AlertDialogDefaults

Contains default values used for AlertDialog and BasicAlertDialog.

Alignment

An interface to calculate the position of a sized box inside an available space.

Alignment.Horizontal

An interface to calculate the position of box of a certain width inside an available width.

Alignment.Vertical

An interface to calculate the position of a box of a certain height inside an available height.

AlignmentLine

Defines an offset line that can be used by parent layouts to align and position their children.

AndroidComposeTestRule
AndroidComposeTestRule.AndroidComposeStatement

This class is deprecated. Do not instantiate this Statement, use AndroidComposeTestRule instead

AndroidComposeUiTest

Variant of ComposeUiTest for when you want to have access to the current activity of type A.

AndroidComposeUiTestEnvironment

A test environment that can run tests using the test receiver scope.

AndroidFont

Font for use on Android.

AndroidFont.TypefaceLoader

Loader for loading an AndroidFont and producing an android.graphics.Typeface.

AndroidPaint

Create a Compose Paint instance backed by an android.graphics.Paint object to be consumed by Compose applications running on the Android platform

AndroidPath
AndroidPathMeasure
AndroidUiDispatcher

A CoroutineDispatcher that will perform dispatch during a handler callback or choreographer's animation frame stage, whichever comes first.

AndroidUiFrameClock
AndroidUriHandler
AndroidViewConfiguration
Animatable

Animatable is a value holder that automatically animates its value when the value is changed via animateTo.

AnimatedContentScope

Receiver scope for content lambda for AnimatedContent.

AnimatedContentTransitionScope

AnimatedContentTransitionScope provides functions that are convenient and only applicable in the context of AnimatedContent, such as slideIntoContainer and slideOutOfContainer.

AnimatedContentTransitionScope.SlideDirection

SlideDirection defines the direction of the slide in/out for slideIntoContainer and slideOutOfContainer.

AnimatedImageVector

Animated vector graphics object that is generated as a result of androidx.compose.animation.graphics.res.loadAnimatedVectorResource.

AnimatedImageVector.Companion

Provide an empty companion object to hang platform-specific companion extensions onto.

AnimatedVisibilityScope

This is the scope for the content of AnimatedVisibility.

Animation

This interface provides a convenient way to query from an VectorizedAnimationSpec or FloatDecayAnimationSpec: It spares the need to pass the starting conditions and in some cases ending condition for each value or velocity query, and instead only requires the play time to be passed for such queries.

AnimationConstants
AnimationEndReason

Possible reasons for Animatables to end.

AnimationResult

AnimationResult contains information about an animation at the end of the animation.

AnimationScope

AnimationScope provides all the animation related info specific to an animation run.

AnimationSpec

AnimationSpec stores the specification of an animation, including 1) the data type to be animated, and 2) the animation configuration (i.e. VectorizedAnimationSpec) that will be used once the data (of type T) has been converted to AnimationVector.

AnimationState

AnimationState contains the necessary information to indicate the state of an animation.

AnimationVector

AnimationVector class that is the base class of AnimationVector1D, AnimationVector2D, AnimationVector3D and AnimationVector4D.

AnimationVector1D

This class defines a 1D vector.

AnimationVector2D

This class defines a 2D vector that contains two Float values for the two dimensions.

AnimationVector3D

This class defines a 3D vector that contains three Float value fields for the three dimensions.

AnimationVector4D

This class defines a 4D vector that contains four Float fields for its four dimensions.

AnnotatedString

The basic data structure of text with multiple styles.

AnnotatedString.Builder

Builder class for AnnotatedString.

AnnotatedString.Range

The information attached on the text such as a SpanStyle.

Applier

An Applier is responsible for applying the tree-based operations that get emitted during a composition.

Arrangement

Used to specify the arrangement of the layout's children in layouts like Row or Column in the main axis direction (horizontal and vertical, respectively).

Arrangement.Absolute
Arrangement.Horizontal

Used to specify the horizontal arrangement of the layout's children in layouts like Row.

Arrangement.HorizontalOrVertical

Used to specify the horizontal arrangement of the layout's children in horizontal layouts like Row, or the vertical arrangement of the layout's children in vertical layouts like Column.

Arrangement.Vertical

Used to specify the vertical arrangement of the layout's children in layouts like Column.

AssistChipDefaults

Contains the baseline values used by AssistChip.

AtomicInt
AtomicLong
AtomicReference
AtomicReference
AtomicReference
AtomicReference
AutoboxingStateValueProperty

This annotation designates that a property on a State class will autobox when it is read from or assigned to.

Autofill

Autofill API.

AutofillNode

Every autofillable composable will have an AutofillNode.

AutofillTree

The autofill tree is a temporary data structure that is used before the Semantics Tree is implemented.

AutofillType

Autofill type information.

AwaitPointerEventScope

Receiver scope for awaiting pointer events in a call to PointerInputScope.awaitPointerEventScope.

B

BackspaceCommand

Represents a backspace operation at the cursor position.

BadgeDefaults

Default values used for Badge implementations.

BaselineShift

The amount by which the text is shifted up or down from current the baseline.

BasicTooltipState

The state that is associated with an instance of a tooltip.

BeyondBoundsLayout

Layout extra items in the specified direction.

BeyondBoundsLayout.BeyondBoundsScope

The scope used in BeyondBoundsLayout.layout.

BeyondBoundsLayout.LayoutDirection

The direction (from the visible bounds) that a BeyondBoundsLayout is requesting more items to be laid.

BiasAbsoluteAlignment

An Alignment specified by bias: for example, a bias of -1 represents alignment to the left/top, a bias of 0 will represent centering, and a bias of 1 will represent right/bottom.

BiasAbsoluteAlignment.Horizontal

An Alignment.Horizontal specified by bias: for example, a bias of -1 represents alignment to the left, a bias of 0 will represent centering, and a bias of 1 will represent right.

BiasAlignment

An Alignment specified by bias: for example, a bias of -1 represents alignment to the start/top, a bias of 0 will represent centering, and a bias of 1 will represent end/bottom.

BiasAlignment.Horizontal

An Alignment.Horizontal specified by bias: for example, a bias of -1 represents alignment to the start, a bias of 0 will represent centering, and a bias of 1 will represent end.

BiasAlignment.Vertical

An Alignment.Vertical specified by bias: for example, a bias of -1 represents alignment to the top, a bias of 0 will represent centering, and a bias of 1 will represent bottom.

BitmapPainter

Painter implementation used to draw an ImageBitmap into the provided canvas This implementation can handle applying alpha and ColorFilter to it's drawn result

BlendMode

Algorithms to use when painting on the canvas.

BlurEffect

RenderEffect that will blur the contents of an optional input RenderEffect.

BlurredEdgeTreatment

Determines the strategy used to render pixels in the blurred result that may extend beyond the bounds of the original input.

BorderStroke

Class to specify the stroke to draw border with.

BottomAppBarDefaults

Contains default values used for the bottom app bar implementations.

BottomAppBarScrollBehavior

A BottomAppBarScrollBehavior defines how a bottom app bar should behave when the content under it is scrolled.

BottomAppBarState

A state object that can be hoisted to control and observe the bottom app bar state.

BottomSheetDefaults

Contains the default values used by ModalBottomSheet and BottomSheetScaffold.

BottomSheetScaffoldState

State of the BottomSheetScaffold composable.

BoxScope

A BoxScope provides a scope for the children of Box and BoxWithConstraints.

BoxWithConstraintsScope

Receiver scope being used by the children parameter of BoxWithConstraints

BringIntoViewRequester

Can be used to send bringIntoView requests.

BringIntoViewResponder

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

BroadcastFrameClock

A simple frame clock.

Brush
BrushPainter

Painter implementation used to fill the provided bounds with the specified Brush.

BuildDrawCacheParams

The set of parameters which could be used to build the drawing cache.

ButtonColors

Represents the container and content colors used in a button in different states.

ButtonDefaults

Contains the default values used by all 5 button types.

ButtonElevation

Represents the elevation for a button in different states.

C

CacheDrawModifierNode

Expands on the androidx.compose.ui.node.DrawModifierNode by adding the ability to invalidate the draw cache for changes in things like shapes and bitmaps (see Modifier.border for a usage examples).

CacheDrawScope

Handle to a drawing environment that enables caching of content based on the resolved size.

CalendarLocale

Represents a Locale for the calendar.

Canvas
CanvasDrawScope

Implementation of DrawScope that issues drawing commands into the specified canvas and bounds via CanvasDrawScope.draw

CanvasHolder

Holder class that is used to issue scoped calls to a Canvas from the framework equivalent canvas without having to allocate an object on each draw call

CardColors

Represents the container and content colors used in a card in different states.

CardDefaults

Contains the default values used by all card types.

CardElevation

Represents the elevation for a card in different states.

CaretProperties

Properties for the caret of the tooltip if enabled.

CaretScope

Caret scope for TooltipBox to be used to obtain the LayoutCoordinates of the anchor content, and to draw a caret for the tooltip.

CheckResult
CheckboxColors

Represents the colors used by the three different sections (checkmark, box, and border) of a Checkbox or TriStateCheckbox in different states.

CheckboxDefaults

Defaults used in Checkbox and TriStateCheckbox.

ChipBorder

This class is deprecated. Maintained for binary compatibility.

ChipColors

Represents the container and content colors used in a clickable chip in different states.

ChipElevation

Represents the elevation used in a selectable chip in different states.

ClipOp

Defines how a new clip region should be merged with the existing clip region.

ClipboardManager

Interface for managing the Clipboard.

CollectionInfo

Information about the collection.

CollectionItemInfo

Information about the item of a collection.

CollectionPreviewParameterProvider
Color

The Color class contains color information to be used while painting in Canvas.

Color.Companion
ColorFilter

Effect used to modify the color of each pixel drawn on a Paint that it is installed on

ColorMatrix

4x5 matrix for transforming the color and alpha components of a source.

ColorModel

A color model is required by a ColorSpace to describe the way colors can be represented as tuples of numbers.

ColorPainter

Painter implementation used to fill the provided bounds with the specified color

ColorProducer

Alternative to () -> Color that's useful for avoiding boxing.

ColorScheme

A color scheme holds all the named color parameters for a MaterialTheme.

ColorSpace

A ColorSpace is used to identify a specific organization of colors.

ColorSpaces
ColumnScope

Scope for the children of Column.

CombinedModifier

A node in a Modifier chain.

CommitTextCommand

Commit final text to the text box and set the new cursor position.

Composable

Composable functions are the fundamental building blocks of an application built with Compose.

ComposableInferredTarget

An annotation generated by the compose compiler plugin.

ComposableInvoker

This object is deprecated. Use androidx.compose.runtime.reflect.ComposableMethodInvoker instead

ComposableLambda
ComposableLambdaN
ComposableMethod

Represents the @Composable method.

ComposableOpenTarget

The Composable declares that it doesn't expect a particular applier.

ComposableTarget

The Composable function is declared to expect an applier with the name applier.

ComposableTargetMarker

This annotation is used to mark an annotation as being equivalent using ComposableTarget with the fully qualified name of the marked annotation as the applier value.

ComposeCompilerApi
ComposeContentTestRule

A ComposeTestRule that allows you to set content without the necessity to provide a host for the content.

ComposeNodeLifecycleCallback

Observes lifecycle of the node emitted with ReusableComposeNode or ComposeNode inside ReusableContentHost and ReusableContent.

ComposeNotIdleException

Thrown in cases where Compose can't get idle in Espresso's defined time limit.

ComposeTestRule

A TestRule that allows you to test and control composables and applications using Compose.

ComposeTimeoutException

Thrown in cases where Compose test can't satisfy a condition in a defined time limit.

ComposeUiTest

A test environment that allows you to test and control composables, either in isolation or in applications.

ComposeView

A android.view.View that can host Jetpack Compose UI content.

Composer

Composer is the interface that is targeted by the Compose Kotlin compiler plugin and used by code generation helpers.

CompositingStrategy

Determines when to render the contents of a layer into an offscreen buffer before being drawn to the destination.

Composition

A composition object is usually constructed for you, and returned from an API that is used to initially compose a UI.

CompositionContext

A CompositionContext is an opaque type that is used to logically "link" two compositions together.

CompositionData

A CompositionData is the data tracked by the composer during composition.

CompositionGroup

CompositionGroup is a group of data slots tracked independently by composition.

CompositionLocal

Compose passes data through the composition tree explicitly through means of parameters to composable functions.

CompositionLocalConsumerModifierNode

Implementing this interface allows your Modifier.Node subclass to read CompositionLocals via the currentValueOf function.

CompositionLocalContext

Stores CompositionLocal's and their values.

CompositionLocalMap

A read-only, immutable snapshot of the CompositionLocals that are set at a specific position in the composition hierarchy.

CompositionTracer

Internal tracing API.

Connector

A connector transforms colors from a source color space to a destination color space.

Constraints

Immutable constraints for measuring layouts, used by layouts or layout modifiers to measure their layout children.

ConsumedData

This class is deprecated. Use PointerInputChange.isConsumed and PointerInputChange.consume() instead

ContentDrawScope

Receiver scope for drawing content into a layout, where the content can be drawn between other canvas operations.

ContentScale

Represents a rule to apply to scale a source rectangle to be inscribed into a destination

ContentTransform

ContentTransform defines how the target content (i.e. content associated with target state) enters AnimatedContent and how the initial content disappears.

ControlledComposition

A controlled composition is a Composition that can be directly controlled by the caller.

CornerBasedShape

Base class for Shapes defined by four CornerSizes.

CornerRadius

A radius for either circular or elliptical (oval) shapes.

CornerSize

Defines size of a corner in pixels.

CubicBezierEasing

A cubic polynomial easing.

CustomAccessibilityAction

Custom accessibility action.

CutCornerShape

A shape describing the rectangle with cut corners.

D

DatePickerColors

Represents the colors used by the date picker.

DatePickerDefaults

Contains default values used by the DatePicker.

DatePickerFormatter

A date formatter interface used by DatePicker.

DatePickerState

A state object that can be hoisted to observe the date picker state.

DateRangePickerDefaults

Contains default values used by the DateRangePicker.

DateRangePickerState

A state object that can be hoisted to observe the date range picker state.

DecayAnimation

DecayAnimation is an animation that slows down from initialVelocityVector as time goes on.

DecayAnimationSpec

DecayAnimationSpec stores the specification of an animation, including 1) the data type to be animated, and 2) the animation configuration (i.e. VectorizedDecayAnimationSpec) that will be used once the data (of type T) has been converted to AnimationVector.

Decoy

With decoys enabled, indicates original composable function that was stubbed by compiler plugin.

DecoyImplementation

With decoys enabled, indicates composable implementation function created by compiler plugin.

DelayPropagatingContinuationInterceptorWrapper

A ContinuationInterceptor that wraps another interceptor and implements Delay.

DelegatableNode

Represents a Modifier.Node which can be a delegate of another Modifier.Node.

DelegatingNode

A Modifier.Node which is able to delegate work to other Modifier.Node instances.

DeleteAllCommand

Deletes all the text in the buffer.

DeleteSurroundingTextCommand

Delete lengthBeforeCursor characters of text before the current cursor position, and delete lengthAfterCursor characters of text after the current cursor position, excluding the selection.

DeleteSurroundingTextInCodePointsCommand

A variant of DeleteSurroundingTextCommand.

Density

A density of the screen.

DeviceFontFamilyName

An Android system installed font family name as used by Typeface.create.

Devices

List with the pre-defined devices available to be used in the preview.

DialogProperties

Properties used to customize the behavior of a Dialog.

DialogWindowProvider

Provides the underlying window of a dialog.

DisallowComposableCalls

This will prevent composable calls from happening inside of the function that it applies to.

DismissDirection

This enum is deprecated. Dismiss direction is no longer used by SwipeToDismissBoxState.

DismissValue

This enum is deprecated. DismissValue is no longer used by SwipeToDismissBoxState.

DisplayMode

Represents the different modes that a date picker can be at.

DisposableEffectResult
DisposableEffectScope

Receiver scope for DisposableEffect that offers the onDispose clause that should be the last statement in any call to DisposableEffect.

DividerDefaults

Default values for Divider

DoubleState

A value holder where reads to the doubleValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

Dp

Dimension value representing device-independent pixels (dp).

Dp.Companion
DpOffset

A two-dimensional offset using Dp for units

DpOffset.Companion
DpRect

A four dimensional bounds using Dp for units

DpSize

A two-dimensional Size using Dp for units

DragInteraction

An interaction related to drag events.

DragInteraction.Cancel

An interaction representing the cancellation of a Start event on a component.

DragInteraction.Start

An interaction representing a drag event on a component.

DragInteraction.Stop

An interaction representing the stopping of a Start event on a component.

DragScope

Scope used for suspending drag blocks

DraggableState

State of draggable.

DrawCacheModifier

DrawModifier implementation that supports building a cache of objects to be referenced across draw calls

DrawContext

Object that provides the dependencies to support a DrawScope drawing environment.

DrawModifier

A Modifier.Element that draws into the space of the layout.

DrawModifierNode

A Modifier.Node that draws into the space of the layout.

DrawResult

Holder to a callback to be invoked during draw operations.

DrawScope

Creates a scoped drawing environment with the provided Canvas.

DrawScopeMarker

DSL marker used to distinguish between drawing operations and canvas transform operations

DrawStyle

Represents how the shapes should be drawn within a DrawScope

DrawTransform

Defines transformations that can be applied to a drawing environment

DrawerDefaults

Object to hold default values for ModalNavigationDrawer

DrawerState

State of the ModalNavigationDrawer and DismissibleNavigationDrawer composable.

DrawerValue

Possible values of DrawerState.

DurationBasedAnimationSpec

This describes AnimationSpecs that are based on a fixed duration, such as KeyframesSpec, TweenSpec, and SnapSpec.

E

Easing

Easing is a way to adjust an animation’s fraction.

EditCommand

EditCommand is a command representation for the platform IME API function calls.

EditProcessor

Helper class to apply EditCommands on an internal buffer.

EditingBuffer

The editing buffer

EmojiSupportMatch

When to replace emoji with support emoji using androidx.emoji2.

EnterExitState

EnterExitState contains the three states that are involved in the enter and exit transition of AnimatedVisibility.

EnterTransition

EnterTransition defines how an AnimatedVisibility Composable appears on screen as it becomes visible.

ExitTransition

ExitTransition defines how an AnimatedVisibility Composable disappears on screen as it becomes not visible.

ExperimentalAnimationApi
ExperimentalAnimationGraphicsApi
ExperimentalComposeApi
ExperimentalComposeUiApi
ExperimentalFoundationApi
ExperimentalGraphicsApi
ExperimentalLayoutApi
ExperimentalMaterial3Api
ExperimentalMaterial3WindowSizeClassApi
ExperimentalTestApi
ExperimentalTextApi
ExperimentalTransitionApi
ExperimentalUnitApi
ExplicitGroupsComposable

This annotation can be applied to Composable functions so that no groups will be generated in the body of the function it annotates.

ExposedDropdownMenuBoxScope

Scope for ExposedDropdownMenuBox.

ExposedDropdownMenuDefaults

Contains default values used by Exposed Dropdown Menu.

F

FabPosition

The possible positions for a FloatingActionButton attached to a Scaffold.

FileBasedFontFamily

A base class of FontFamilys that is created from file sources.

Fill

Default DrawStyle indicating shapes should be drawn completely filled in with the provided color or pattern

FilterChipDefaults

Contains the baseline values used by FilterChip.

FilterQuality

Quality levels for image filters.

FinishComposingTextCommand

Finishes the composing text that is currently active.

FiniteAnimationSpec

FiniteAnimationSpec is the interface that all non-infinite AnimationSpecs implement, including: TweenSpec, SpringSpec, KeyframesSpec, RepeatableSpec, SnapSpec, etc.

FixedScale

ContentScale implementation that always scales the dimension by the provided fixed floating point value

FlingBehavior

Interface to specify fling behavior.

FloatAnimationSpec

FloatAnimationSpec interface is similar to VectorizedAnimationSpec, except it deals exclusively with floats.

FloatDecayAnimationSpec

This animation interface is intended to be stateless, just like Animation.

FloatExponentialDecaySpec

This is a decay animation where the friction/deceleration is always proportional to the velocity.

FloatSpringSpec

FloatSpringSpec animation uses a spring animation to animate a Float value.

FloatState

A value holder where reads to the floatValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

FloatTweenSpec

FloatTweenSpec animates a Float value from any start value to any end value using a provided easing function.

FloatingActionButtonDefaults

Contains the default values used by FloatingActionButton

FloatingActionButtonElevation

Represents the tonal and shadow elevation for a floating action button in different states.

FlowColumnScope

Scope for the children of FlowColumn.

FlowRowScope

Scope for the children of FlowRow.

FocusDirection

The FocusDirection is used to specify the direction for a FocusManager.moveFocus request.

FocusEventModifier

This interface is deprecated. Use FocusEventModifierNode instead

FocusEventModifierNode

Implement this interface create a modifier node that can be used to observe focus state changes to a FocusTargetNode down the hierarchy.

FocusInteraction

An interaction related to focus events.

FocusInteraction.Focus

An interaction representing a focus event on a component.

FocusInteraction.Unfocus

An interaction representing a Focus event being released on a component.

FocusManager
FocusOrder

This class is deprecated. Use FocusProperties instead

FocusOrderModifier

This interface is deprecated. Use Modifier.focusProperties() instead

FocusProperties

Properties that are applied to focusTarget that is the first child of the FocusPropertiesModifierNode that sets these properties.

FocusPropertiesModifierNode

Implement this interface create a modifier node that can be used to modify the focus properties of the associated FocusTargetNode.

FocusRequester

The FocusRequester is used in conjunction with Modifier.focusRequester to send requests to change focus.

FocusRequester.Companion
FocusRequester.Companion.FocusRequesterFactory

Convenient way to create multiple FocusRequester instances.

FocusRequesterModifier

This interface is deprecated. Use FocusRequesterModifierNode instead

FocusRequesterModifierNode

Implement this interface to create a modifier node that can be used to request changes in the focus state of a FocusTargetNode down the hierarchy.

FocusState

The focus state of a FocusTargetNode.

FocusTargetModifierNode

This modifier node can be used to create a modifier that makes a component focusable.

Font

The interface of the font resource.

Font.ResourceLoader

This interface is deprecated. Replaced with FontFamily.Resolver during the introduction of async fonts, all usages should be replaced.

FontFamily

The primary typography interface for Compose applications.

FontFamily.Resolver

Main interface for resolving FontFamily into a platform-specific typeface for use in Compose-based applications.

FontListFontFamily

Defines a font family with list of Font.

FontLoadingStrategy

Font loading strategy for a Font in a FontListFontFamily.

FontStyle

Defines whether the font is Italic or Normal.

FontSynthesis

Possible options for font synthesis.

FontVariation

Set font variation settings.

FontVariation.Setting

Represents a single point in a variation, such as 0.7 or 100

FontVariation.Settings

A collection of settings to apply to a single font.

FontWeight

The thickness of the glyphs, in a range of 1, 1000.

FunctionKeyMeta

This annotation is applied to the FunctionKeyMeta classes created by the Compose Compiler.

FunctionKeyMetaClass

This annotation is applied to the FunctionKeyMeta classes created by the Compose Compiler.

G

GenericFontFamily

Defines a font family with a generic font family name.

GenericShape

Creates Shape defined by applying the provided builder on a Path.

GestureCancellationException

A gesture was canceled and cannot continue, likely because another gesture has taken over the pointer input stream.

GestureScope

This class is deprecated. Replaced by TouchInjectionScope

GlobalPositionAwareModifierNode

A androidx.compose.ui.Modifier.Node whose onGloballyPositioned is called with the final LayoutCoordinates of the Layout when the global position of the content may have changed.

GraphicLayerInfo

The info about the graphics layers used by tooling.

GraphicsLayerScope

A scope which can be used to define the effects to apply for the content, such as scaling (scaleX, scaleY), rotation (rotationX, rotationY, rotationZ), opacity (alpha), shadow (shadowElevation, shape), and clipping (clip, shape).

GridCells

This class describes the count and the sizes of columns in vertical grids, or rows in horizontal grids.

GridCells.Adaptive

Defines a grid with as many rows or columns as possible on the condition that every cell has at least minSize space and all extra space distributed evenly.

GridCells.Fixed

Defines a grid with fixed number of rows or columns.

GridCells.FixedSize

Defines a grid with as many rows or columns as possible on the condition that every cell takes exactly size space.

GridItemSpan

Represents the span of an item in a LazyVerticalGrid.

H

HapticFeedback

Interface for haptic feedback.

HapticFeedbackType

Constants to be used to perform haptic feedback effects via HapticFeedback.performHapticFeedback.

HistoricalChange

Data structure for "historical" pointer moves.

HorizontalAlignmentLine

A horizontal AlignmentLine.

HoverInteraction

An interaction related to hover events.

HoverInteraction.Enter

An interaction representing a hover event on a component.

HoverInteraction.Exit

An interaction representing a Enter event being released on a component.

Hyphens

Automatic hyphenation configuration.

I

IconButtonColors

Represents the container and content colors used in an icon button in different states.

IconButtonDefaults

Contains the default values used by all icon button types.

IconToggleButtonColors

Represents the container and content colors used in a toggleable icon button in different states.

IdlingResource

Represents a resource of an application under test which can cause asynchronous background work to happen during test execution (e.g. an http request in response to a button click).

Illuminant

Illuminant contains standard CIE white points.

ImageBitmap

Graphics object that represents a 2 dimensional array of pixel information represented as ARGB values

ImageBitmap.Companion

Provide an empty companion object to hang platform-specific companion extensions onto.

ImageBitmapConfig

Possible ImageBitmap configurations.

ImageVector

Vector graphics object that is generated as a result of ImageVector.Builder It can be composed and rendered by passing it as an argument to rememberVectorPainter

ImageVector.Builder

Builder used to construct a Vector graphic tree.

ImageVector.Companion

Provide an empty companion object to hang platform-specific companion extensions onto.

ImeAction

Signals the keyboard what type of action should be displayed.

ImeOptions

The IME configuration options for TextInputService.

Immutable

Immutable can be used to mark class as producing immutable instances.

Indication

Indication represents visual effects that occur when certain interactions happens.

IndicationInstance

IndicationInstance is a specific instance of an Indication that draws visual effects on certain interactions, such as press or focus.

InfiniteAnimationPolicy

Provides a policy that will be applied to animations that get their frame time from withInfiniteAnimationFrameNanos or withInfiniteAnimationFrameMillis This can be used to intervene in infinite animations to make them finite, for example by cancelling such coroutines.

InfiniteAnimationPolicy.Key
InfiniteRepeatableSpec

InfiniteRepeatableSpec repeats the provided animation infinite amount of times.

InfiniteTransition

InfiniteTransition is responsible for running child animations.

InfiniteTransition.TransitionAnimationState

Each animation created using InfiniteTransition.animateColor, InfiniteTransition.animateFloat, or InfiniteTransition.animateValue is represented as a TransitionAnimationState in InfiniteTransition.

InjectionScope

The receiver scope of all input injection lambdas offered in ui-test, such as performTouchInput and performMouseInput.

InlineTextContent

A data class that stores a composable to be inserted into the text layout.

InputChipDefaults

Contains the baseline values used by an InputChip.

InputEventCallback

This interface is deprecated. This function is not being used by any APIs.

InputMode

This value is used to represent the InputMode that the system is currently in.

InputModeManager

The InputModeManager is accessible as a CompositionLocal, that provides the current InputMode.

InspectableModifier

Annotates a range of modifiers in a chain with inspector metadata.

InspectableModifier.End
InspectableValue

A compose value that is inspectable by tools.

InspectorInfo

A builder for an InspectableValue.

InspectorValueInfo

Implementation of InspectableValue based on a builder InspectorInfo DSL.

IntOffset

A two-dimensional position using Int pixels for units

IntOffset.Companion
IntRect

An immutable, 2D, axis-aligned, integer bounds rectangle whose coordinates are relative to a given origin.

IntSize

A two-dimensional size class used for measuring in Int pixels.

IntSize.Companion
IntState

A value holder where reads to the intValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

Interaction

An Interaction represents transient UI state for a component, typically separate from the actual 'business' state that a component may control.

InteractionSource

InteractionSource represents a stream of Interactions corresponding to events emitted by a component.

IntermediateMeasureScope

IntermediateMeasureScope provides access to lookahead results to allow intermediateLayout to leverage lookahead results to define intermediate measurements and placements to gradually converge with lookahead.

InternalAnimationApi
InternalComposeApi
InternalComposeTracingApi
InternalComposeUiApi

Unstable API for use only between compose-ui modules sharing the same exact version, subject to change without notice in major, minor, or patch releases.

InternalCoreApi
InternalFoundationApi
InternalFoundationTextApi
InternalPlatformTextApi
InternalTestApi
InternalTextApi
InteropView

A typealias for the platform's built-in View type, which may be hosted inside of a Compose UI hierarchy to allow for interoperability.

InteroperableComposeUiNode

This interface allows the layout inspector to access inspect instances of Views that are associated with a Compose UI node.

IntervalList

The list consisting of multiple intervals.

IntervalList.Interval

The interval holder.

IntrinsicMeasurable

A part of the composition that can be measured.

IntrinsicMeasureScope

The receiver scope of a layout's intrinsic measurements lambdas.

IntrinsicSize

Intrinsic size used in width or height which can refer to width or height.

K

Key

Represents keys on a keyboard.

KeyEvent

When a user presses a key on a hardware keyboard, a KeyEvent is sent to the item that is currently focused.

KeyEventType

The type of Key Event.

KeyInjectionScope

The receiver scope of the key input injection lambda from performKeyInput.

KeyInputModifierNode

Implement this interface to create a Modifier.Node that can intercept hardware Key events.

KeyboardActionScope

This scope can be used to execute the default action implementation.

KeyboardActions

The KeyboardActions class allows developers to specify actions that will be triggered in response to users triggering IME action on the software keyboard.

KeyboardCapitalization

Options to request software keyboard to capitalize the text.

KeyboardOptions

The keyboard configuration options for TextFields.

KeyboardType

Values representing the different available Keyboard Types.

KeyframesSpec

KeyframesSpec creates a VectorizedKeyframesSpec animation.

KeyframesSpec.KeyframeEntity

Holder class for building a keyframes animation.

KeyframesSpec.KeyframesSpecConfig

KeyframesSpecConfig stores a mutable configuration of the key frames, including durationMillis, delayMillis, and all the key frames.

L

LayoutAwareModifierNode

A androidx.compose.ui.Modifier.Node which receives various callbacks in response to local changes in layout.

LayoutCoordinates

A holder of the measured bounds for the Layout.

LayoutDirection

A class for defining layout directions.

LayoutIdParentData

Can be implemented by values used as parent data to make them usable as tags.

LayoutInfo

The public information about the layouts used internally as nodes in the Compose UI hierarchy.

LayoutModifier

A Modifier.Element that changes how its wrapped content is measured and laid out.

LayoutModifierNode

A Modifier.Node that changes how its wrapped content is measured and laid out.

LayoutScopeMarker
LazyGridItemInfo

Contains useful information about an individual item in lazy grids like LazyVerticalGrid.

LazyGridItemScope

Receiver scope being used by the item content parameter of LazyVerticalGrid.

LazyGridItemSpanScope

Scope of lambdas used to calculate the spans of items in lazy grids.

LazyGridLayoutInfo

Contains useful information about the currently displayed layout state of lazy grids like LazyVerticalGrid.

LazyGridScope

Receiver scope which is used by LazyVerticalGrid.

LazyGridScopeMarker

DSL marker used to distinguish between lazy grid dsl scope and the item content scope.

LazyGridState

A state object that can be hoisted to control and observe scrolling.

LazyItemScope

Receiver scope being used by the item content parameter of LazyColumn/Row.

LazyLayoutIntervalContent

Common parts backing the interval-based content of lazy layout defined through item DSL.

LazyLayoutIntervalContent.Interval

Common content of individual intervals in item DSL of lazy layouts.

LazyLayoutItemProvider

Provides all the needed info about the items which could be later composed and displayed as children or LazyLayout.

LazyLayoutMeasureScope

The receiver scope of a LazyLayout's measure lambda.

LazyLayoutPinnedItemList

Read-only list of pinned items in a lazy layout.

LazyLayoutPinnedItemList.PinnedItem

Item pinned in a lazy layout.

LazyLayoutPrefetchState

State for lazy items prefetching, used by lazy layouts to instruct the prefetcher.

LazyLayoutPrefetchState.PrefetchHandle
LazyListItemInfo

Contains useful information about an individual item in lazy lists like LazyColumn or LazyRow.

LazyListLayoutInfo

Contains useful information about the currently displayed layout state of lazy lists like LazyColumn or LazyRow.

LazyListScope

Receiver scope which is used by LazyColumn and LazyRow.

LazyListState

A state object that can be hoisted to control and observe scrolling.

LazyScopeMarker

DSL marker used to distinguish between lazy layout scope and the item scope.

LazyStaggeredGridItemInfo

Information about layout state of individual item in lazy staggered grid.

LazyStaggeredGridItemScope

Receiver scope for itemContent in LazyStaggeredGridScope.item

LazyStaggeredGridLayoutInfo

Information about layout state of lazy staggered grids.

LazyStaggeredGridScope

Receiver scope for LazyVerticalStaggeredGrid and LazyHorizontalStaggeredGrid

LazyStaggeredGridState

Hoisted state object controlling LazyVerticalStaggeredGrid or LazyHorizontalStaggeredGrid.

LineBreak

When soft wrap is enabled and the width of the text exceeds the width of its container, line breaks are inserted in the text to split it over multiple lines.

LineBreak.Strategy

The strategy used for line breaking.

LineBreak.Strictness

Describes the strictness of line breaking, determining before which characters line breaks can be inserted.

LineBreak.WordBreak

Describes how line breaks should be inserted within words.

LineHeightStyle

The configuration for line height such as alignment of the line in the provided line height, whether to apply additional space as a result of line height to top of first line top and bottom of last line.

LineHeightStyle.Alignment

Defines how to align the line in the space provided by the line height.

LineHeightStyle.Trim

Defines whether the space that would be added to the top of first line, and bottom of the last line should be trimmed or not.

LinearGradient

Brush implementation used to apply a linear gradient on a given Paint

ListItemColors

Represents the container and content colors used in a list item in different states.

ListItemDefaults

Contains the default values used by list items.

LiveLiteralFileInfo

This annotation is applied to LiveLiteral classes by the Compose Compiler.

LiveLiteralInfo

This annotation is applied to functions on the LiveLiteral classes created by the Compose Compiler.

LiveRegionMode

The mode of live region.

LoadedFontFamily

Defines a font family that is already loaded Typeface.

LocalSoftwareKeyboardController
Locale

A Locale object represents a specific geographical, political, or cultural region.

LocaleList

Defines a list of Locale objects.

LongState

A value holder where reads to the longValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

LookaheadLayoutCoordinates

This interface is deprecated. LookaheadLayoutCoordinates class has been removed. localLookaheadPositionOfcan be achieved in LookaheadScope using LayoutCoordinates.localLookaheadPositionOf(LayoutCoordinates) function.

LookaheadLayoutScope

This interface is deprecated. LookaheadLayoutScope has been renamed to LookaheadScope

LookaheadScope

LookaheadScope provides a receiver scope for all (direct and indirect) child layouts in LookaheadScope.

LoremIpsum

PreviewParameterProvider with 1 value containing Lorem Ipsum.

M

MagnifierStyle

Specifies how a magnifier should create the underlying Magnifier widget.

MainTestClock

The clock that drives frames, recompositions and launched effects in compose tests.

MarqueeAnimationMode

Specifies when the basicMarquee animation runs.

MarqueeSpacing

Defines a calculateSpacing method that determines the space after the end of basicMarquee content before drawing the content again.

MaterialTheme

Contains functions to access the current theme values provided at the call site's position in the hierarchy.

Matrix
Measurable

A part of the composition that can be measured.

MeasurePolicy

Defines the measure and layout behavior of a Layout.

MeasureResult

Interface holding the size and alignment lines of the measured layout, as well as the children positioning logic.

MeasureScope

The receiver scope of a layout's measure lambda.

Measured

A Measured corresponds to a layout that has been measured by its parent layout.

MenuDefaults

Contains default values used for DropdownMenuItem.

MenuItemColors

Represents the text and icon colors used in a menu item at different states.

ModalBottomSheetDefaults

Default values for ModalBottomSheet

ModalBottomSheetProperties

Properties used to customize the behavior of a ModalBottomSheet.

Modifier

An ordered, immutable collection of modifier elements that decorate or add behavior to Compose UI elements.

Modifier.Companion

The companion object Modifier is the empty, default, or starter Modifier that contains no elements.

Modifier.Element

A single element contained within a Modifier chain.

Modifier.Node

The longer-lived object that is created for each Modifier.Element applied to a androidx.compose.ui.layout.Layout.

ModifierInfo

Used by tooling to examine the modifiers on a LayoutInfo.

ModifierLocal

ModifierLocals provide a means of inter-modifier communication.

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.

ModifierLocalMap

An opaque key-value holder of ModifierLocals to be used with ModifierLocalModifierNode.

ModifierLocalModifierNode

A androidx.compose.ui.Modifier.Node that is capable of consuming and providing ModifierLocal values.

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.

ModifierLocalReadScope

This scope gives us access to modifier locals that are provided by other modifiers to the left of this modifier, or above this modifier in the layout tree.

ModifierNodeElement

A Modifier.Element which manages an instance of a particular Modifier.Node implementation.

MonotonicFrameClock

Provides a time source for display frames and the ability to perform an action on the next frame.

MonotonicFrameClock.Key
MotionDurationScale

Provides a duration scale for motion such as animations.

MotionDurationScale.Key
MouseButton

Representation of a mouse button with its associated ID for the current platform.

MouseInjectionScope

The receiver scope of the mouse input injection lambda from performMouseInput.

MovableContent

A Compose compiler plugin API.

MovableContentState

A Compose compiler plugin API.

MovableContentStateReference

A Compose compiler plugin API.

MoveCursorCommand

Moves the cursor with amount characters.

MultiChoiceSegmentedButtonRowScope

Scope for the children of a MultiChoiceSegmentedButtonRow

MultiContentMeasurePolicy

Defines the measure and layout behavior of a Layout overload which accepts a list of multiple composable content lambdas.

MultiModalInjectionScope

The receiver scope of the multi-modal input injection lambda from performMultiModalInput.

MultiParagraph

Lays out and renders multiple paragraphs at once.

MultiParagraphIntrinsics

Calculates and provides the intrinsic width and height of text that contains ParagraphStyle.

MutableDoubleState

A value holder where reads to the doubleValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

MutableFloatState

A value holder where reads to the floatValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

MutableIntState

A value holder where reads to the intValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

MutableInteractionSource

MutableInteractionSource represents a stream of Interactions corresponding to events emitted by a component.

MutableIntervalList

Mutable version of IntervalList.

MutableLongState

A value holder where reads to the longValue property during the execution of a Composable function cause the current RecomposeScope to subscribe to changes of that value.

MutableRect

An mutable, 2D, axis-aligned, floating-point rectangle whose coordinates are relative to a given origin.

MutableSnapshot

A snapshot of the values return by mutable states and other state objects.

MutableState

A mutable value holder where reads to the value property during the execution of a Composable function, the current RecomposeScope will be subscribed to changes of that value.

MutableTransitionState

MutableTransitionState contains two fields: currentState and targetState.

MutableVector

A MutableList-like structure with a simplified interface that offers faster access than ArrayList.

MutableWindowInsets

A WindowInsets whose values can change without changing the instance.

MutatePriority

Priorities for performing mutation on state.

MutatorMutex

Mutual exclusion for UI state mutation over time.

N

NativeCanvas
NativeColorFilter
NativeKeyEvent

The native platform-specific keyboard key event.

NativePaint
NativePointerButtons
NativePointerKeyboardModifiers
NavigationBarDefaults

Defaults used in NavigationBar.

NavigationBarItemColors

Represents the colors of the various elements of a navigation item.

NavigationBarItemDefaults

Defaults used in NavigationBarItem.

NavigationDrawerItemColors

Represents the colors of the various elements of a drawer item.

NavigationDrawerItemDefaults

Defaults used in NavigationDrawerItem.

NavigationRailDefaults

Defaults used in NavigationRail

NavigationRailItemColors

Represents the colors of the various elements of a navigation item.

NavigationRailItemDefaults

Defaults used in NavigationRailItem.

NestedScrollConnection

Interface to connect to the nested scroll system.

NestedScrollDispatcher

Nested scroll events dispatcher to notify the nested scroll system about the scrolling events that are happening on the element.

NestedScrollSource

Possible sources of scroll events in the NestedScrollConnection

NoLiveLiterals

This annotation is used to indicate to the Compose Compiler to not attempt to generate live literals inside the scope of the declaration it is applied to, even when the live literals code generation is turned on.

NonRestartableComposable

This annotation can be applied to Composable functions in order to prevent code from being generated which allow this function's execution to be skipped or restarted.

O

ObserverHandle

The type returned by observer registration methods that unregisters the observer when it is disposed.

ObserverModifierNode

Modifier.Nodes that implement ObserverNode can provide their own implementation of onObservedReadsChanged that will be called whenever the value of read object has changed.

Offset

An immutable 2D floating-point offset.

Offset.Companion
OffsetEffect

RenderEffect used to translate either the given RenderEffect or the content of the GraphicsLayerScope it is configured on.

OffsetMapping

Provides bidirectional offset mapping between original and transformed text.

OnGloballyPositionedModifier

A modifier whose onGloballyPositioned is called with the final LayoutCoordinates of the Layout when the global position of the content may have changed.

OnPlacedModifier

A modifier whose onPlaced is called after the parent LayoutModifier and parent layout has been placed and before child LayoutModifier is placed.

OnRemeasuredModifier

A modifier whose onRemeasured is called when the layout content is remeasured.

Orientation

Class to define possible directions in which common gesture modifiers like draggable and scrollable can drag.

Outline

Defines a simple shape, used for bounding graphical regions.

Outline.Generic

An area defined as a path.

Outline.Rectangle

Rectangular area.

Outline.Rounded

Rectangular area with rounded corners.

OutlinedTextFieldDefaults

Contains the default values used by OutlinedTextField.

OverscrollConfiguration

Metadata for overscroll effects for android platform.

OverscrollEffect

An OverscrollEffect represents a visual effect that displays when the edges of a scrolling container have been reached with a scroll or fling.

P

PaddingValues

Describes a padding to be applied along the edges inside a box.

PaddingValues.Absolute

Describes an absolute (RTL unaware) padding to be applied along the edges inside a box.

PageSize

This is used to determine how Pages are laid out in Pager.

PageSize.Fill

Pages take up the whole Pager size.

PageSize.Fixed

Multiple pages in a viewport

PagerDefaults

Contains the default values used by Pager.

PagerScope

Receiver scope for Pager.

PagerSnapDistance

PagerSnapDistance defines the way the Pager will treat the distance between the current page and the page where it will settle.

PagerState

The state that can be used to control VerticalPager and HorizontalPager

Paint
Painter

Abstraction for something that can be drawn.

PaintingStyle

Strategies for painting shapes and paths on a canvas.

Paragraph

A paragraph of text that is laid out.

ParagraphIntrinsics

Calculates and presents the intrinsic width and height of text.

ParagraphStyle

Paragraph styling configuration for a paragraph.

ParentDataModifier

A Modifier that provides data to the parent Layout.

ParentDataModifierNode

A Modifier.Node that provides data to the parent Layout.

PasswordVisualTransformation

The Visual Filter can be used for password Input Field.

Path
PathBuilder
PathEffect

Effect applied to the geometry of a drawing primitive.

PathFillType

Determines the winding rule that decides how the interior of a Path is calculated.

PathMeasure
PathNode

Class representing a singular path command in a vector.

PathNode.ArcTo
PathNode.Close
PathNode.CurveTo
PathNode.HorizontalTo
PathNode.LineTo
PathNode.MoveTo
PathNode.QuadTo
PathNode.ReflectiveCurveTo
PathNode.ReflectiveQuadTo
PathNode.RelativeArcTo
PathNode.RelativeCurveTo
PathNode.RelativeHorizontalTo
PathNode.RelativeLineTo
PathNode.RelativeMoveTo
PathNode.RelativeQuadTo
PathNode.RelativeReflectiveCurveTo
PathNode.RelativeReflectiveQuadTo
PathNode.RelativeVerticalTo
PathNode.VerticalTo
PathOperation

Strategies for combining paths.

PathOperation.Companion
PathParser
PausableMonotonicFrameClock

A MonotonicFrameClock wrapper that can be paused and resumed.

PinnableContainer

Represents a container which can be pinned when the content of this container is important.

PinnableContainer.PinnedHandle

This is an object returned by pin which allows to release the pinning.

PixelMap

Result of a pixel read operation.

Placeable

A Placeable corresponds to a child layout that can be positioned by its parent layout.

Placeable.PlacementScope

Receiver scope that permits explicit placement of a Placeable.

Placeholder

A placeholder is a rectangle box inserted into text, which tells the text processor to leave an empty space.

PlaceholderVerticalAlign

The settings used to specify how a placeholder is vertically aligned within a text line.

PlatformParagraphStyle

Provides platform specific ParagraphStyle configuration options for styling and compatibility.

PlatformSpanStyle

Provides platform specific SpanStyle configuration options for styling and compatibility.

PlatformTextInput

Represents the text input plugin system to instances of PlatformTextInputAdapter, and provides methods that allow adapters to interact with it.

PlatformTextInputAdapter

See kdoc on actual interfaces.

PlatformTextInputPlugin

See kdoc on actual interfaces.

PlatformTextInputPluginRegistry

The entry point to the text input plugin API.

PlatformTextInputPluginRegistryImpl

Implementation of PlatformTextInputPluginRegistry that manages a map of adapters to cached services and allows retrieval of the first active one.

PlatformTextInputPluginRegistryImpl.AdapterHandle
PlatformTextInputService

Platform specific text input service.

PlatformTextStyle

Provides platform specific TextStyle configuration options for styling and compatibility.

PointMode

Used by Canvas.drawPoints.

PointerButtons

Contains the state of pointer buttons (e.g. mouse and stylus buttons).

PointerEvent

Describes a pointer input change event that has occurred at a particular point in time.

PointerEventPass

The enumeration of passes where PointerInputChange traverses up and down the UI tree.

PointerEventTimeoutCancellationException

An exception thrown from AwaitPointerEventScope.withTimeout when the execution time of the coroutine is too long.

PointerEventType

Indicates the primary reason that the PointerEvent was sent.

PointerIcon

Represents a pointer icon to use in Modifier.pointerHoverIcon

PointerId

An ID for a given pointer.

PointerInputChange

Describes a change that has occurred for a particular pointer, as well as how much of the change has been consumed (meaning, used by a node in the UI).

PointerInputFilter

A PointerInputFilter represents a single entity that receives PointerInputChanges), interprets them, and consumes the aspects of the changes that it is react to such that other PointerInputFilters don't also react to them.

PointerInputModifier

A Modifier.Element that can interact with pointer input.

PointerInputModifierNode

A androidx.compose.ui.Modifier.Node that receives PointerInputChanges, interprets them, and consumes the aspects of the changes that it is react to such that other PointerInputModifierNodes don't also react to them.

PointerInputScope

Receiver scope for Modifier.pointerInput that permits handling pointer input.

PointerKeyboardModifiers

Contains the state of modifier keys, such as Shift, Control, and Alt, as well as the state of the lock keys, such as Caps Lock and Num Lock.

PointerType

The device type that produces a PointerInputChange, such as a mouse or stylus.

PopupPositionProvider

Calculates the position of a Popup on screen.

PopupProperties

Properties used to customize the behavior of a Popup.

PressGestureScope

Receiver scope for detectTapGestures's onPress lambda.

PressInteraction

An interaction related to press events.

PressInteraction.Cancel

An interaction representing the cancellation of a Press event on a component.

PressInteraction.Press

An interaction representing a press event on a component.

PressInteraction.Release

An interaction representing the release of a Press event on a component.

Preview

Preview can be applied to either of the following:

PreviewParameter

PreviewParameter can be applied to any parameter of a @Preview.

PreviewParameterProvider

Interface to be implemented by any provider of values that you want to be injected as @Preview parameters.

ProduceStateScope

Receiver scope for use with produceState.

ProgressBarRangeInfo

Accessibility range information, to represent the status of a progress bar or seekable progress bar.

ProgressIndicatorDefaults

Contains the default values used for LinearProgressIndicator and CircularProgressIndicator.

ProvidableCompositionLocal

A ProvidableCompositionLocal can be used in CompositionLocalProvider to provide values.

ProvidableModifierLocal

ProvidableModifierLocals are ModifierLocals that can be used to provide values using a ModifierLocalProvider.

ProvidedValue

An instance to hold a value provided by CompositionLocalProvider and is created by the ProvidableCompositionLocal.provides infixed operator.

PullToRefreshDefaults

Contains the default values for PullToRefreshContainer

PullToRefreshState

The state that is associated with a PullToRefreshContainer.

R

RadialGradient

Brush implementation used to apply a radial gradient on a given Paint

RadioButtonColors

Represents the color used by a RadioButton in different states.

RadioButtonDefaults

Defaults used in RadioButton.

RangeSliderState

Class that holds information about RangeSlider's active range.

ReadOnlyComposable

This annotation can be applied to Composable functions so that no group will be generated around the body of the function it annotates.

RecomposeScope

Represents a recomposable scope or section of the composition hierarchy.

Recomposer

The scheduler for performing recomposition and applying updates to one or more Compositions.

Recomposer.State

Valid operational states of a Recomposer.

RecomposerInfo

Read-only information about a Recomposer.

Rect

An immutable, 2D, axis-aligned, floating-point rectangle whose coordinates are relative to a given origin.

Rect.Companion
Ref

Value holder general purpose class.

RelocationModifier

This interface is deprecated. Please use BringIntoViewResponder instead.

RelocationRequester

This class is deprecated. Please use BringIntoViewRequester instead.

Remeasurement

This object is associated with a layout node and allows to execute some extra measure/layout actions which are needed for some complex layouts.

RemeasurementModifier

A Modifier.Element that provides a Remeasurement object associated with the layout node the modifier is applied to.

RememberObserver

Objects implementing this interface are notified when they are initially used in a composition and when they are no longer being used.

RenderEffect

Intermediate rendering step used to render drawing commands with a corresponding visual effect.

RenderIntent

A render intent determines how a connector maps colors from one color space to another.

RepeatMode

Repeat mode for RepeatableSpec and VectorizedRepeatableSpec.

RepeatableSpec

RepeatableSpec takes another DurationBasedAnimationSpec and plays it iterations times.

RequestDisallowInterceptTouchEvent

Function that can be passed to pointerInteropFilter and then later invoked which provides an analog to ViewParent.requestDisallowInterceptTouchEvent.

ResolvedTextDirection

Describes the directionality of a text.

ResourceFont

Defines a font to be used while rendering text with resource ID.

Rgb

An RGB color space is an additive color space using the RGB color model (a color is therefore represented by a tuple of 3 numbers).

RichTooltipColors
Role

The type of user interface element.

RootForTest

The marker interface to be implemented by the root backing the composition.

RotaryInjectionScope

The receiver scope of rotary input injection lambda from performRotaryScrollInput.

RotaryInputModifierNode

Implement this interface to create a Modifier.Node that can intercept rotary scroll events.

RotaryScrollEvent

This event represents a rotary input event.

RoundRect

An immutable rounded rectangle with custom radii for all four corners.

RoundedCornerShape

A shape describing the rectangle with rounded corners.

RowScope

Scope for the children of Row.

S

ScaffoldDefaults

Object containing various default values for Scaffold component.

ScaleFactor

Holds 2 dimensional scaling factors for horizontal and vertical axes

ScopeUpdateScope

Internal compose compiler plugin API that is used to update the function the composer will call to recompose a recomposition scope.

ScrollAxisRange

The scroll state of one axis if this node is scrollable.

ScrollScope

Scope used for suspending scroll blocks

ScrollState

State of the scroll.

ScrollWheel

Representation of a mouse scroll wheel axis.

ScrollableDefaults

Contains the default values used by scrollable

ScrollableState

An object representing something that can be scrolled.

SearchBarColors

Represents the colors used by a search bar in different states.

SearchBarDefaults

Defaults used in SearchBar and DockedSearchBar.

SecureFlagPolicy

Policy on setting WindowManager.LayoutParams.FLAG_SECURE on a window.

SegmentedButtonColors

The different colors used in parts of the SegmentedButton in different states

SegmentedButtonDefaults
SelectableChipColors

Represents the container and content colors used in a selectable chip in different states.

SelectableChipElevation

Represents the elevation used in a selectable chip in different states.

SelectableDates

An interface that controls the selectable dates and years in the date pickers UI.

SelectionResult

Result of SemanticsSelector projection.

SemanticsActions

Ths object defines keys of the actions which can be set in semantics and performed on the semantics node.

SemanticsConfiguration

Describes the semantic information associated with the owning component

SemanticsMatcher

Wrapper for semantics matcher lambdas that allows to build string explaining to the developer what conditions were being tested.

SemanticsModifier

A Modifier.Element that adds semantics key/value for use in testing, accessibility, and similar use cases.

SemanticsModifierNode

A Modifier.Node that adds semantics key/value for use in testing, accessibility, and similar use cases.

SemanticsNode

A list of key/value pairs associated with a layout node or its subtree.

SemanticsNodeInteraction

Represents a semantics node and the path to fetch it from the semantics tree.

SemanticsNodeInteractionCollection

Represents a collection of semantics nodes and the path to fetch them from the semantics tree.

SemanticsNodeInteractionsProvider

Provides the main entry point into testing.

SemanticsOwner

Owns SemanticsNode objects and notifies listeners of changes to the semantics tree

SemanticsProperties

General semantics properties, mainly used for accessibility and testing.

SemanticsPropertiesAndroid
SemanticsPropertyKey

SemanticsPropertyKey is the infrastructure for setting key/value pairs inside semantics blocks in a type-safe way.

SemanticsPropertyReceiver

SemanticsPropertyReceiver is the scope provided by semantics {} blocks, letting you set key/value pairs primarily via extension functions.

SemanticsSelector

Projects the given set of nodes to a new set of nodes.

SetComposingRegionCommand

Mark a certain region of text as composing text.

SetComposingTextCommand

Replace the currently composing text with the given text, and set the new cursor position.

SetSelectionCommand

Sets the selection on the text.

Shader

Class that represents the corresponding Shader implementation on a platform.

ShaderBrush

Brush implementation that wraps and applies a the provided shader to a Paint The shader can be lazily created based on a given size, or provided directly as a parameter

Shadow

A single shadow.

Shape

Defines a generic shape.

ShapeDefaults

Contains the default values used by Shapes

Shapes

Material surfaces can be displayed in different shapes.

SheetState

State of a sheet composable, such as ModalBottomSheet

SheetValue

Possible values of SheetState.

SingleChoiceSegmentedButtonRowScope

Scope for the children of a SingleChoiceSegmentedButtonRow

Size

Holds a 2D floating-point size.

Size.Companion
SizeTransform

SizeTransform defines how to transform from one size to another when the size of the content changes.

SkippableUpdater
SliderColors

Represents the color used by a Slider in different states.

SliderDefaults

Object to hold defaults used by Slider

SliderPositions

This class is deprecated. Not necessary with the introduction of Slider state

SliderState

Class that holds information about Slider's active range.

SnackbarData

Interface to represent the data of one particular Snackbar as a piece of the SnackbarHostState.

SnackbarDefaults

Contains the default values used for Snackbar.

SnackbarDuration

Possible durations of the Snackbar in SnackbarHost

SnackbarHostState

State of the SnackbarHost, which controls the queue and the current Snackbar being shown inside the SnackbarHost.

SnackbarResult

Possible results of the SnackbarHostState.showSnackbar call

SnackbarVisuals

Interface to represent the visuals of one particular Snackbar as a piece of the SnackbarData.

SnapFlingBehavior

A FlingBehavior that performs snapping of items to a given position.

SnapLayoutInfoProvider

Provides information about the layout that is using a SnapFlingBehavior.

SnapPositionInLayout

Describes the general positioning of a given snap item in its containing layout.

SnapSpec

SnapSpec describes a jump-cut type of animation.

Snapshot

A snapshot of the values return by mutable states and other state objects.

SnapshotApplyConflictException

An exception that is thrown when SnapshotApplyResult.check is called on a result of a MutableSnapshot.apply that fails to apply.

SnapshotApplyResult

The result of a applying a mutable snapshot.

SnapshotApplyResult.Failure
SnapshotApplyResult.Success
SnapshotContextElement

A CoroutineContext element that enters an associated snapshot whenever a coroutine associated with this context is resumed.

SnapshotContextElement.Key
SnapshotMutableState

A mutable value holder where reads to the value property during the execution of a Composable function, the current RecomposeScope will be subscribed to changes of that value.

SnapshotMutationPolicy

A policy to control how the result of mutableStateOf report and merge changes to the state object.

SnapshotStateList

An implementation of MutableList that can be observed and snapshot.

SnapshotStateMap

An implementation of MutableMap that can be observed and snapshot.

SnapshotStateObserver

Helper class to efficiently observe snapshot state reads.

SoftKeyboardInterceptionModifierNode

Implement this interface to create a Modifier.Node that can intercept hardware Key events before they are sent to the software keyboard.

SoftwareKeyboardController

Provide software keyboard control.

SolidColor
SpanStyle

Styling configuration for a text span.

SplineBasedFloatDecayAnimationSpec

A native Android fling curve decay.

Spring

Physics class contains a number of recommended configurations for physics animations.

SpringSpec

Creates a SpringSpec that uses the given spring constants (i.e. dampingRatio and stiffness.

StabilityInferred

This annotation is added on classes by the compiler when their stability is inferred.

Stable

Stable is used to communicate some guarantees to the compose compiler about how a certain type or function will behave.

StableMarker

StableMarker marks an annotation as indicating a type is stable.

StaggeredGridCells

This class describes the count and the sizes of columns in vertical staggered grids, or rows in horizontal staggered grids.

StaggeredGridCells.Adaptive

Defines a grid with as many rows or columns as possible on the condition that every cell has at least minSize space and all extra space distributed evenly.

StaggeredGridCells.Fixed

Defines a grid with fixed number of rows or columns.

StaggeredGridCells.FixedSize

Defines a grid with as many rows or columns as possible on the condition that every cell takes exactly size space.

StaggeredGridItemSpan

Span defines a number of lanes (columns in vertical grid/rows in horizontal grid) for staggered grid items.

StampedPathEffectStyle

Strategy for transforming each point of the shape along the drawn path

StartOffset

This class defines a start offset for repeatable and infiniteRepeatable.

StartOffsetType

This class defines the two types of StartOffset: StartOffsetType.Delay and StartOffsetType.FastForward.

State

A value holder where reads to the value property during the execution of a Composable function, the current RecomposeScope will be subscribed to changes of that value.

StateFactoryMarker

Designates a function as a factory function that produces a State object.

StateObject

Interface implemented by all snapshot aware state objects.

StateRecord

Snapshot local value of a state object.

StateRestorationTester

Helps to test the state restoration for your Composable component.

StateRestorationTester

Helps to test the state restoration for your Composable component.

Stroke

DrawStyle that provides information for drawing content with a stroke

StrokeCap

Styles to use for line endings.

StrokeJoin

Styles to use for line joins.

SubcomposeIntermediateMeasureScope

SubcomposeIntermediateMeasureScope is the receiver scope for the intermediate measurer policy that gets invoked during the intermediate measure pass.

SubcomposeLayoutState

State used by SubcomposeLayout.

SubcomposeLayoutState.PrecomposedSlotHandle

Instance of this interface is returned by precompose function.

SubcomposeMeasureScope

The receiver scope of a SubcomposeLayout's measure lambda which adds ability to dynamically subcompose a content during the measuring on top of the features provided by MeasureScope.

SubcomposeSlotReusePolicy

This policy allows SubcomposeLayout to retain some of slots which we were used but not used anymore instead of disposing them.

SubcomposeSlotReusePolicy.SlotIdsSet

Set containing slot ids currently available to reuse.

SuggestionChipDefaults

Contains the baseline values used by SuggestionChip.

SuspendingPointerInputModifierNode

Extends PointerInputModifierNode with a handler to execute asynchronously when an event occurs and a function to reset that handler (cancels the existing coroutine and essentially resets the handler's execution).

SweepGradient

Brush implementation used to apply a sweep gradient on a given Paint

SwipeToDismissBoxDefaults

Contains default values for SwipeToDismissBox and SwipeToDismissBoxState.

SwipeToDismissBoxState

State of the SwipeToDismissBox composable.

SwipeToDismissBoxValue

The directions in which a SwipeToDismissBox can be dismissed.

SwitchColors

Represents the colors used by a Switch in different states

SwitchDefaults

Contains the default values used by Switch

SystemFontFamily

A base class of FontFamilys installed on the system.

T

TabIndicatorScope

Scope for the composable used to render a Tab indicator, this can be used for more complex indicators requiring layout information about the tabs like TabRowDefaults.PrimaryIndicator and TabRowDefaults.SecondaryIndicator

TabPosition

Data class that contains information about a tab's position on screen, used for calculating where to place the indicator that shows which tab is selected.

TabRowDefaults

Contains default implementations and values used for TabRow.

TargetBasedAnimation

This is a convenient animation wrapper class that works for all target based animations, i.e. animations that has a pre-defined end value, unlike decay.

TestContext
TestMonotonicFrameClock

A MonotonicFrameClock with a time source controlled by a kotlinx-coroutines-test TestCoroutineScheduler.

TestOnly
TestOnly
TestOwner

Provides necessary services to facilitate testing.

TextAlign

Defines how to align text horizontally.

TextDecoration

Defines a horizontal line to be drawn on the text.

TextDirection

Defines the algorithm to be used while determining the text direction.

TextFieldColors

Represents the colors of the input text, container, and content (including label, placeholder, leading and trailing icons) used in a text field in different states.

TextFieldDefaults

Contains the default values used by TextField.

TextFieldValue

A class holding information about the editing state.

TextGeometricTransform

Define a geometric transformation on text.

TextIndent

Specify the indentation of a paragraph.

TextInputService

Handles communication with the IME.

TextInputSession

Represents a input session for interactions between a soft keyboard and editable text.

TextLayoutInput

The data class which holds the set of parameters of the text layout computation.

TextLayoutResult

The data class which holds text layout result.

TextMeasurer

TextMeasurer is responsible for measuring a text in its entirety so that it's ready to be drawn.

TextMotion

Defines ways to render and place glyphs to provide readability and smooth animations for text.

TextOverflow

How overflowing text should be handled.

TextPainter
TextRange

An immutable text range class, represents a text range from start (inclusive) to end (exclusive).

TextSelectionColors

Represents the colors used for text selection by text and text field components.

TextStyle

Styling configuration for a Text.

TextToolbar

Interface for text-related toolbar.

TextToolbarStatus

Status of the TextToolbar.

TextUnit

The unit used for text related dimension value.

TextUnitType

An enum class defining for type of TextUnit.

TileMode

Defines what happens at the edge of the gradient.

TimePickerColors

Represents the colors used by a TimePicker in different states

TimePickerDefaults

Contains the default values used by TimePicker

TimePickerLayoutType

Represents the different configurations for the layout of the Time Picker

TimePickerState

A class to handle state changes in a TimePicker

ToggleableState

Enum that represents possible toggleable states.

ToolingState

Tooling can override mutableStateOf in Composable with ToolingState.

TooltipDefaults

Tooltip defaults that contain default values for both PlainTooltip and RichTooltip

TooltipState

The state that is associated with a TooltipBox.

TopAppBarColors

Represents the colors used by a top app bar in different states.

TopAppBarDefaults

Contains default values used for the top app bar implementations.

TopAppBarScrollBehavior

A TopAppBarScrollBehavior defines how an app bar should behave when the content under it is scrolled.

TopAppBarState

A state object that can be hoisted to control and observe the top app bar state.

TouchInjectionScope

The receiver scope of the touch input injection lambda from performTouchInput.

TransferParameters

Defines the parameters for the ICC parametric curve type 4, as defined in ICC.1:2004-10, section 10.15.

TransformOrigin

A two-dimensional position represented as a fraction of the Layer's width and height

TransformScope

Scope used for suspending transformation operations

TransformableState

State of transformable.

TransformedText

The transformed text with offset offset mapping

Transition

Transition manages all the child animations on a state level.

Transition.Segment

Segment holds initialState and targetState, which are the beginning and end of a transition.

Transition.TransitionAnimationState

Each animation created using animateFloat, animateDp, etc is represented as a TransitionAnimationState in Transition.

TtsAnnotation

An annotation that contains the metadata intended for text-to-speech engine.

TweenSpec

Creates a TweenSpec configured with the given duration, delay, and easing curve.

TwoWayConverter

TwoWayConverter class contains the definition on how to convert from an arbitrary type T to a AnimationVector, and convert the AnimationVector back to the type T.

Typeface

A class that can be used for changing the font used in text.

Typography

The Material Design type scale includes a range of contrasting styles that support the needs of your product and its content.

U

URLSpanCache

This class converts UrlAnnotations to URLSpans, ensuring that the same instance of URLSpan will be returned for every instance of UrlAnnotation.

UiComposable

An annotation that can be used to mark a composable function as being expected to be use in a composable function that is also marked or inferred to be marked as a UiComposable.

Updater

A helper receiver scope class used by ComposeNode to help write code to initialized and update a node.

UriHandler

An interface of providing platform specific URL handling.

UrlAnnotation

An annotation that contains the metadata intended for text-to-speech engine.

V

VNode
ValueElement

A ValueElement describes an element of a compose value instance.

ValueElementSequence

A builder for a sequence of ValueElement.

VectorApplier
VectorComposable

An annotation that can be used to mark an composable function as being expected to be use in a composable function that is also marked or inferred to be marked as a VectorComposable.

VectorConfig

Holds a set of values that overwrite the original property values of an ImageVector.

VectorGroup

Defines a group of paths or subgroups, plus transformation information.

VectorNode
VectorPainter

Painter implementation that abstracts the drawing of a Vector graphic.

VectorPath

Leaf node of a Vector graphics tree.

VectorProperty

Represents one of the properties for PathComponent or GroupComponent that can be overwritten when it is composed and drawn with RenderVectorGroup.

VectorProperty.Fill
VectorProperty.FillAlpha
VectorProperty.PathData
VectorProperty.PivotX
VectorProperty.PivotY
VectorProperty.Rotation
VectorProperty.ScaleX
VectorProperty.ScaleY
VectorProperty.Stroke
VectorProperty.StrokeAlpha
VectorProperty.StrokeLineWidth
VectorProperty.TranslateX
VectorProperty.TranslateY
VectorProperty.TrimPathEnd
VectorProperty.TrimPathOffset
VectorProperty.TrimPathStart
VectorizedAnimationSpec

VectorizedAnimationSpecs are stateless vector based animation specifications.

VectorizedDecayAnimationSpec

VectorizedDecayAnimationSpecs are stateless vector based decay animation specifications.

VectorizedDurationBasedAnimationSpec

Base class for VectorizedAnimationSpecs that are based on a fixed durationMillis.

VectorizedFiniteAnimationSpec

All the finite VectorizedAnimationSpecs implement this interface, including: VectorizedKeyframesSpec, VectorizedTweenSpec, VectorizedRepeatableSpec, VectorizedSnapSpec, VectorizedSpringSpec, etc.

VectorizedFloatAnimationSpec

A convenient implementation of VectorizedFloatAnimationSpec that turns a FloatAnimationSpec into a multi-dimensional VectorizedFloatAnimationSpec, by using the same FloatAnimationSpec on each dimension of the AnimationVector that is being animated.

VectorizedInfiniteRepeatableSpec

This animation takes another VectorizedDurationBasedAnimationSpec and plays it infinite times.

VectorizedKeyframesSpec

VectorizedKeyframesSpec class manages the animation based on the values defined at different timestamps in the duration of the animation (i.e. different keyframes).

VectorizedRepeatableSpec

This animation takes another VectorizedDurationBasedAnimationSpec and plays it iterations times.

VectorizedSnapSpec

VectorizedSnapSpec immediately snaps the animating value to the end value.

VectorizedSpringSpec

VectorizedSpringSpec uses spring animations to animate (each dimension of) AnimationVectors.

VectorizedTweenSpec

VectorizedTweenSpec animates a AnimationVector value by interpolating the start and end value, in the given durationMillis using the given easing curve.

Velocity

A two dimensional velocity in pixels per second.

VelocityTracker

Computes a pointer's velocity.

VelocityTracker1D

A velocity tracker calculating velocity in 1 dimension.

VerbatimTtsAnnotation

The text associated with this annotation is a series of characters that have to be read verbatim.

VertexMode

Defines how a list of points is interpreted when drawing a set of triangles.

VerticalAlignmentLine

A vertical AlignmentLine.

Vertices

A set of vertex data used by Canvas.drawVertices.

ViewCompositionStrategy

A strategy for managing the underlying Composition of Compose UI Views such as ComposeView and AbstractComposeView.

ViewCompositionStrategy.DisposeOnDetachedFromWindow

ViewCompositionStrategy that disposes the composition whenever the view becomes detached from a window.

ViewCompositionStrategy.DisposeOnDetachedFromWindowOrReleasedFromPool

The composition will be disposed automatically when the view is detached from a window, unless it is part of a pooling container, such as RecyclerView.

ViewCompositionStrategy.DisposeOnLifecycleDestroyed

ViewCompositionStrategy that disposes the composition when lifecycle is destroyed.

ViewCompositionStrategy.DisposeOnViewTreeLifecycleDestroyed

ViewCompositionStrategy that disposes the composition when the LifecycleOwner returned by findViewTreeLifecycleOwner of the next window the view is attached to is destroyed.

ViewConfiguration

Contains methods to standard constants used in the UI for timeouts, sizes, and distances.

ViewRootForInspector

The marker interface to be implemented by Views that are initialized from Compose.

ViewRootForTest

The marker interface to be implemented by the View backing the composition.

VisualTransformation

Interface used for changing visual output of the input field.

W

Wallpapers

Wallpapers available to be used in the Preview.

WhitePoint

Class for constructing white points used in RGB color space.

WindowHeightSizeClass

Height-based window size class.

WindowInfo

Provides information about the Window that is hosting this compose hierarchy.

WindowInsets

A representation of window insets that tracks access to enable recomposition, relayout, and redrawing when values change.

WindowInsets.Companion
WindowInsetsSides

WindowInsetsSides is used in WindowInsets.only to define which sides of the WindowInsets should apply.

WindowRecomposerFactory

A factory for creating an Android window-scoped Recomposer.

WindowRecomposerPolicy
WindowSizeClass

Window size classes are a set of opinionated viewport breakpoints to design, develop, and test responsive application layouts against.

WindowWidthSizeClass

Width-based window size class.