backstack/com.slack.circuit.backstack/SaveableBackStack

SaveableBackStack

class SaveableBackStack : BackStack<SaveableBackStack.Record> (source)

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

Constructors

SaveableBackStack

constructor(initialRecord: SaveableBackStack.Record)

constructor(root: Screen)

Types

Record

data class Record(val screen: Screen, val args: Map<String, Any?> = emptyMap(), val key: String = uuid4().toString()) : BackStack.Record

Properties

isAtRoot

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

true if the BackStack contains exactly one record.

isEmpty

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

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

size

open override val size: Int

The number of records contained in this BackStack that will be seen by an iterator.

topRecord

open override val topRecord: SaveableBackStack.Record?

The top-most record in the BackStack, or null if the BackStack is empty.

Functions

containsRecord

open override fun containsRecord(record: SaveableBackStack.Record, includeSaved: Boolean): Boolean

Whether the back stack contains the given record.

iterator

open operator override fun iterator(): Iterator<SaveableBackStack.Record>

pop

open override fun pop(result: PopResult?): SaveableBackStack.Record?

Attempt to pop the top item off of the back stack, returning the popped Record if popping was successful or null if no entry was popped.

popUntil

open fun popUntil(predicate: (SaveableBackStack.Record) -> Boolean): ImmutableList<SaveableBackStack.Record>

Pop records off the top of the backstack until one is found that matches the given predicate.

push

open override fun push(record: SaveableBackStack.Record, resultKey: String?)

Push a new Record onto the back stack. The new record will become the top of the stack.

open override fun push(screen: Screen, resultKey: String?)

Push a new Screen onto the back stack. This will be enveloped in a Record and the new record will become the top of the stack.

fun push(screen: Screen, args: Map<String, Any?>, resultKey: String?)

restoreState

open override fun restoreState(screen: Screen): Boolean

Restores the saved state with the given screen, adding it on top of the existing entry list. If you wish to replace the current entry list, you should pop all of the existing entries off before calling this function.

saveState

open override fun saveState()

Saves the current back stack entry list in an internal state store. It can be later restored by the root screen to restoreState.