Deployed 9a0b6e0 with MkDocs version: 1.6.0

404.html

@@ -16,15 +16,15 @@
 
 
       <link rel="icon" href="/images/slack_logo_small.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.9">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.24">
 
 
 
         <title>Circuit</title>
 
 
 
-      <link rel="stylesheet" href="/assets/stylesheets/main.f2e4d321.min.css">
+      <link rel="stylesheet" href="/assets/stylesheets/main.6543a935.min.css">
 
 
         <link rel="stylesheet" href="/assets/stylesheets/palette.06af60db.min.css">
@@ -184,7 +184,7 @@
         <a href="https://github.com/slackhq/circuit" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
     Circuit
@@ -229,7 +229,7 @@
       <a href="https://github.com/slackhq/circuit" title="Go to repository" class="md-source" data-md-component="source">
   <div class="md-source__icon md-icon">
 
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
   </div>
   <div class="md-source__repository">
     Circuit
@@ -709,7 +709,7 @@ <h1>404 - Not found</h1>
     <script id="__config" type="application/json">{"base": "/", "features": ["content.code.copy", "content.code.select"], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="/assets/javascripts/bundle.8fd75fb4.min.js"></script>
+      <script src="/assets/javascripts/bundle.081f42fc.min.js"></script>
 
 
   </body>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack-record-local-provider/index.html

@@ -62,7 +62,7 @@
   <div class="breadcrumbs"><a href="../../index.html">backstack</a><span class="delimiter">/</span><a href="../index.html">com.slack.circuit.backstack</a><span class="delimiter">/</span><span class="current">BackStackRecordLocalProvider</span></div>
   <div class="cover ">
     <h1 class="cover"><span>Back</span><wbr><span>Stack</span><wbr><span>Record</span><wbr><span>Local</span><wbr><span><span>Provider</span></span></h1>
-    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token keyword">interface </span><a href="index.html">BackStackRecordLocalProvider</a><span class="token operator">&lt;</span><span class="token keyword">in </span><a href="index.html">R</a><span class="token operator"> : </span><a href="../-back-stack/-record/index.html">BackStack.Record</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStackRecordLocalProvider.kt#L27">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-saveable-state-registry-back-stack-record-local-provider/index.html">SaveableStateRegistryBackStackRecordLocalProvider</a></div></span></div><div></div></div></div></div></div></div>
+    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token keyword">interface </span><a href="index.html">BackStackRecordLocalProvider</a><span class="token operator">&lt;</span><span class="token keyword">in </span><a href="index.html">R</a><span class="token operator"> : </span><a href="../-back-stack/-record/index.html">BackStack.Record</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStackRecordLocalProvider.kt#L27">source</a>)</span></span></div></div></div>
   </div>
   <div class="tabbedcontent">
     <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/await-result.html

@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span>await</span><wbr><span><span>Result</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="await-result.html"><span class="token function">awaitResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L125">source</a>)</span></span></div><p class="paragraph">Awaits a <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a> produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>key</span></span></u></div></span></div><div><div class="title"><p class="paragraph">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.</p></div></div></div></div></div></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="await-result.html"><span class="token function">awaitResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L127">source</a>)</span></span></div><p class="paragraph">Awaits a <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a> produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>key</span></span></u></div></span></div><div><div class="title"><p class="paragraph">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.</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/index.html

@@ -62,7 +62,7 @@
   <div class="breadcrumbs"><a href="../../../index.html">backstack</a><span class="delimiter">/</span><a href="../../index.html">com.slack.circuit.backstack</a><span class="delimiter">/</span><a href="../index.html">BackStack</a><span class="delimiter">/</span><span class="current">Record</span></div>
   <div class="cover ">
     <h1 class="cover"><span><span>Record</span></span></h1>
-    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span class="token annotation builtin">Stable</span></a></div></div><span class="token keyword">interface </span><a href="index.html">Record</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L105">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-saveable-back-stack/-record/index.html">Record</a></div></span></div><div></div></div></div></div></div></div>
+    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span class="token annotation builtin">Stable</span></a></div></div><span class="token keyword">interface </span><a href="index.html">Record</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L107">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-saveable-back-stack/-record/index.html">Record</a></div></span></div><div></div></div></div></div></div></div>
   </div>
   <div class="tabbedcontent">
     <div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/key.html

@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span><span>key</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="key.html">key</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L113">source</a>)</span></span></div><p class="paragraph">A value that identifies this record uniquely, even if it shares the same <a href="screen.html">screen</a> with another record. This key may be used by <a href="../../-back-stack-record-local-provider/index.html">BackStackRecordLocalProvider</a>s to associate presentation data with a record across composition recreation.</p><p class="paragraph"><a href="key.html">key</a> MUST NOT change for the life of the record.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="key.html">key</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L115">source</a>)</span></span></div><p class="paragraph">A value that identifies this record uniquely, even if it shares the same <a href="screen.html">screen</a> with another record. This key may be used by <a href="../../-back-stack-record-local-provider/index.html">BackStackRecordLocalProvider</a>s to associate presentation data with a record across composition recreation.</p><p class="paragraph"><a href="key.html">key</a> MUST NOT change for the life of the record.</p></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/screen.html

@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span><span>screen</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="screen.html">screen</a><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L116">source</a>)</span></span></div><p class="paragraph">The <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a> that should present this record.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">val </span><a href="screen.html">screen</a><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L118">source</a>)</span></span></div><p class="paragraph">The <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a> that should present this record.</p></div></div>
 </div>
       <div class="footer">
         <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>