circuit-runtime/com.slack.circuit.runtime/Navigator/StateOptions

StateOptions

data class StateOptions(val save: Boolean = false, val restore: Boolean = false, val clear: Boolean = false)(source)

A holder for the state management configuration for a Navigator.resetRoot call.

Constructors

StateOptions

constructor(save: Boolean = false, restore: Boolean = false, clear: Boolean = false)

Types

Companion

object Companion

Properties

clear

val clear: Boolean

Whether any previously saved state for the new root Screen should be cleared. Will be cleared after any restore regardless of restore.

restore

val restore: Boolean

Whether any previously saved state for the new root Screen should be restored. If this is false or there is no previous state, the back stack will only contain the new root Screen.

save

val save: Boolean

Whether to save the current entry list. It can be restored by passing the current root Screen to Navigator.resetRoot with restoreState = true