redwood-compose/app.cash.redwood.compose

Package-level declarations

Types

Link copied to clipboard
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).

Link copied to clipboard
class AndroidUiFrameClock(choreographer: Choreographer) : MonotonicFrameClock
Link copied to clipboard
Link copied to clipboard
interface RedwoodComposition
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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!

Link copied to clipboard
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!

Link copied to clipboard
@get:Composable
@get:ReadOnlyComposable
val WidgetVersion: UInt

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

Functions

Link copied to clipboard
@Composable
fun BackHandler(enabled: Boolean = true, onBack: () -> Unit)

An effect for handling presses of the system back button.

Link copied to clipboard
fun <W : Any> RedwoodComposition(scope: CoroutineScope, view: RedwoodView<W>, widgetSystem: WidgetSystem<W>, onEndChanges: () -> Unit = {}): RedwoodComposition
fun <W : Any> RedwoodComposition(scope: CoroutineScope, container: Widget.Children<W>, onBackPressedDispatcher: OnBackPressedDispatcher, saveableStateRegistry: SaveableStateRegistry?, uiConfigurations: StateFlow<UiConfiguration>, widgetSystem: WidgetSystem<W>, onEndChanges: () -> Unit = {}): RedwoodComposition