circuit-runtime-screen/com.slack.circuit.runtime.screen

Package-level declarations

Types

CircuitSaveable

actual interface CircuitSaveable

A Circuit value whose persisted representation is handled by a CircuitSaver.

expect sealed interface CircuitSaveable

A Circuit value whose persisted representation is handled by a CircuitSaver.

actual interface CircuitSaveable

A Circuit value whose persisted representation is handled by a CircuitSaver.

actual interface CircuitSaveable

A Circuit value whose persisted representation is handled by a CircuitSaver.

actual interface CircuitSaveable

A Circuit value whose persisted representation is handled by a CircuitSaver.

abstract class CircuitSaver

Converts Screens and PopResults to and from representations that can be stored in a Compose SaveableStateRegistry.

ParcelablePopResult

actual interface ParcelablePopResult : PopResult, Parcelable

A PopResult that is also android.os.Parcelable on Android.

expect interface ParcelablePopResult : PopResult

A PopResult that is also android.os.Parcelable on Android.

actual interface ParcelablePopResult : PopResult

A PopResult that is also android.os.Parcelable on Android.

actual interface ParcelablePopResult : PopResult

A PopResult that is also android.os.Parcelable on Android.

actual interface ParcelablePopResult : PopResult

A PopResult that is also android.os.Parcelable on Android.

ParcelableScreen

actual interface ParcelableScreen : Screen, Parcelable

A Screen that is also android.os.Parcelable on Android.

expect interface ParcelableScreen : Screen

A Screen that is also android.os.Parcelable on Android.

actual interface ParcelableScreen : Screen

A Screen that is also android.os.Parcelable on Android.

actual interface ParcelableScreen : Screen

A Screen that is also android.os.Parcelable on Android.

actual interface ParcelableScreen : Screen

A Screen that is also android.os.Parcelable on Android.

actual interface PopResult : CircuitSaveable, Parcelable

expect interface PopResult : CircuitSaveable

actual interface PopResult : CircuitSaveable

actual interface PopResult : CircuitSaveable

actual interface PopResult : CircuitSaveable

actual interface Screen : CircuitSaveable, Parcelable

Represents an individual screen, used as a key for Presenter.Factory and Ui.Factory.

expect interface Screen : CircuitSaveable

Represents an individual screen, used as a key for Presenter.Factory and Ui.Factory.

actual interface Screen : CircuitSaveable

Represents an individual screen, used as a key for Presenter.Factory and Ui.Factory.

actual interface Screen : CircuitSaveable

Represents an individual screen, used as a key for Presenter.Factory and Ui.Factory.

actual interface Screen : CircuitSaveable

Represents an individual screen, used as a key for Presenter.Factory and Ui.Factory.

actual interface StaticScreen : Screen

A marker interface that indicates that this Screen only ever has static content and does not require a presenter to compute or manage its state. This is useful for UIs that either have no state or can derive their state solely from static inputs or the Screen key itself.

expect interface StaticScreen : Screen

A marker interface that indicates that this Screen only ever has static content and does not require a presenter to compute or manage its state. This is useful for UIs that either have no state or can derive their state solely from static inputs or the Screen key itself.

actual interface StaticScreen : Screen

A marker interface that indicates that this Screen only ever has static content and does not require a presenter to compute or manage its state. This is useful for UIs that either have no state or can derive their state solely from static inputs or the Screen key itself.

actual interface StaticScreen : Screen

A marker interface that indicates that this Screen only ever has static content and does not require a presenter to compute or manage its state. This is useful for UIs that either have no state or can derive their state solely from static inputs or the Screen key itself.

actual interface StaticScreen : Screen

A marker interface that indicates that this Screen only ever has static content and does not require a presenter to compute or manage its state. This is useful for UIs that either have no state or can derive their state solely from static inputs or the Screen key itself.

Properties

DefaultCircuitSaver

actual val DefaultCircuitSaver: CircuitSaver

The default CircuitSaver for the current platform.

expect val DefaultCircuitSaver: CircuitSaver

The default CircuitSaver for the current platform.

actual val DefaultCircuitSaver: CircuitSaver

The default CircuitSaver for the current platform.

actual val DefaultCircuitSaver: CircuitSaver

The default CircuitSaver for the current platform.

actual val DefaultCircuitSaver: CircuitSaver

The default CircuitSaver for the current platform.

LocalCircuitSaver

val LocalCircuitSaver: ProvidableCompositionLocal<CircuitSaver>

The CircuitSaver used by Circuit's saveable back stack implementations when one is not passed explicitly. Defaults to DefaultCircuitSaver.

Functions

ProvideCircuitSaver

fun ProvideCircuitSaver(circuitSaver: CircuitSaver, content: @Composable () -> Unit)

Provides circuitSaver as LocalCircuitSaver to content.

restorePopResult

inline fun <T : PopResult> CircuitSaver.restorePopResult(saved: Any, onAbsent: () -> Unit = {}, onTypeMismatch: (CircuitSaveable) -> Unit = { error("Expected ${T::class}, but CircuitSaver restored ${it::class}.") }): T?

Restores saved as a T.

inline fun <T : Screen> CircuitSaver.restoreScreen(saved: Any, onAbsent: () -> Unit = {}, onTypeMismatch: (CircuitSaveable) -> Unit = { error("Expected ${T::class}, but CircuitSaver restored ${it::class}.") }): T?

Restores saved as a T.