redwood-compose/app.cash.redwood.compose

Package-level declarations

Types

class AndroidUiDispatcher : CoroutineDispatcher

A CoroutineDispatcher that will perform dispatch during a handler callback or choreographer's animation frame stage, whichever comes first. Use Main to obtain a dispatcher for the process's main thread (i.e. the activity thread).

AndroidUiFrameClock

class AndroidUiFrameClock(choreographer: Choreographer) : MonotonicFrameClock

DisplayLinkClock

object DisplayLinkClock : MonotonicFrameClock

RedwoodComposition

interface RedwoodComposition

WindowAnimationFrameClock

object WindowAnimationFrameClock : MonotonicFrameClock

Properties

current

@get:Composable

@get:ReadOnlyComposable

val OnBackPressedDispatcher.Companion.current: OnBackPressedDispatcher

@get:Composable

@get:ReadOnlyComposable

val UiConfiguration.Companion.current: UiConfiguration

Expose various configuration properties of the host.

LocalOnBackPressedDispatcher

val LocalOnBackPressedDispatcher: ProvidableCompositionLocal<OnBackPressedDispatcher>

LocalUiConfiguration

val LocalUiConfiguration: ProvidableCompositionLocal<UiConfiguration>

Provide various configurations of the UI. This value will be bound automatically. Custom values should only be provided into a composition for testing purposes!

LocalViewInsets

val LocalViewInsets: ProvidableCompositionLocal<Margin>

The insets of the viewport that the composition is not safe for content because it is obscured by the system.

LocalWidgetVersion

val LocalWidgetVersion: ProvidableCompositionLocal<UInt>

Provide the version of widgets in use. This value will be bound automatically when a protocol-based display is used. Custom values should only be provided into a composition for testing purposes!

WidgetVersion

@get:Composable

@get:ReadOnlyComposable

val WidgetVersion: UInt

Exposes the version of the widgets for conditional logic (such as progressive enhancement).

Functions

BackHandler

@Composable

fun BackHandler(enabled: Boolean = true, onBack: () -> Unit)

An effect for handling presses of the system back button.

ConsumeInsets

@Composable

fun ConsumeInsets(maximumValue: Margin? = null, block: @Composable (Margin) -> Unit)

Consume LocalViewInsets for the execution of block. This will consume all available insets unless maximumValue is set.

RedwoodComposition

fun <W : Any> RedwoodComposition(scope: CoroutineScope, view: RedwoodView<W>, widgetSystem: WidgetSystem<W>, onChanges: () -> Unit = {}): RedwoodComposition

fun <W : Any> RedwoodComposition(scope: CoroutineScope, container: Widget.Children<W>, onBackPressedDispatcher: OnBackPressedDispatcher, saveableStateRegistry: SaveableStateRegistry?, uiConfigurations: StateFlow<UiConfiguration>, widgetSystem: WidgetSystem<W>, onChanges: () -> Unit = {}): RedwoodComposition