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.

InternalCircuitSaverApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "This is an internal Circuit saver API. It may change without warning and should not be used outside Circuit's first-party artifacts.")

annotation class InternalCircuitSaverApi

Marks internal Circuit saver APIs that may change without warning or migration support.

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

A result returned while calling Navigator.pop().

expect interface PopResult : CircuitSaveable

A result returned while calling Navigator.pop().

actual interface PopResult : CircuitSaveable

A result returned while calling Navigator.pop().

actual interface PopResult : CircuitSaveable

A result returned while calling Navigator.pop().

actual interface PopResult : CircuitSaveable

A result returned while calling Navigator.pop().

actual interface Screen : CircuitSaveable

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

LocalCircuitSaver

val LocalCircuitSaver: ProvidableCompositionLocal<CircuitSaver>

The default CircuitSaver used by Circuit's saveable back stacks and result handlers.

Functions

currentProvidedCircuitSaverOrNull

fun currentProvidedCircuitSaverOrNull(): CircuitSaver?

Returns the saver installed by ProvideCircuitSaver, or null when none is installed.

operator fun CircuitSaver.plus(other: CircuitSaver): CircuitSaver

Returns a saver that tries this saver and then other.

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.