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

androidx.compose.runtime

Annotations

CheckResult
Composable

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

ComposableInferredTarget

An annotation generated by the compose compiler plugin.

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
DisallowComposableCalls

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

ExperimentalComposeApi
ExplicitGroupsComposable

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

Immutable

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

InternalComposeApi
InternalComposeTracingApi
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.

ReadOnlyComposable

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

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.

TestOnly

Interfaces

Applier

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

ComposeNodeLifecycleCallback

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

Composer

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

Composition

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

CompositionLocalMap

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

CompositionTracer

Internal tracing API.

ControlledComposition

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

DisposableEffectResult
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.

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.

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.

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.

MonotonicFrameClock

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

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.

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.

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.

ProduceStateScope

Receiver scope for use with produceState.

RecomposeScope

Represents a recomposable scope or section of the composition hierarchy.

RecomposerInfo

Read-only information about a Recomposer.

RememberObserver

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

ScopeUpdateScope

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

SnapshotMutationPolicy

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

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.

Classes

AbstractApplier

An abstract Applier implementation.

AtomicReference
BroadcastFrameClock

A simple frame clock.

ComposablesKt
ComposerKt
CompositionContext

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

CompositionKt
CompositionLocal

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

CompositionLocalContext

Stores CompositionLocal's and their values.

CompositionLocalKt
DisposableEffectScope

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

EffectsKt
ExpectKt
MonotonicFrameClockKt
MovableContent

A Compose compiler plugin API.

MovableContentKt
MovableContentState

A Compose compiler plugin API.

MovableContentStateReference

A Compose compiler plugin API.

PausableMonotonicFrameClock

A MonotonicFrameClock wrapper that can be paused and resumed.

ProvidableCompositionLocal

A ProvidableCompositionLocal can be used in CompositionLocalProvider to provide values.

ProvidedValue

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

Recomposer

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

RecomposerKt
SkippableUpdater
SnapshotDoubleStateKt
SnapshotFloatStateKt
SnapshotIntStateKt
SnapshotLongStateKt
SnapshotStateExtensionsKt
SnapshotStateKt
Updater

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

Composer.Companion
CompositionLocalMap.Companion
MonotonicFrameClock.Key
Recomposer.Companion

hack: the companion object is thread local in Kotlin/Native to avoid freezing _runningRecomposers with the current memory model.

Enums

Recomposer.State

Valid operational states of a Recomposer.