From 0cdf7454bc65609d616fb5d8e17cbaf2205cd4a8 Mon Sep 17 00:00:00 2001 From: Zac Sweers Date: Mon, 12 Feb 2024 13:54:19 -0500 Subject: [PATCH] Deployed 2d66716f with MkDocs version: 1.5.3 --- .../-back-stack/-record/await-result.html | 2 +- .../-back-stack/-record/index.html | 2 +- .../-back-stack/-record/key.html | 2 +- .../-back-stack/-record/screen.html | 2 +- .../-back-stack/index.html | 4 +- .../-back-stack/pop-until.html | 2 +- .../-back-stack/pop.html | 2 +- .../-back-stack/push.html | 2 +- .../-back-stack/restore-state.html | 2 +- .../-back-stack/save-state.html | 2 +- .../-back-stack/size.html | 2 +- .../-back-stack/top-record.html | 2 +- .../-saveable-back-stack/-record/-record.html | 2 +- .../-saveable-back-stack/-record/args.html | 2 +- .../-record/await-result.html | 2 +- .../-saveable-back-stack/-record/index.html | 2 +- .../-saveable-back-stack/-record/key.html | 2 +- .../-saveable-back-stack/-record/screen.html | 2 +- .../-saveable-back-stack.html | 4 +- .../-saveable-back-stack/index.html | 10 +- .../-saveable-back-stack/iterator.html | 2 +- .../-saveable-back-stack/pop.html | 2 +- .../-saveable-back-stack/push.html | 2 +- .../-saveable-back-stack/restore-state.html | 2 +- .../-saveable-back-stack/save-state.html | 2 +- .../-saveable-back-stack/size.html | 2 +- .../-saveable-back-stack/top-record.html | 2 +- .../com.slack.circuit.backstack/index.html | 6 +- .../is-at-root.html | 2 +- .../com.slack.circuit.backstack/is-empty.html | 2 +- .../remember-saveable-back-stack.html | 4 +- api/0.x/backstack/navigation.html | 41 +++-- .../navigation.html | 41 +++-- api/0.x/circuit-codegen/navigation.html | 41 +++-- .../-circuit-content.html | 2 +- .../-circuit/index.html | 2 +- .../-navigator.html | 76 ++++++++ .../com.slack.circuit.foundation/index.html | 17 +- .../remember-circuit-navigator.html | 2 +- .../remember-event-listener.html | 2 +- .../remember-presenter.html | 2 +- .../remember-ui.html | 2 +- api/0.x/circuit-foundation/navigation.html | 41 +++-- api/0.x/circuit-overlay/navigation.html | 41 +++-- api/0.x/circuit-retained/navigation.html | 41 +++-- .../circuit-runtime-presenter/navigation.html | 41 +++-- .../circuit-runtime-screen/navigation.html | 41 +++-- api/0.x/circuit-runtime-ui/navigation.html | 41 +++-- .../-go-to-navigator/go-to.html | 2 +- .../-go-to-navigator/index.html | 2 +- .../-navigator/-no-op/go-to.html | 2 +- .../-navigator/-no-op/index.html | 6 +- .../-navigator/-no-op/peek-back-stack.html | 2 +- .../-navigator/-no-op/peek.html | 2 +- .../-navigator/-no-op/pop.html | 2 +- .../-navigator/-no-op/reset-root.html | 2 +- .../-navigator/go-to.html | 2 +- .../-navigator/index.html | 6 +- .../-navigator/peek-back-stack.html | 2 +- .../-navigator/peek.html | 2 +- .../-navigator/pop.html | 2 +- .../-navigator/reset-root.html | 2 +- .../com.slack.circuit.runtime/pop-until.html | 2 +- .../com.slack.circuit.runtime/reset-root.html | 2 +- api/0.x/circuit-runtime/navigation.html | 41 +++-- .../-fake-navigator/-fake-navigator.html | 4 +- .../-pop-event/-pop-event.html | 76 ++++++++ .../-fake-navigator/-pop-event/index.html | 134 ++++++++++++++ .../-pop-event/popped-screen.html | 76 ++++++++ .../-fake-navigator/-pop-event/result.html | 76 ++++++++ .../-reset-root-event/-reset-root-event.html | 76 ++++++++ .../-reset-root-event/index.html | 164 ++++++++++++++++++ .../new-root.html} | 38 ++-- .../-reset-root-event/old-screens.html | 76 ++++++++ .../-reset-root-event/restore-state.html | 76 ++++++++ .../save-state.html} | 38 ++-- .../-fake-navigator/assert-is-empty.html | 2 +- .../-fake-navigator/await-next-screen.html | 2 +- .../-fake-navigator/await-pop.html | 2 +- .../-fake-navigator/await-reset-root.html | 2 +- .../-fake-navigator/expect-no-events.html | 2 +- .../-fake-navigator/go-to.html | 2 +- .../-fake-navigator/index.html | 64 +++++-- .../-fake-navigator/pop.html | 2 +- .../-fake-navigator/reset-root.html | 2 +- .../-fake-navigator/take-next-screen.html | 2 +- .../com.slack.circuit.test/index.html | 2 +- api/0.x/circuit-test/navigation.html | 41 +++-- api/0.x/circuitx/android/navigation.html | 41 +++-- .../-impression-effect.html | 2 +- .../-launched-impression-effect.html | 2 +- .../remember-impression-navigator.html | 2 +- api/0.x/circuitx/effects/navigation.html | 41 +++-- .../gesture-navigation/navigation.html | 41 +++-- .../show-full-screen-overlay.html | 2 +- api/0.x/circuitx/overlays/navigation.html | 41 +++-- api/0.x/navigation.html | 41 +++-- api/0.x/scripts/pages.json | 2 +- changelog/index.html | 34 ++++ circuitx/index.html | 2 +- navigation/index.html | 4 +- search/search_index.json | 2 +- sitemap.xml.gz | Bin 127 -> 127 bytes testing/index.html | 2 +- tutorial/index.html | 10 +- 105 files changed, 1505 insertions(+), 358 deletions(-) create mode 100644 api/0.x/circuit-foundation/com.slack.circuit.foundation/-navigator.html create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/-pop-event.html create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/index.html create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/popped-screen.html create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/result.html create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/-reset-root-event.html create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/index.html rename api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/{peek.html => -reset-root-event/new-root.html} (58%) create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/old-screens.html create mode 100644 api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/restore-state.html rename api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/{peek-back-stack.html => -reset-root-event/save-state.html} (55%) diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/await-result.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/await-result.html index fd54576d7..8e039909c 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/await-result.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/await-result.html @@ -63,7 +63,7 @@

awaitResult

-
abstract suspend fun awaitResult(key: String): PopResult?(source)

Awaits a PopResult produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.

Parameters

key

The key that was used to tag the result. This ensures that only the caller that requested a result when pushing the previous record can receive it.

+
abstract suspend fun awaitResult(key: String): PopResult?(source)

Awaits a PopResult produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.

Parameters

key

The key that was used to tag the result. This ensures that only the caller that requested a result when pushing the previous record can receive it.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/index.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/index.html index 1c9d9638e..6fb603e00 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/index.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/index.html @@ -62,7 +62,7 @@
backstack/com.slack.circuit.backstack/BackStack/Record

Record

-
@Stable
interface Record(source)

Inheritors

+
@Stable
interface Record(source)

Inheritors

diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/key.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/key.html index 1b108136c..885da1aba 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/key.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/key.html @@ -63,7 +63,7 @@

key

-
abstract val key: String(source)

A value that identifies this record uniquely, even if it shares the same screen with another record. This key may be used by BackStackRecordLocalProviders to associate presentation data with a record across composition recreation.

key MUST NOT change for the life of the record.

+
abstract val key: String(source)

A value that identifies this record uniquely, even if it shares the same screen with another record. This key may be used by BackStackRecordLocalProviders to associate presentation data with a record across composition recreation.

key MUST NOT change for the life of the record.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/screen.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/screen.html index 8eaf6ac2a..b3fa94030 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/screen.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/screen.html @@ -63,7 +63,7 @@

screen

-
abstract val screen: Screen(source)

The Screen that should present this record.

+
abstract val screen: Screen(source)

The Screen that should present this record.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/index.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/index.html index 317df4d0a..bdfa03e09 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/index.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/index.html @@ -62,7 +62,7 @@
backstack/com.slack.circuit.backstack/BackStack

BackStack

-
@Stable
interface BackStack<R : BackStack.Record> : Iterable<R> (source)

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

Inheritors

+
@Stable
interface BackStack<R : BackStack.Record> : Iterable<R> (source)

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

Inheritors

@@ -192,7 +192,7 @@

Functions

-
open fun popUntil(predicate: (R) -> Boolean)

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

+
open fun popUntil(predicate: (R) -> Boolean): ImmutableList<R>

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

diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop-until.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop-until.html index e202edb23..ef99a1d7a 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop-until.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop-until.html @@ -63,7 +63,7 @@

popUntil

-
open fun popUntil(predicate: (R) -> Boolean)(source)

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

+
open fun popUntil(predicate: (R) -> Boolean): ImmutableList<R>(source)

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop.html index 3da9e1aab..f2317733e 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/pop.html @@ -63,7 +63,7 @@

pop

-
abstract fun pop(result: PopResult? = null): R?(source)

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.

Parameters

result

An optional PopResult that will be passed to previous record on the stack after this record is removed.

+
abstract fun pop(result: PopResult? = null): R?(source)

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.

Parameters

result

An optional PopResult that will be passed to previous record on the stack after this record is removed.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/push.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/push.html index e12ff45eb..db5691de9 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/push.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/push.html @@ -63,7 +63,7 @@

push

-
abstract fun push(record: R, resultKey: String? = null)(source)

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

Parameters

record

The record to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

abstract fun push(screen: Screen, resultKey: String? = null)(source)

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.

Parameters

screen

The screen to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

+
abstract fun push(record: R, resultKey: String? = null)(source)

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

Parameters

record

The record to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

abstract fun push(screen: Screen, resultKey: String? = null)(source)

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.

Parameters

screen

The screen to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/restore-state.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/restore-state.html index d366f809c..964b4fdd5 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/restore-state.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/restore-state.html @@ -63,7 +63,7 @@

restoreState

-
abstract fun restoreState(screen: Screen): Boolean(source)

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.

Return

Returns true if there was any back stack state to restore.

Parameters

screen

The root screen which was previously saved using saveState.

+
abstract fun restoreState(screen: Screen): Boolean(source)

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.

Return

Returns true if there was any back stack state to restore.

Parameters

screen

The root screen which was previously saved using saveState.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/save-state.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/save-state.html index 3a38e9d53..621b1aed2 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/save-state.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/save-state.html @@ -63,7 +63,7 @@

saveState

-
abstract fun saveState()(source)

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

This call will overwrite any existing stored state with the same root screen.

+
abstract fun saveState()(source)

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

This call will overwrite any existing stored state with the same root screen.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/size.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/size.html index 070f5c011..5fd1392b5 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/size.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/size.html @@ -63,7 +63,7 @@

size

-
abstract val size: Int(source)

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

+
abstract val size: Int(source)

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/top-record.html b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/top-record.html index bc92a5d8b..9fa1558eb 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/top-record.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-back-stack/top-record.html @@ -63,7 +63,7 @@

topRecord

-
abstract val topRecord: R?(source)

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

+
abstract val topRecord: R?(source)

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/-record.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/-record.html index 9feddd62f..5f20d7481 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/-record.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/-record.html @@ -63,7 +63,7 @@

Record

-
constructor(screen: Screen, args: Map<String, Any?> = emptyMap(), key: String = uuid4().toString())(source)
+
constructor(screen: Screen, args: Map<String, Any?> = emptyMap(), key: String = uuid4().toString())(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/args.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/args.html index 4baaa9c72..d142e8dfc 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/args.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/args.html @@ -63,7 +63,7 @@

args

-
val args: Map<String, Any?>(source)
+
val args: Map<String, Any?>(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/await-result.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/await-result.html index ee794de1c..2f155edf1 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/await-result.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/await-result.html @@ -63,7 +63,7 @@

awaitResult

-
open suspend override fun awaitResult(key: String): PopResult?(source)

Awaits a PopResult produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.

Parameters

key

The key that was used to tag the result. This ensures that only the caller that requested a result when pushing the previous record can receive it.

+
open suspend override fun awaitResult(key: String): PopResult?(source)

Awaits a PopResult produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.

Parameters

key

The key that was used to tag the result. This ensures that only the caller that requested a result when pushing the previous record can receive it.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/index.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/index.html index 595678810..d1aab1afe 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/index.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/index.html @@ -62,7 +62,7 @@
backstack/com.slack.circuit.backstack/SaveableBackStack/Record

Record

-
data class Record(val screen: Screen, val args: Map<String, Any?> = emptyMap(), val key: String = uuid4().toString()) : BackStack.Record(source)
+
data class Record(val screen: Screen, val args: Map<String, Any?> = emptyMap(), val key: String = uuid4().toString()) : BackStack.Record(source)
diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/key.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/key.html index 9fda1b997..181b4f3da 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/key.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/key.html @@ -63,7 +63,7 @@

key

-
open override val key: String(source)

A value that identifies this record uniquely, even if it shares the same screen with another record. This key may be used by BackStackRecordLocalProviders to associate presentation data with a record across composition recreation.

key MUST NOT change for the life of the record.

+
open override val key: String(source)

A value that identifies this record uniquely, even if it shares the same screen with another record. This key may be used by BackStackRecordLocalProviders to associate presentation data with a record across composition recreation.

key MUST NOT change for the life of the record.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/screen.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/screen.html index 22c3cb643..46a774b08 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/screen.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-record/screen.html @@ -63,7 +63,7 @@

screen

-
open override val screen: Screen(source)

The Screen that should present this record.

+
open override val screen: Screen(source)

The Screen that should present this record.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-saveable-back-stack.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-saveable-back-stack.html index c8aa57ba1..8c2e9ff4f 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-saveable-back-stack.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/-saveable-back-stack.html @@ -58,12 +58,12 @@
-
+
backstack/com.slack.circuit.backstack/SaveableBackStack/SaveableBackStack

SaveableBackStack

-
constructor()(source)
+
constructor(initialRecord: SaveableBackStack.Record)(source)
constructor(root: Screen)(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/index.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/index.html index abf243676..a21995711 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/index.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/index.html @@ -62,24 +62,24 @@
backstack/com.slack.circuit.backstack/SaveableBackStack

SaveableBackStack

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

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

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

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

Constructors

-
+
- +
Link copied to clipboard
-
constructor()
+
constructor(initialRecord: SaveableBackStack.Record)
constructor(root: Screen)
@@ -211,7 +211,7 @@

Functions

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

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

+
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.

diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/iterator.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/iterator.html index b1af970cc..6886fc9e4 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/iterator.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/iterator.html @@ -63,7 +63,7 @@

iterator

-
open operator override fun iterator(): Iterator<SaveableBackStack.Record>(source)
+
open operator override fun iterator(): Iterator<SaveableBackStack.Record>(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/pop.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/pop.html index 124a2a5c3..5848d6f81 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/pop.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/pop.html @@ -63,7 +63,7 @@

pop

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

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.

Parameters

result

An optional PopResult that will be passed to previous record on the stack after this record is removed.

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

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.

Parameters

result

An optional PopResult that will be passed to previous record on the stack after this record is removed.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/push.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/push.html index 840bd4b4b..27bed9123 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/push.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/push.html @@ -63,7 +63,7 @@

push

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

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.

Parameters

screen

The screen to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

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

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

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

Parameters

record

The record to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

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

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.

Parameters

screen

The screen to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

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

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

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

Parameters

record

The record to push onto the stack.

resultKey

An optional key that would be used to tag a result produced by this record. The previous record on the stack will receive this key.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/restore-state.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/restore-state.html index fec48b051..14de3af57 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/restore-state.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/restore-state.html @@ -63,7 +63,7 @@

restoreState

-
open override fun restoreState(screen: Screen): Boolean(source)

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.

Return

Returns true if there was any back stack state to restore.

Parameters

screen

The root screen which was previously saved using saveState.

+
open override fun restoreState(screen: Screen): Boolean(source)

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.

Return

Returns true if there was any back stack state to restore.

Parameters

screen

The root screen which was previously saved using saveState.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/save-state.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/save-state.html index eb0fa37e9..4e45bc6bd 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/save-state.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/save-state.html @@ -63,7 +63,7 @@

saveState

-
open override fun saveState()(source)

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

This call will overwrite any existing stored state with the same root screen.

+
open override fun saveState()(source)

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

This call will overwrite any existing stored state with the same root screen.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/size.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/size.html index 6acfaf43e..099a124f2 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/size.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/size.html @@ -63,7 +63,7 @@

size

-
open override val size: Int(source)

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

+
open override val size: Int(source)

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/top-record.html b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/top-record.html index 9723df5fb..6aa96ee5e 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/top-record.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/-saveable-back-stack/top-record.html @@ -63,7 +63,7 @@

topRecord

-
open override val topRecord: SaveableBackStack.Record?(source)

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

+
open override val topRecord: SaveableBackStack.Record?(source)

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/index.html b/api/0.x/backstack/com.slack.circuit.backstack/index.html index 7d2cebadd..6224268a0 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/index.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/index.html @@ -211,17 +211,17 @@

Functions

- +
- +
Link copied to clipboard
-
@Composable
fun rememberSaveableBackStack(init: SaveableBackStack.() -> Unit): SaveableBackStack
+
@Composable
fun rememberSaveableBackStack(initialScreens: List<Screen>): SaveableBackStack

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

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

Creates and remembers a SaveableBackStack with the given root screen.

diff --git a/api/0.x/backstack/com.slack.circuit.backstack/is-at-root.html b/api/0.x/backstack/com.slack.circuit.backstack/is-at-root.html index 8938b7644..53fc9a0a8 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/is-at-root.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/is-at-root.html @@ -63,7 +63,7 @@

isAtRoot

-
val BackStack<out BackStack.Record>.isAtRoot: Boolean(source)

true if the BackStack contains exactly one record.

+
val BackStack<out BackStack.Record>.isAtRoot: Boolean(source)

true if the BackStack contains exactly one record.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/is-empty.html b/api/0.x/backstack/com.slack.circuit.backstack/is-empty.html index be2c81cc6..bdf938d30 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/is-empty.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/is-empty.html @@ -63,7 +63,7 @@

isEmpty

-
val BackStack<out BackStack.Record>.isEmpty: Boolean(source)

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

+
val BackStack<out BackStack.Record>.isEmpty: Boolean(source)

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/com.slack.circuit.backstack/remember-saveable-back-stack.html b/api/0.x/backstack/com.slack.circuit.backstack/remember-saveable-back-stack.html index b5418ecfb..2200a0ef4 100644 --- a/api/0.x/backstack/com.slack.circuit.backstack/remember-saveable-back-stack.html +++ b/api/0.x/backstack/com.slack.circuit.backstack/remember-saveable-back-stack.html @@ -58,12 +58,12 @@
-
+
backstack/com.slack.circuit.backstack/rememberSaveableBackStack

rememberSaveableBackStack

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

Creates and remembers a SaveableBackStack with the given root screen.

Parameters

init

optional initializer callback to perform extra initialization logic.

@Composable
fun rememberSaveableBackStack(initialScreens: List<Screen>): SaveableBackStack(source)

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/backstack/navigation.html b/api/0.x/backstack/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/backstack/navigation.html +++ b/api/0.x/backstack/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-codegen-annotations/navigation.html b/api/0.x/circuit-codegen-annotations/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-codegen-annotations/navigation.html +++ b/api/0.x/circuit-codegen-annotations/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-codegen/navigation.html b/api/0.x/circuit-codegen/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-codegen/navigation.html +++ b/api/0.x/circuit-codegen/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit-content.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit-content.html index c4fd5b763..410e5d8f9 100644 --- a/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit-content.html +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit-content.html @@ -63,7 +63,7 @@

CircuitContent

-
@Composable
fun CircuitContent(screen: Screen, modifier: Modifier = Modifier, circuit: Circuit = requireNotNull(LocalCircuit.current), unavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit = circuit.onUnavailableContent)(source)
@Composable
fun CircuitContent(screen: Screen, modifier: Modifier = Modifier, onNavEvent: (event: NavEvent) -> Unit, circuit: Circuit = requireNotNull(LocalCircuit.current), unavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit = circuit.onUnavailableContent)(source)
@Composable
fun CircuitContent(screen: Screen, navigator: Navigator, modifier: Modifier = Modifier, circuit: Circuit = requireNotNull(LocalCircuit.current), unavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit = circuit.onUnavailableContent)(source)
@Composable
fun <UiState : CircuitUiState> CircuitContent(screen: Screen, modifier: Modifier, presenter: Presenter<UiState>, ui: Ui<UiState>, eventListener: EventListener = EventListener.NONE)(source)
+
@Composable
fun CircuitContent(screen: Screen, modifier: Modifier = Modifier, circuit: Circuit = requireNotNull(LocalCircuit.current), unavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit = circuit.onUnavailableContent)(source)
@Composable
fun CircuitContent(screen: Screen, modifier: Modifier = Modifier, onNavEvent: (event: NavEvent) -> Unit, circuit: Circuit = requireNotNull(LocalCircuit.current), unavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit = circuit.onUnavailableContent)(source)
@Composable
fun CircuitContent(screen: Screen, navigator: Navigator, modifier: Modifier = Modifier, circuit: Circuit = requireNotNull(LocalCircuit.current), unavailableContent: @Composable (screen: Screen, modifier: Modifier) -> Unit = circuit.onUnavailableContent)(source)
@Composable
fun <UiState : CircuitUiState> CircuitContent(screen: Screen, modifier: Modifier, presenter: Presenter<UiState>, ui: Ui<UiState>, eventListener: EventListener = EventListener.NONE)(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit/index.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit/index.html index aed30f31e..1038b417e 100644 --- a/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit/index.html +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/-circuit/index.html @@ -62,7 +62,7 @@
circuit-foundation/com.slack.circuit.foundation/Circuit

Circuit

-
@Immutable
class Circuit(source)

Circuit adapts presenter factories to their corresponding ui factories using screens. Create instances using the Builder and create new CircuitContent with it to run presenter/UI pairings.

Construction

Construction of Circuit instances is done using the Builder.

val circuit = Circuit.Builder()
    .addUiFactory(AddFavoritesUiFactory())
    .addPresenterFactory(AddFavoritesPresenterFactory())
    .build()
Content copied to clipboard

Usage

These instances can then be used with the composable CircuitContent functions to run presenter/UI pairings for individual screens.

Circuit instances are consumed within these composable functions via the CircuitCompositionLocals CompositionLocalProvider.

CircuitCompositionLocals(circuit) {
  CircuitContent(AddFavoritesScreen())
}
Content copied to clipboard

If using navigation, use NavigableCircuitContent instead.

val backStack = rememberSaveableBackStack { push(AddFavoritesScreen()) }
val navigator = rememberCircuitNavigator(backstack, ::onBackPressed)
CircuitCompositionLocals(circuit) {
  NavigableCircuitContent(navigator, backstack)
}
Content copied to clipboard

See also

NavigableCircuitContent

+
@Immutable
class Circuit(source)

Circuit adapts presenter factories to their corresponding ui factories using screens. Create instances using the Builder and create new CircuitContent with it to run presenter/UI pairings.

Construction

Construction of Circuit instances is done using the Builder.

val circuit = Circuit.Builder()
    .addUiFactory(AddFavoritesUiFactory())
    .addPresenterFactory(AddFavoritesPresenterFactory())
    .build()
Content copied to clipboard

Usage

These instances can then be used with the composable CircuitContent functions to run presenter/UI pairings for individual screens.

Circuit instances are consumed within these composable functions via the CircuitCompositionLocals CompositionLocalProvider.

CircuitCompositionLocals(circuit) {
  CircuitContent(AddFavoritesScreen())
}
Content copied to clipboard

If using navigation, use NavigableCircuitContent instead.

val backStack = rememberSaveableBackStack(root = HomeScreen)
val navigator = rememberCircuitNavigator(backstack, ::onBackPressed)
CircuitCompositionLocals(circuit) {
  NavigableCircuitContent(navigator, backstack)
}
Content copied to clipboard

See also

NavigableCircuitContent

diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/-navigator.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/-navigator.html new file mode 100644 index 000000000..5572d02b1 --- /dev/null +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/-navigator.html @@ -0,0 +1,76 @@ + + + + + Navigator + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
circuit-foundation/com.slack.circuit.foundation/Navigator
+
+

Navigator

+
+
fun Navigator(backStack: BackStack<out BackStack.Record>, onRootPop: () -> Unit): Navigator(source)

Creates a new Navigator.

Parameters

backStack

The backing BackStack to navigate.

onRootPop

Invoked when the backstack is at root (size 1) and the user presses the back button.

See also

+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/index.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/index.html index 02de4f113..0dc25793e 100644 --- a/api/0.x/circuit-foundation/com.slack.circuit.foundation/index.html +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/index.html @@ -242,6 +242,21 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Navigator(backStack: BackStack<out BackStack.Record>, onRootPop: () -> Unit): Navigator

Creates a new Navigator.

+
+
+
+
@@ -284,7 +299,7 @@

Functions

-
@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, enableBackHandler: Boolean = true): Navigator

Returns a new Navigator for navigating within CircuitContents. Delegates onRootPop to the LocalOnBackPressedDispatcherOwner.

@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, onRootPop: () -> Unit): Navigator

Returns a new Navigator for navigating within CircuitContents.

+
@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, enableBackHandler: Boolean = true): Navigator

Returns a new Navigator for navigating within CircuitContents. Delegates onRootPop to the LocalOnBackPressedDispatcherOwner.

@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, onRootPop: () -> Unit): Navigator

Creates and remembers a new Navigator for navigating within CircuitContents.

diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-circuit-navigator.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-circuit-navigator.html index 19cf704ef..79792ba3f 100644 --- a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-circuit-navigator.html +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-circuit-navigator.html @@ -66,7 +66,7 @@

rememberCircuit
-
@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, enableBackHandler: Boolean = true): Navigator(source)

Returns a new Navigator for navigating within CircuitContents. Delegates onRootPop to the LocalOnBackPressedDispatcherOwner.

Parameters

backStack

The backing BackStack to navigate.

enableBackHandler

Indicates whether or not Navigator.pop should be called by the system back handler. Defaults to true.

See also

@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, onRootPop: () -> Unit): Navigator(source)

Returns a new Navigator for navigating within CircuitContents.

Parameters

backStack

The backing BackStack to navigate.

onRootPop

Invoked when the backstack is at root (size 1) and the user presses the back button.

See also

+
@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, enableBackHandler: Boolean = true): Navigator(source)

Returns a new Navigator for navigating within CircuitContents. Delegates onRootPop to the LocalOnBackPressedDispatcherOwner.

Parameters

backStack

The backing BackStack to navigate.

enableBackHandler

Indicates whether or not Navigator.pop should be called by the system back handler. Defaults to true.

See also

@Composable
fun rememberCircuitNavigator(backStack: BackStack<out BackStack.Record>, onRootPop: () -> Unit): Navigator(source)

Creates and remembers a new Navigator for navigating within CircuitContents.

Parameters

backStack

The backing BackStack to navigate.

onRootPop

Invoked when the backstack is at root (size 1) and the user presses the back button.

See also

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-event-listener.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-event-listener.html index 1b1580ca0..6b269ac1c 100644 --- a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-event-listener.html +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-event-listener.html @@ -63,7 +63,7 @@

rememberEventListener

-
@Composable
inline fun rememberEventListener(screen: Screen, context: CircuitContext = CircuitContext.EMPTY, startOnInit: Boolean = true, factory: EventListener.Factory? = null): EventListener(source)

Remembers a new EventListener instance for the given screen and context.

Parameters

startOnInit

indicates whether to call EventListener.start automatically after instantiation. True by default.

factory

a factory to create the EventListener.

+
@Composable
inline fun rememberEventListener(screen: Screen, context: CircuitContext = CircuitContext.EMPTY, startOnInit: Boolean = true, factory: EventListener.Factory? = null): EventListener(source)

Remembers a new EventListener instance for the given screen and context.

Parameters

startOnInit

indicates whether to call EventListener.start automatically after instantiation. True by default.

factory

a factory to create the EventListener.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-presenter.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-presenter.html index 2ee9f6bdf..248af236a 100644 --- a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-presenter.html +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-presenter.html @@ -63,7 +63,7 @@

rememberPresenter

-
@Composable
inline fun rememberPresenter(screen: Screen, navigator: Navigator = Navigator.NoOp, context: CircuitContext = CircuitContext.EMPTY, eventListener: EventListener = EventListener.NONE, factory: Presenter.Factory): Presenter<CircuitUiState>?(source)

Remembers a new Presenter instance for the given screen, navigator, context, and eventListener.

Parameters

factory

a factory to create the Presenter.

+
@Composable
inline fun rememberPresenter(screen: Screen, navigator: Navigator = Navigator.NoOp, context: CircuitContext = CircuitContext.EMPTY, eventListener: EventListener = EventListener.NONE, factory: Presenter.Factory): Presenter<CircuitUiState>?(source)

Remembers a new Presenter instance for the given screen, navigator, context, and eventListener.

Parameters

factory

a factory to create the Presenter.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-ui.html b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-ui.html index cec6175d8..dbeff5799 100644 --- a/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-ui.html +++ b/api/0.x/circuit-foundation/com.slack.circuit.foundation/remember-ui.html @@ -63,7 +63,7 @@

rememberUi

-
@Composable
inline fun rememberUi(screen: Screen, context: CircuitContext = CircuitContext.EMPTY, eventListener: EventListener = EventListener.NONE, factory: Ui.Factory): Ui<CircuitUiState>?(source)

Remembers a new Ui instance for the given screen, context, and eventListener.

Parameters

factory

a factory to create the Ui.

+
@Composable
inline fun rememberUi(screen: Screen, context: CircuitContext = CircuitContext.EMPTY, eventListener: EventListener = EventListener.NONE, factory: Ui.Factory): Ui<CircuitUiState>?(source)

Remembers a new Ui instance for the given screen, context, and eventListener.

Parameters

factory

a factory to create the Ui.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-foundation/navigation.html b/api/0.x/circuit-foundation/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-foundation/navigation.html +++ b/api/0.x/circuit-foundation/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-overlay/navigation.html b/api/0.x/circuit-overlay/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-overlay/navigation.html +++ b/api/0.x/circuit-overlay/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-retained/navigation.html b/api/0.x/circuit-retained/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-retained/navigation.html +++ b/api/0.x/circuit-retained/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-runtime-presenter/navigation.html b/api/0.x/circuit-runtime-presenter/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-runtime-presenter/navigation.html +++ b/api/0.x/circuit-runtime-presenter/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-runtime-screen/navigation.html b/api/0.x/circuit-runtime-screen/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-runtime-screen/navigation.html +++ b/api/0.x/circuit-runtime-screen/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-runtime-ui/navigation.html b/api/0.x/circuit-runtime-ui/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-runtime-ui/navigation.html +++ b/api/0.x/circuit-runtime-ui/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/go-to.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/go-to.html index a723b2c3f..cff686eb8 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/go-to.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/go-to.html @@ -63,7 +63,7 @@

goTo

-
abstract fun goTo(screen: Screen)(source)
+
abstract fun goTo(screen: Screen)(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/index.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/index.html index dd83c0384..d3089bda2 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/index.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-go-to-navigator/index.html @@ -62,7 +62,7 @@
circuit-runtime/com.slack.circuit.runtime/GoToNavigator

GoToNavigator

-
@Stable
interface GoToNavigator(source)

A Navigator that only supports goTo.

Inheritors

+
@Stable
interface GoToNavigator(source)

A Navigator that only supports goTo.

Inheritors

diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/go-to.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/go-to.html index 14d571a28..717740490 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/go-to.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/go-to.html @@ -63,7 +63,7 @@

goTo

-
open override fun goTo(screen: Screen)(source)
+
open override fun goTo(screen: Screen)(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/index.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/index.html index 1502b5f36..27708d198 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/index.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/index.html @@ -62,7 +62,7 @@
circuit-runtime/com.slack.circuit.runtime/Navigator/NoOp

NoOp

-
object NoOp : Navigator(source)
+
object NoOp : Navigator(source)
@@ -109,7 +109,7 @@

Functions

-
open override fun peekBackStack(): List<Screen>

Returns the current back stack.

+
open override fun peekBackStack(): ImmutableList<Screen>

Returns the current back stack.

@@ -154,7 +154,7 @@

Functions

-
open override fun resetRoot(newRoot: Screen, saveState: Boolean, restoreState: Boolean): List<Screen>

Clear the existing backstack of screens and navigate to newRoot.

+
open override fun resetRoot(newRoot: Screen, saveState: Boolean, restoreState: Boolean): ImmutableList<Screen>

Clear the existing backstack of screens and navigate to newRoot.

diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek-back-stack.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek-back-stack.html index c35bb78b4..5cba14fa0 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek-back-stack.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek-back-stack.html @@ -63,7 +63,7 @@

peekBackStack

-
open override fun peekBackStack(): List<Screen>(source)

Returns the current back stack.

+
open override fun peekBackStack(): ImmutableList<Screen>(source)

Returns the current back stack.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek.html index 2eecccb6a..93005a018 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/peek.html @@ -63,7 +63,7 @@

peek

-
open override fun peek(): Screen?(source)

Returns current top most screen of backstack, or null if backstack is empty.

+
open override fun peek(): Screen?(source)

Returns current top most screen of backstack, or null if backstack is empty.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/pop.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/pop.html index e9fd4b785..418e7a499 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/pop.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/pop.html @@ -63,7 +63,7 @@

pop

-
open override fun pop(result: PopResult?): Screen?(source)
+
open override fun pop(result: PopResult?): Screen?(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/reset-root.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/reset-root.html index ffd54e2e5..4b56de8e4 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/reset-root.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/-no-op/reset-root.html @@ -63,7 +63,7 @@

resetRoot

-
open override fun resetRoot(newRoot: Screen, saveState: Boolean, restoreState: Boolean): List<Screen>(source)

Clear the existing backstack of screens and navigate to newRoot.

This is useful in preventing the user from returning to a completed workflow, such as a tutorial, wizard, or authentication flow.

Example

val navigator = Navigator()
navigator.push(LoginScreen1)
navigator.push(LoginScreen2)

// Login flow is complete. Wipe backstack and set new root screen
val loginScreens = navigator.resetRoot(HomeScreen)
Content copied to clipboard

Multiple back stacks

The saveState and restoreState parameters enable functionality what is commonly called 'multiple back stacks'. By optionally saving, and later restoring the back stack, you can enable different root screens to have their own back stacks. A common use case is with the bottom navigation bar UX pattern.

navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// User navigates to a details screen
navigator.push(EntityDetails(id = foo))
// Later, user clicks on a bottom navigation item
navigator.resetRoot(HomeNavTab2, saveState = true, restoreState = true)
// Later, user switches back to the first navigation item
navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// The existing back stack is restored, and EntityDetails(id = foo) will be top of
// the back stack
Content copied to clipboard

There are times when saving and restoring the back stack may not be appropriate, so use this feature only when it makes sense. A common example where it probably does not make sense is launching screens which define a UX flow which has a defined completion, such as onboarding.

Parameters

newRoot

The new root Screen

saveState

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

restoreState

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

+
open override fun resetRoot(newRoot: Screen, saveState: Boolean, restoreState: Boolean): ImmutableList<Screen>(source)

Clear the existing backstack of screens and navigate to newRoot.

This is useful in preventing the user from returning to a completed workflow, such as a tutorial, wizard, or authentication flow.

Example

val navigator = Navigator()
navigator.push(LoginScreen1)
navigator.push(LoginScreen2)

// Login flow is complete. Wipe backstack and set new root screen
val loginScreens = navigator.resetRoot(HomeScreen)
Content copied to clipboard

Multiple back stacks

The saveState and restoreState parameters enable functionality what is commonly called 'multiple back stacks'. By optionally saving, and later restoring the back stack, you can enable different root screens to have their own back stacks. A common use case is with the bottom navigation bar UX pattern.

navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// User navigates to a details screen
navigator.push(EntityDetails(id = foo))
// Later, user clicks on a bottom navigation item
navigator.resetRoot(HomeNavTab2, saveState = true, restoreState = true)
// Later, user switches back to the first navigation item
navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// The existing back stack is restored, and EntityDetails(id = foo) will be top of
// the back stack
Content copied to clipboard

There are times when saving and restoring the back stack may not be appropriate, so use this feature only when it makes sense. A common example where it probably does not make sense is launching screens which define a UX flow which has a defined completion, such as onboarding.

Parameters

newRoot

The new root Screen

saveState

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

restoreState

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/go-to.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/go-to.html index 4dac33666..fee3ee1a3 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/go-to.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/go-to.html @@ -63,7 +63,7 @@

goTo

-
abstract override fun goTo(screen: Screen)(source)
+
abstract override fun goTo(screen: Screen)(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/index.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/index.html index 71d331997..9822f6b2d 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/index.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/index.html @@ -62,7 +62,7 @@
circuit-runtime/com.slack.circuit.runtime/Navigator

Navigator

-
@Stable
interface Navigator : GoToNavigator(source)

A basic navigation interface for navigating between screens.

Inheritors

+
@Stable
interface Navigator : GoToNavigator(source)

A basic navigation interface for navigating between screens.

Inheritors

@@ -128,7 +128,7 @@

Functions

-
abstract fun peekBackStack(): List<Screen>

Returns the current back stack.

+
abstract fun peekBackStack(): ImmutableList<Screen>

Returns the current back stack.

@@ -173,7 +173,7 @@

Functions

-
abstract fun resetRoot(newRoot: Screen, saveState: Boolean = false, restoreState: Boolean = false): List<Screen>

Clear the existing backstack of screens and navigate to newRoot.

+
abstract fun resetRoot(newRoot: Screen, saveState: Boolean = false, restoreState: Boolean = false): ImmutableList<Screen>

Clear the existing backstack of screens and navigate to newRoot.

diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek-back-stack.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek-back-stack.html index 42a8ba3a3..f7e897e5f 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek-back-stack.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek-back-stack.html @@ -63,7 +63,7 @@

peekBackStack

-
abstract fun peekBackStack(): List<Screen>(source)

Returns the current back stack.

+
abstract fun peekBackStack(): ImmutableList<Screen>(source)

Returns the current back stack.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek.html index 227e40fc2..52d47dde4 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/peek.html @@ -63,7 +63,7 @@

peek

-
abstract fun peek(): Screen?(source)

Returns current top most screen of backstack, or null if backstack is empty.

+
abstract fun peek(): Screen?(source)

Returns current top most screen of backstack, or null if backstack is empty.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/pop.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/pop.html index f1d043666..086abef1a 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/pop.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/pop.html @@ -63,7 +63,7 @@

pop

-
abstract fun pop(result: PopResult? = null): Screen?(source)
+
abstract fun pop(result: PopResult? = null): Screen?(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/reset-root.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/reset-root.html index 03950892d..962dc3568 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/reset-root.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/-navigator/reset-root.html @@ -63,7 +63,7 @@

resetRoot

-
abstract fun resetRoot(newRoot: Screen, saveState: Boolean = false, restoreState: Boolean = false): List<Screen>(source)

Clear the existing backstack of screens and navigate to newRoot.

This is useful in preventing the user from returning to a completed workflow, such as a tutorial, wizard, or authentication flow.

Example

val navigator = Navigator()
navigator.push(LoginScreen1)
navigator.push(LoginScreen2)

// Login flow is complete. Wipe backstack and set new root screen
val loginScreens = navigator.resetRoot(HomeScreen)
Content copied to clipboard

Multiple back stacks

The saveState and restoreState parameters enable functionality what is commonly called 'multiple back stacks'. By optionally saving, and later restoring the back stack, you can enable different root screens to have their own back stacks. A common use case is with the bottom navigation bar UX pattern.

navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// User navigates to a details screen
navigator.push(EntityDetails(id = foo))
// Later, user clicks on a bottom navigation item
navigator.resetRoot(HomeNavTab2, saveState = true, restoreState = true)
// Later, user switches back to the first navigation item
navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// The existing back stack is restored, and EntityDetails(id = foo) will be top of
// the back stack
Content copied to clipboard

There are times when saving and restoring the back stack may not be appropriate, so use this feature only when it makes sense. A common example where it probably does not make sense is launching screens which define a UX flow which has a defined completion, such as onboarding.

Parameters

newRoot

The new root Screen

saveState

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

restoreState

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

+
abstract fun resetRoot(newRoot: Screen, saveState: Boolean = false, restoreState: Boolean = false): ImmutableList<Screen>(source)

Clear the existing backstack of screens and navigate to newRoot.

This is useful in preventing the user from returning to a completed workflow, such as a tutorial, wizard, or authentication flow.

Example

val navigator = Navigator()
navigator.push(LoginScreen1)
navigator.push(LoginScreen2)

// Login flow is complete. Wipe backstack and set new root screen
val loginScreens = navigator.resetRoot(HomeScreen)
Content copied to clipboard

Multiple back stacks

The saveState and restoreState parameters enable functionality what is commonly called 'multiple back stacks'. By optionally saving, and later restoring the back stack, you can enable different root screens to have their own back stacks. A common use case is with the bottom navigation bar UX pattern.

navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// User navigates to a details screen
navigator.push(EntityDetails(id = foo))
// Later, user clicks on a bottom navigation item
navigator.resetRoot(HomeNavTab2, saveState = true, restoreState = true)
// Later, user switches back to the first navigation item
navigator.resetRoot(HomeNavTab1, saveState = true, restoreState = true)
// The existing back stack is restored, and EntityDetails(id = foo) will be top of
// the back stack
Content copied to clipboard

There are times when saving and restoring the back stack may not be appropriate, so use this feature only when it makes sense. A common example where it probably does not make sense is launching screens which define a UX flow which has a defined completion, such as onboarding.

Parameters

newRoot

The new root Screen

saveState

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

restoreState

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

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/pop-until.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/pop-until.html index 24724a373..4d2e77e0a 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/pop-until.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/pop-until.html @@ -63,7 +63,7 @@

popUntil

-
fun Navigator.popUntil(predicate: (Screen) -> Boolean)(source)

Calls Navigator.pop until the given predicate is matched or it pops the root.

+
fun Navigator.popUntil(predicate: (Screen) -> Boolean)(source)

Calls Navigator.pop until the given predicate is matched or it pops the root.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/com.slack.circuit.runtime/reset-root.html b/api/0.x/circuit-runtime/com.slack.circuit.runtime/reset-root.html index 823c4a7f9..6a2ebcffd 100644 --- a/api/0.x/circuit-runtime/com.slack.circuit.runtime/reset-root.html +++ b/api/0.x/circuit-runtime/com.slack.circuit.runtime/reset-root.html @@ -63,7 +63,7 @@

resetRoot

-
inline fun Navigator.resetRoot(newRoot: Screen, saveState: (currentRoot: Screen?) -> Boolean = { false }, restoreState: (currentRoot: Screen?) -> Boolean = { false }): List<Screen>(source)

Clear the existing backstack of screens and navigate to newRoot.

This is useful in preventing the user from returning to a completed workflow, such as a tutorial, wizard, or authentication flow.

This version of the function provides easy to lambdas for saveState and restoreState allowing computation of the values based on the current root screen.

+
inline fun Navigator.resetRoot(newRoot: Screen, saveState: (currentRoot: Screen?) -> Boolean = { false }, restoreState: (currentRoot: Screen?) -> Boolean = { false }): List<Screen>(source)

Clear the existing backstack of screens and navigate to newRoot.

This is useful in preventing the user from returning to a completed workflow, such as a tutorial, wizard, or authentication flow.

This version of the function provides easy to lambdas for saveState and restoreState allowing computation of the values based on the current root screen.

© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-runtime/navigation.html b/api/0.x/circuit-runtime/navigation.html index 2469c2135..75bbc4114 100644 --- a/api/0.x/circuit-runtime/navigation.html +++ b/api/0.x/circuit-runtime/navigation.html @@ -47,7 +47,7 @@ providedValuesForBackStack()
- -
+
- NavigatorDefaults + Navigator()
-
+
+
+
+ NavigatorDefaults +
+ - -
+ -
+ -
+ -
+ -
+ -
+ -
+
rememberUi()
@@ -574,7 +579,17 @@
diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-fake-navigator.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-fake-navigator.html index 1310a3faf..13d2f86c5 100644 --- a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-fake-navigator.html +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-fake-navigator.html @@ -58,12 +58,12 @@
-
+
circuit-test/com.slack.circuit.test/FakeNavigator/FakeNavigator

FakeNavigator

-
constructor(initialScreen: Screen? = null)(source)
+
constructor(backStack: BackStack<out BackStack.Record>)(source)
constructor(root: Screen)(source)
© 2024 CopyrightGenerated by dokka diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/-pop-event.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/-pop-event.html new file mode 100644 index 000000000..15e2b3198 --- /dev/null +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/-pop-event.html @@ -0,0 +1,76 @@ + + + + + PopEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
circuit-test/com.slack.circuit.test/FakeNavigator/PopEvent/PopEvent
+
+

PopEvent

+
+
constructor(poppedScreen: Screen?, result: PopResult? = null)(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/index.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/index.html new file mode 100644 index 000000000..dec1f973c --- /dev/null +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/index.html @@ -0,0 +1,134 @@ + + + + + PopEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
circuit-test/com.slack.circuit.test/FakeNavigator/PopEvent
+
+

PopEvent

+
data class PopEvent(val poppedScreen: Screen?, val result: PopResult? = null)(source)

Represents a recorded Navigator.pop event.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(poppedScreen: Screen?, result: PopResult? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val poppedScreen: Screen?
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val result: PopResult? = null
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/popped-screen.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/popped-screen.html new file mode 100644 index 000000000..c779e5d91 --- /dev/null +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/popped-screen.html @@ -0,0 +1,76 @@ + + + + + poppedScreen + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
circuit-test/com.slack.circuit.test/FakeNavigator/PopEvent/poppedScreen
+
+

poppedScreen

+
+
val poppedScreen: Screen?(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/result.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/result.html new file mode 100644 index 000000000..0988119a1 --- /dev/null +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-pop-event/result.html @@ -0,0 +1,76 @@ + + + + + result + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
circuit-test/com.slack.circuit.test/FakeNavigator/PopEvent/result
+
+

result

+
+
val result: PopResult? = null(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/-reset-root-event.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/-reset-root-event.html new file mode 100644 index 000000000..c8c2353b0 --- /dev/null +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/-reset-root-event.html @@ -0,0 +1,76 @@ + + + + + ResetRootEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
circuit-test/com.slack.circuit.test/FakeNavigator/ResetRootEvent/ResetRootEvent
+
+

ResetRootEvent

+
+
constructor(newRoot: Screen, oldScreens: ImmutableList<Screen>, saveState: Boolean = false, restoreState: Boolean = false)(source)
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/index.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/index.html new file mode 100644 index 000000000..39b1ab4b8 --- /dev/null +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/index.html @@ -0,0 +1,164 @@ + + + + + ResetRootEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
circuit-test/com.slack.circuit.test/FakeNavigator/ResetRootEvent
+
+

ResetRootEvent

+
data class ResetRootEvent(val newRoot: Screen, val oldScreens: ImmutableList<Screen>, val saveState: Boolean = false, val restoreState: Boolean = false)(source)

Represents a recorded Navigator.resetRoot event.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(newRoot: Screen, oldScreens: ImmutableList<Screen>, saveState: Boolean = false, restoreState: Boolean = false)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val newRoot: Screen
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val oldScreens: ImmutableList<Screen>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val restoreState: Boolean = false
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val saveState: Boolean = false
+
+
+
+
+
+
+
+
+
+
+ © 2024 CopyrightGenerated by dokka +
+
+
+
+ + + diff --git a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/peek.html b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/new-root.html similarity index 58% rename from api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/peek.html rename to api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/new-root.html index 43573e670..b82655533 100644 --- a/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/peek.html +++ b/api/0.x/circuit-test/com.slack.circuit.test/-fake-navigator/-reset-root-event/new-root.html @@ -2,8 +2,8 @@ - peek - + newRoot + - - - - - - - - - - - - + + + + + + + + + + + +