androidx.compose.runtime
Interfaces
Applier |
An Applier is responsible for applying the tree-based operations that get emitted during a composition. |
CommitScope |
A CommitScope represents an object that executes some code and has a cleanup in the context of the Composition lifecycle. |
Composition |
A composition object is usually constructed for you, and returned from an API that is used to initially compose a UI. |
CompositionData |
A CompositionData is the data tracked by the composer during composition. |
CompositionGroup |
CompositionGroup is a group of data slots tracked independently by composition. |
CompositionLifecycleObserver |
Objects implementing this interface are notified when they are initially used in a composition and when they are no longer being used. |
DisposableEffectDisposable | |
EmbeddingContext | |
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. |
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. |
Ambient |
Compose passes data through the composition tree explicitly through means of parameters to composable functions. |
Composer |
Implementation of a composer for mutable tree. |
CompositionReference |
A CompositionReference is an opaque type that is used to logically "link" two compositions together. |
DisposableEffectScope |
Receiver scope for DisposableEffect that offers the onDispose clause that should be the last statement in any call to DisposableEffect. |
KeyInfo |
Information about groups and their keys. |
PausableMonotonicFrameClock |
A MonotonicFrameClock wrapper that can be paused and resumed. |
ProvidableAmbient |
A ProvidableAmbient can be used in Providers to provide values. |
ProvidedValue |
An instance to hold a value provided by Providers and is created by the ProvidableAmbient.provides infixed operator. |
Recomposer |
The scheduler for performing recomposition and applying updates to one or more Compositions. |
SkippableUpdater | |
Updater |
A helper receiver scope class used by emit to help write code to initialized and update a node. |
WeakHashMap |
Annotations
CheckResult | |
Composable |
Composable functions are the fundamental building blocks of an application built with Compose. |
ComposableContract |
This annotation can be applied to Composable functions and provide metadata to the compiler that imply compose-specific contracts that the author of the function is guaranteeing the function complies with. |
ComposeCompilerApi | |
ExperimentalComposeApi | |
Immutable |
Immutable can be used to mark class as producing immutable instances. |
InternalComposeApi | |
MainThread | |
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. |
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 | |
UnionType |
Top-level functions summary
Unit |
DisposableEffect(effect: DisposableEffectScope.() -> DisposableEffectDisposable) |
Unit |
DisposableEffect(subject: Any?, effect: DisposableEffectScope.() -> DisposableEffectDisposable) A side effect of composition that must run for any new unique value of subject and must be reversed or cleaned up if subject changes or if the DisposableEffect leaves the composition. |
Unit |
DisposableEffect(subject1: Any?, subject2: Any?, effect: DisposableEffectScope.() -> DisposableEffectDisposable) A side effect of composition that must run for any new unique value of subject1 or subject2 and must be reversed or cleaned up if subject1 or subject2 changes, or if the DisposableEffect leaves the composition. |
Unit |
DisposableEffect(subject1: Any?, subject2: Any?, subject3: Any?, effect: DisposableEffectScope.() -> DisposableEffectDisposable) A side effect of composition that must run for any new unique value of subject1, subject2 or subject3 and must be reversed or cleaned up if subject1, subject2 or subject3 changes, or if the DisposableEffect leaves the composition. |
Unit |
DisposableEffect(vararg subjects: Any?, effect: DisposableEffectScope.() -> DisposableEffectDisposable) A side effect of composition that must run for any new unique value of subjects and must be reversed or cleaned up if any subjects change or if the DisposableEffect leaves the composition. |
actual EmbeddingContext | |
Unit |
LaunchedEffect(block: suspend CoroutineScope.() -> Unit) When LaunchedEffect enters the composition it will launch block into the composition's CoroutineContext. |
Unit |
LaunchedEffect(subject: Any?, block: suspend CoroutineScope.() -> Unit) When LaunchedEffect enters the composition it will launch block into the composition's CoroutineContext. |
Unit |
LaunchedEffect(subject1: Any?, subject2: Any?, block: suspend CoroutineScope.() -> Unit) When LaunchedEffect enters the composition it will launch block into the composition's CoroutineContext. |
Unit |
LaunchedEffect(subject1: Any?, subject2: Any?, subject3: Any?, block: suspend CoroutineScope.() -> Unit) When LaunchedEffect enters the composition it will launch block into the composition's CoroutineContext. |
Unit |
LaunchedEffect(vararg subjects: Any?, block: suspend CoroutineScope.() -> Unit) When LaunchedEffect enters the composition it will launch block into the composition's CoroutineContext. |
Unit |
LaunchedTask(block: suspend CoroutineScope.() -> Unit) When LaunchedTask enters the composition it will launch block into the composition's CoroutineContext. |
Unit |
LaunchedTask(key: Any?, block: suspend CoroutineScope.() -> |