backstack/com.slack.circuit.backstack

Package-level declarations

Types

interface BackStack<R : BackStack.Record> : Iterable<R>

A caller-supplied stack of Records for presentation with a Navigator. Iteration order is top-first (first element is the top of the stack).

BackStackRecordLocalProvider

fun interface BackStackRecordLocalProvider<in R : BackStack.Record>

interface NavDecoration

Presentation logic for currently visible routes of a navigable UI.

fun interface ProvidedValues

SaveableBackStack

class SaveableBackStack : BackStack<SaveableBackStack.Record>

A BackStack that supports saving its state via rememberSaveable. See rememberSaveableBackStack.

SaveableStateRegistryBackStackRecordLocalProvider

object SaveableStateRegistryBackStackRecordLocalProvider : BackStackRecordLocalProvider<BackStack.Record>

A BackStackRecordLocalProvider that provides a SaveableStateRegistry for each record.

Properties

val BackStack<out BackStack.Record>.isAtRoot: Boolean

true if the BackStack contains exactly one record.

val BackStack<out BackStack.Record>.isEmpty: Boolean

true if the BackStack contains no records. BackStack.firstOrNull will return null.

Functions

providedValuesForBackStack

fun <R : BackStack.Record> providedValuesForBackStack(backStack: BackStack<R>, stackLocalProviders: ImmutableList<BackStackRecordLocalProvider<R>> = persistentListOf(), includeDefaults: Boolean = true): ImmutableMap<R, ProvidedValues>

rememberSaveableBackStack

fun rememberSaveableBackStack(initialScreens: List<Screen>): SaveableBackStack

Creates and remembers a SaveableBackStack filled with the given initialScreens. initialScreens must not be empty.

fun rememberSaveableBackStack(root: Screen, init: SaveableBackStack.() -> Unit = {}): SaveableBackStack

Creates and remembers a SaveableBackStack with the given root screen.