Deployed 5db6343 with MkDocs version: 1.6.0

api/0.x/circuit-foundation/com.slack.circuit.foundation/-non-pausable-presenter/index.html

@@ -62,7 +62,7 @@
   <div class="breadcrumbs"><a href="../../index.html">circuit-foundation</a><span class="delimiter">/</span><a href="../index.html">com.slack.circuit.foundation</a><span class="delimiter">/</span><span class="current">NonPausablePresenter</span></div>
   <div class="cover ">
     <h1 class="cover"><span>Non</span><wbr><span>Pausable</span><wbr><span><span>Presenter</span></span></h1>
-    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":circuit-foundation: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">NonPausablePresenter</a><span class="token operator">&lt;</span><a href="index.html">UiState</a><span class="token operator"> : </span><a href="../../../circuit-runtime/com.slack.circuit.runtime/-circuit-ui-state/index.html">CircuitUiState</a><span class="token operator">&gt;</span> : <a href="../../../circuit-runtime-presenter/com.slack.circuit.runtime.presenter/-presenter/index.html">Presenter</a><span class="token operator">&lt;</span><a href="index.html">UiState</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/circuit-foundation/src/commonMain/kotlin/com/slack/circuit/foundation/PausableState.kt#L24">source</a>)</span></span></div><p class="paragraph">By default <a href="../-circuit-content.html">CircuitContent</a> will wrap presenters so that the last emitted <a href="../../../circuit-runtime/com.slack.circuit.runtime/-circuit-ui-state/index.html">CircuitUiState</a> is replayed when the presenter is paused. If this behavior is not wanted, the <a href="../../../circuit-runtime-presenter/com.slack.circuit.runtime.presenter/-presenter/index.html">Presenter</a> should implement this interface to disable the behavior.</p></div></div>
+    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":circuit-foundation: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">NonPausablePresenter</a><span class="token operator">&lt;</span><a href="index.html">UiState</a><span class="token operator"> : </span><a href="../../../circuit-runtime/com.slack.circuit.runtime/-circuit-ui-state/index.html">CircuitUiState</a><span class="token operator">&gt;</span> : <a href="../../../circuit-runtime-presenter/com.slack.circuit.runtime.presenter/-presenter/index.html">Presenter</a><span class="token operator">&lt;</span><a href="index.html">UiState</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/circuit-foundation/src/commonMain/kotlin/com/slack/circuit/foundation/PausableState.kt#L22">source</a>)</span></span></div><p class="paragraph">By default <a href="../-circuit-content.html">CircuitContent</a> will wrap presenters so that the last emitted <a href="../../../circuit-runtime/com.slack.circuit.runtime/-circuit-ui-state/index.html">CircuitUiState</a> is replayed when the presenter is paused. If this behavior is not wanted, the <a href="../../../circuit-runtime-presenter/com.slack.circuit.runtime.presenter/-presenter/index.html">Presenter</a> should implement this interface to disable the behavior.</p></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><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members &amp; Extensions</button></div>

api/0.x/circuit-foundation/com.slack.circuit.foundation/pausable-state.html

@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span>pausable</span><wbr><span><span>State</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":circuit-foundation: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/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="pausable-state.html">T</a><span class="token operator">&gt; </span><a href="pausable-state.html"><span class="token function">pausableState</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 class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">isActive<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span>LocalRecordLifecycle.current.isActive<span class="token punctuation">, </span></span><span class="parameter ">produceState<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a>&nbsp;</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="pausable-state.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="pausable-state.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/circuit-foundation/src/commonMain/kotlin/com/slack/circuit/foundation/PausableState.kt#L54">source</a>)</span></span></div><p class="paragraph">Wraps a composable state producer, which will replay the last emitted state instance when <a href="pausable-state.html">isActive</a> is <code class="lang-kotlin">false</code>.</p><p class="paragraph">The class <a href="pausable-state.html">T</a> returned from <a href="pausable-state.html">produceState</a> is required to implement <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/index.html">equals</a> and <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/index.html">hashCode</a> methods correctly, otherwise this function can create composition loops.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":circuit-foundation:dokkaHtmlPartial/commonMain" data-filterable-set=":circuit-foundation: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">A unique key for the pausable state.</p></div></div></div></div><div class="table-row" data-filterable-current=":circuit-foundation:dokkaHtmlPartial/commonMain" data-filterable-set=":circuit-foundation:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span><span>Active</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Whether the state producer should be active or not.</p></div></div></div></div><div class="table-row" data-filterable-current=":circuit-foundation:dokkaHtmlPartial/commonMain" data-filterable-set=":circuit-foundation:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>produce</span><wbr><span><span>State</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A composable lambda function which produces the state</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=":circuit-foundation: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/Composable.html"><span class="token annotation builtin">Composable</span></a></div></div><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="pausable-state.html">T</a><span class="token operator">&gt; </span><a href="pausable-state.html"><span class="token function">pausableState</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 class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">isActive<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span>LocalRecordLifecycle.current.isActive<span class="token punctuation">, </span></span><span class="parameter ">produceState<span class="token operator">: </span><span><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html"><span class="token annotation builtin">Composable</span></a>&nbsp;</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="pausable-state.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="pausable-state.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/circuit-foundation/src/commonMain/kotlin/com/slack/circuit/foundation/PausableState.kt#L52">source</a>)</span></span></div><p class="paragraph">Wraps a composable state producer, which will replay the last emitted state instance when <a href="pausable-state.html">isActive</a> is <code class="lang-kotlin">false</code>.</p><p class="paragraph">The class <a href="pausable-state.html">T</a> returned from <a href="pausable-state.html">produceState</a> is required to implement <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/index.html">equals</a> and <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/index.html">hashCode</a> methods correctly, otherwise this function can create composition loops.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":circuit-foundation:dokkaHtmlPartial/commonMain" data-filterable-set=":circuit-foundation: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">A unique key for the pausable state.</p></div></div></div></div><div class="table-row" data-filterable-current=":circuit-foundation:dokkaHtmlPartial/commonMain" data-filterable-set=":circuit-foundation:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>is</span><wbr><span><span>Active</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Whether the state producer should be active or not.</p></div></div></div></div><div class="table-row" data-filterable-current=":circuit-foundation:dokkaHtmlPartial/commonMain" data-filterable-set=":circuit-foundation:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>produce</span><wbr><span><span>State</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A composable lambda function which produces the state</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>