Update circuit to v0.32.0

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
com.slack.circuit:circuitx-gesture-navigation	0.20.0 → 0.32.0
com.slack.circuit:circuit-retained	0.20.0 → 0.32.0
com.slack.circuit:circuit-runtime	0.20.0 → 0.32.0
com.slack.circuit:circuit-overlay	0.20.0 → 0.32.0
com.slack.circuit:circuit-foundation	0.20.0 → 0.32.0

---

Release Notes

slackhq/circuit (com.slack.circuit:circuitx-gesture-navigation)

v0.32.0

Compare Source

2026-01-13

Enhancements

• New produceAndCollectAsRetainedState that produces and collects values from a Flow.

Changes

• Update to Kotlin 2.3.0.
• Update Compose Multiplatform to 1.10.0.
• Circuits BackHandler uses now depend on org.jetbrains.androidx.navigationevent.

Code-gen

• Generate @Origin annotations for kotlin-inject-anvil and Metro code gen.
• Switch to jakarta.inject types for Dagger/Anvil code gen. This should have no source-breaking changes to users since this only affected generated code, but note that the square/anvil implementation may not support this in factory generation (the KSP fork does). If you need to only use javax annotations, use the circuit.codegen.useJavaxOnly=true KSP option.
• Drop KSP1 support.
• Fix not using named parameters with the kotlin-inject Anvil codegen mode.

Contributors

Special thanks to the following contributors for contributing to this release!

• @​amirroid
• @​evanisnor
• @​hossain-khan

v0.31.0

Compare Source

2025-11-04

Breaking Changes:

Remove kotlinx-immutable dependency. With Compose's strong skipping mode, we no longer feel this is necessary.

Result delivery is now handled by NavigableCircuitContent via an internal AnsweringResultNavigator wrapper, and result
handling APIs have been removed from BackStack and SaveableBackStack as this is now purely a navigation concern. This
separates result handling concerns from the backstack implementation and provides better encapsulation.

The callback block in rememberAnsweringNavigator is no longer suspendable as it was never intended for any long running operations.

Behaviour Changes:

On iOS GestureNavigationDecorationFactory now uses IOSPredictiveBackNavDecorator instead of CupertinoGestureNavigationDecorator.
This new decorator uses the Compose multiplatform PredictiveBackHandler to drive the back animation, instead of a swipeable gesture or nested scroll.

The Navigator.resetRoot API is now using a StateOptions class to allow saving, restoring, and
clearing of back stack state. The previous resetRoot function with saveState and restoreState booleans is available as an extension function.

Misc:

• Switched Compose uses to depend on Compose Multiplatform over Jetpack Compose
• Android minimum SDK is now minSdk 23
• Added saved state peek/remove to Backstack
• Fixed Navigator.onNavEvent() not passing all arguments to resetRoot()
• Fixes to rememberCircuitNavigator() capturing onRootPop and not recreating if a new backstack was provided
• Update Compose Multiplatform to 1.9.2.
• Update to Kotlin 2.2.21.
• Update to Molecule 2.2.0.
• Build against KSP 2.2.20-2.0.4.

Special thanks to @​simon-duchastel and @​eboudrant for contributing to this release!

v0.30.0

Compare Source

2025-08-01

Behaviour Changes:

Rebuilt continuityRetainedStateRegistry as a common lifecycleRetainedStateRegistry and made ViewModel an implementation detail of it.

AnimatedNavDecoration is now using the full back stack to determine the transition animation.

Updates to ViewModelBackStackRecordLocalProvider

ViewModelBackStackRecordLocalProvider has moved from the backstack module to the
circuit-foundation module while also changing to use the multiplatform ViewModel implementation.
ViewModelBackStackRecordLocalProvider is now provided as a default through the Circuit instance,
enabling customization of the default BackStackRecordLocalProviders.
Also added backStackHostViewModel() to access a ViewModel located in the ViewModelStoreOwner of NavigableCircuitContent.

Misc:

• [gesture-navigation] Fix a crash when using AndroidPredictiveBackNavDecorator and having previously called resetRoot() with restoreState=false.
• [code gen] Added support for CircuitContext as an assisted param in code gen
• Update dagger to v2.57.
• Update Compose Android BOM to 2025.07.00.
• Update androidx.lifecycle to 2.9.2.

Special thanks to @​CamiloVega and @​kvaster for contributing to this release!

v0.29.1

Compare Source

2025-06-30

• Fix @AssistedFactory code gen for Metro to use standard nested class semantics.

v0.29.0

Compare Source

2025-06-26

• Update to Kotlin 2.2.0.
• Update to KSP 2.2.0-2.0.2.
• Support @AssistedFactory in code gen for Metro.
• Add seekable transition support to AnimatedOverlay.
• Add predictive back support to FullScreenOverlay.
• Compile against Android SDK 36.

v0.28.1

Compare Source

2025-06-09

Behaviour Changes:

Replacing rememberContinuityCanRetainChecker() with CanRetainChecker.Always, which changes the
Android rememberRetained behaviour to retain based on the ViewModel lifecycle. This should fix
rememberRetained not functioning as expected when used in a fragment. Previously rememberRetained
would only retain if the Activity was in a configuration change.

Misc:

• Update to Kotlin 2.1.21.
• Build against KSP 2.1.21-2.0.1.
• Fix not being able to provide a custom ViewModel to continuityRetainedStateRegistry()
• Fix rememberCircuitNavigator and rememberInterceptingNavigator replaying a root pop at the same screen
• Update Compose Android BOM to 2025.06.00.
• Update Compose Android to 1.8.2.
• Update to Compose Multiplatform to 1.8.1.
• Update androidx.lifecycle to 2.9.1

v0.28.0

Compare Source

2025-05-12

New: circuitx-navigation adding navigation interception capabilities:

We've added a new navigation intercepting system to Circuit that lets you hook into and modify
navigation before it happens. The InterceptingNavigator sits before a regular Circuit Navigator,
giving you a chance to inspect or change navigation events. With the NavigationInterceptor
interface, you can handle goTo, pop, and resetRoot calls and decide if they should proceed,
fail, be skipped, or be rewritten to navigate somewhere else. There's also aNavigationEventListener
if you just want to know when navigation happens without changing it.
This new system is handy for advanced routing, blocking navigation, or tracking navigation events
for analytics.

dependencies {
  implementation("com.slack.circuit:circuitx-navigation:<version>")
}

Docs: https://slackhq.github.io/circuit/circuitx/navigation

Misc:

• Fix the provided Modifier not being used in NavigatorDefaults.EmptyDecoration
• Fix rememberCircuitNavigator() not being able to propagate the root pop as its BackHandler was still active
• Added a common rememberCircuitNavigator() that uses a BackHandler to trigger Navigator.pop calls
• [docs] Add more alternative state designs.
• Update Compose Android BOM to 2025.05.00.
• Update Compose Android to 1.8.1.
• Update to Compose Multiplatform to 1.8.0.
• Change the published jvmTarget to 11
• Update molecule to 2.1.0

v0.27.1

Compare Source

2025-04-14

• Fix: Crash caused by calling resetRoot while the same Screen was still in the composition
• New: Added a sample app demonstrating bottom bar navigation
• [gesture-navigation] Update AndroidPredictiveBackNavDecorator to behave more like the Android predictive back motion spec
• [gesture-navigation] Change the Compose Material dependency to not be exposed as an api
• Update compose-bom to 2025.04.00
• Update dagger to 2.56.1
• Update kotlinInject.anvil to 0.1.3
• Update kotlinx-coroutines to 1.10.2
• Update androidx.core to 1.16.0
• [samples] Update mosaic to 0.17.0

Special thanks to @​OSemenovBoyarka and @​asapha for contributing to this release!

v0.27.0

Compare Source

2025-02-28

Screen based animation overrides

We have added experimental support for animations based on the source/target screens and the type of navigation event. This can be accomplished with the the new AnimatedScreenTransform interface, allowing customization of the ContentTransform used when transitioning between screens. Having support for screen based animation overrides is especially important for use with shared element transitions, as it provides the ability to replace the transition before the shared elements are loaded.

See this PR for more details and example implementations. Please share feedback in this discussion.

Behaviour Changes:

State retention logic was simplified by removing LocalCanRetainChecker, with CanRetainChecker becoming an implementation detail of a RetainedStateRegistry.
This potentially impacts uses of rememberRetained that depended on LocalCanRetainChecker, as rememberRetained would use the composition local before using rememberCanRetainChecker. Also, as rememberCanRetainChecker was only needed for Continuity it has been renamed to rememberContinuityCanRetainChecker.

Misc:

• Fix a crash caused by calling resetRoot while NavigableCircuitContent was animating.
• Update androidx.activity to v1.10.1.
• [code gen] Make assisted injection detection more robust.
• [code gen] Update to KSP 2.1.10-1.0.31.
• [code gen] Update to KotlinPoet 2.1.0.
• [samples] Update mosaic to 0.16.0
• [samples] Include shared element tutorial changes.

Special thanks to @​vulpeszerda for contributing to this release!

v0.26.1

Compare Source

2025-02-13

• Fix crash on right side back gesture.
• Update CupertinoGestureNavigationDecoration to be a AnimatedNavDecorator.
• Fix value restoration after removeState call in RetainedStateHolder.
• Update Android compose artifacts to 1.7.8.
• [docs] Add tutorial for how to use Circuit shared elements.
• [docs] Added basic reference guide on deep-linking using circuit for Android platform.

Special thanks to @​vulpeszerda for contributing to this release!

v0.26.0

Compare Source

2025-02-06

Happy new year!

Shared Elements API!

After a lot of iteration and work, this release adds support for Compose's new shared elements APIs.

These are still experimental and subject to change, both in Circuit and the underlying Compose APIs.

See this PR for full details as well as sample integrations: #​1550. Please share feedback in this discussion. More formal docs to come as well, we'll publish updates there!

For now, the easiest way to support shared element transitions is to wrap your content with a SharedElementTransitionLayout.

CircuitCompositionLocals(circuit) {
  SharedElementTransitionLayout {
    NavigableCircuitContent(
      navigator = navigator,
      backStack = backStack,
    )
  }
}

SharedElementTransitionLayout creates and provides a SharedElementTransitionScope to content within it, and in turn exposes a SharedTransitionScope for use with standard compose shared elements/bounds animations. This is supported in NavigableCircuitContent and overlays.

There is also a PreviewSharedElementTransitionLayout for help with Compose previews.

Behaviour Changes: rememberRetained

Previously, rememberRetained could sometimes restore values when a composable was re-added, depending on whether its parent RetainedStateRegistry had been saved (#​1783).
Now, rememberRetained aligns with remember and rememberSaveable: if a composable is removed and later re-added, its value will not be restored unless it is explicitly saved and then restored via the registry.

Update rememberRetained to allow CanRetainChecker to be updated in place.

Behaviour Change: RetainedStateRegistry

• saveAll now returns the saved values.
• RetainedStateRegistry.Entry.unregister now returns whether the unsaved valueProvider was actually removed.
• saveAll and saveValue now skip storing child values when CanRetainChecker returns false.

New: RetainedStateHolder

Similar to SaveableStateHolder, RetainedStateHolder provides a mechanism to maintain separate RetainedStateRegistry entries for specific keys. This allows saving the state defined with rememberRetained for a subtree before it is disposed, so that the subtree can later be recomposed with its state restored.

val retainedStateHolder = rememberRetainedStateHolder()
var currentTab by remember { mutableStateOf(TabA) }

retainedStateHolder.RetainedStateProvider(key = currentTab.name) {
  // rememberRetained values in tab content are preserved across tab switches
  when (currentTab) {
    TabA -> {
      TabAContent()
    }
    TabB -> {
      TabBContent()
    }
    TabC -> {
      TabCContent()
    }
  }
}

Implementation Changes: NavigableCircuitContent

• The approach of managing a separate RetainedStateRegistry for each record has been changed to use RetainedStateHolder instead.
• Change SaveableStateHolder to release saved states of removed records.

Misc

• Fixe an issue causing codegen to fail for class @​Inject annotations.
• Compile against Android SDK 35.
• Update Compose Android BOM to 2025.01.01.
• Update to androidx.annotation 1.9.1.
• Update to androidx.activity 1.10.0.
• Update to Compose Android 1.7.7.
• Update to Compose Multiplatform 1.7.3.
• Update to Kotlin 1.9.10.
• [code gen] Update to KSP 1.9.10-1.0.29.
• [code gen] Update to Dagger 2.55.
• [code gen] Update to KotlinPoet 2.0.0.
• [code gen] Build against Anvil-KSP 0.4.1. Should still be compatible with square/anvil as well.
• [code gen] Build against kotlin-inject-anvil 0.1.2. Should still be compatible with square/anvil as well.
• [samples] Update mosaic + modernize mosaic counter sample to fully use effects.
• [docs] Fix variable casing in Navigation documentation example.

Special thanks to @​vulpeszerda, @​rharter, @​alexvanyo, and @​easyhooon for contributing to this release!

v0.25.0

Compare Source

2024-10-23

• New: Pass tonalElevation to BottomSheetOverlay so that is reflected in ModalBottomSheet.
• Enhancement: Add -dontwarn on Anvil classes from codegen annotations.
• Enhancement: Misc small doc fixes and updates.
• Enhancement: Add note about only creating a presenter for supported screen types in tutorial.
• Update kotlinInject.anvil to 0.0.5.
• Update androidx.activity to 1.9.3.
• Update androidx.lifecycle to 2.8.6.
• Update Kotlin to 2.0.21.
• Build against KSP to 2.0.21-1.0.25.
• Update Turbine to 1.2.0.
• Update Compose Android to 1.7.4.
• Update Compose Multiplatform to 1.7.0.

Special thanks to @​eboudrant, @​bidrohi, @​hossain-khan, and @​dturner for contributing to this release!

v0.24.0

Compare Source

2024-09-16

• New: Add code gen support for kotlin-inject + kotlin-inject-anvil. See the code gen docs for usage instructions. We've also added a sample project.
• New: presenterTestOf() and Presenter.test() functions now return a new CircuitReceiveTurbine interface. This interface slightly but importantly modifies the behavior of awaitItem() by making it only emit changed items rather than every item. If you do want to assert the equivalent state is emitted across recompositions, you can use awaitUnchanged().
• New: Promote LocalBackStack to public API.
• Behavior change: Due to the above-documented change to awaitItem(), you may need to update tests that previously assumed duplicate emissions.
• Update to Kotlin 2.0.20.
• Change: Switch to stdlib's implementation of Uuid. This release now requires Kotlin 2.0.20 or later.
• Add sample test to demonstrate rememberAnsweringNavigator result handling.
• Update to kotlinx.coroutines 1.9.0.
• Update to compose-bom 2024.09.01.
• Update to kotlinx.collections.immutable 0.3.8.
• Update to androidx.activity 1.9.2.
• Update to androidx.lifecycle 2.8.5.
• Update to kotlin 2.0.20.
• Build against KSP 2.0.20-1.0.25.

v0.23.1

Compare Source

2024-07-30

• New: Promote NoOpRetainedStateRegistry to public API for use in testing and previews.
• New: Add CircuitPreview helper function for composable previews that contain Circuit content.
• Enhancement: When running under LocalInspectionMode, Circuit's default onUnavailableContent now shows a simpler non-intrusive placeholder UI instead.
• Enhancement: Support secondary injected constructors in code gen.
• Fix: Fix non-dismissable BottomSheetOverlay crash when invoking back-press.
• Update to Kotlin 2.0.10.
• Update to androidx.annotation 1.8.2.
• Build against KSP 2.0.10-1.0.24.

v0.23.0

Compare Source

2024-07-30

• New: Add macOS, windows, linux, tvOS, and watchOS targets to Circuit's runtime and retained artifacts.
• New: Add macOS targets to Circuit's UI, backstack, overlay, test, circuitx (except gesture nav), and foundation artifacts.
• Slightly optimize pausableState #​1455.
• Change: OverlayHost.showFullScreenOverlay now returns the PopResult? that was popped by the screen.
• Change: Remove backstack dependency from circuit-runtime. It was unnecessary and also accidentally imposed Compose UI on the runtime/presenter artifacts.
• Change: Make Overlay a fun interface.
• Breaking Change: Change OverlayEffect to use a new OverlayScope API that implements both CoroutineScope and OverlayHost, making both contexts available in the lambda.
• Update KSP to 2.0.0-1.0.24.
• Update androidx.activity to 1.9.1.
• Update androidx.lifecycle to 2.8.4.
• Update androidx.annotation to 1.8.1.
• Update KotlinPoet 1.18.1.
• Update Compose Multiplatform to 1.6.11.

Special thanks to @​aschulz90 and @​chrisbanes for contributing to this release!

v0.22.2

Compare Source

2024-06-04

• Fix: Fix pausableState recomposition loops by avoiding backward snapshot writes.
• New: Add Circuit.presentWithLifecycle flag to enable/disable automatic pausableState use. This is enabled by default.
• Update Compose Multiplatform to 1.6.11.
• Update androidx.lifecycle to 2.8.1.
• Update androidx.appcompat to 1.7.0.

Special thanks to @​chrisbanes, @​adamp, and Chuck Jazdzewski for contributing to this release and helping us find a runtime fix for the pausableState issue!

v0.22.1

Compare Source

2024-05-28

• Fix: Fix rememberRetained implicitly requiring LocalContext where it used to no-op.
• Update Molecule to 2.0.0.

v0.22.0

Compare Source

2024-05-28

• Update to Kotlin 2.0.0.
• Update to KSP 2.0.0-1.0.21.
• Update Compose Multiplatform to 1.6.10.
• Switch to the compose compiler shipped with Kotlin.

This release is otherwise identical to 0.21.0, just updated to Kotlin 2.0.

v0.21.2

Compare Source

• Fix: Fix pausableState recomposition loops by avoiding backward snapshot writes.
• New: Add Circuit.presentWithLifecycle flag to enable/disable automatic pausableState use. This is enabled by default.

Full Changelog: slackhq/circuit@0.21.1...0.21.2

v0.21.1

Compare Source

• Fix: Fix rememberRetained implicitly requiring LocalContext where it used to no-op (#​1438)

What's Changed

• Short circuit rememberRetained if the LocalRetainedStateRegistry isn't set by @​stagg in #​1438

Full Changelog: slackhq/circuit@0.21.0...0.21.1

v0.21.0

Compare Source

2024-05-28

• New: Add WASM targets.
• New: Add FakeNavigator functions to check for the lack of pop/resetRoot events.
• New: Add FakeNavigator constructor param to add additional screens to the backstack.
• New: Add support for static UIs. In some cases, a UI may not need a presenter to compute or manage its state. Examples of this include UIs that are stateless or can derive their state from a single static input or an input [Screen]'s properties. In these cases, make your screen implement the StaticScreen interface. When a StaticScreen is used, Circuit will internally allow the UI to run on its own and won't connect it to a presenter if no presenter is provided.
• New: Add RecordLifecycle and LocalRecordLifecycle composition local, allowing UIs and presenters to observe when they are 'active'. Currently, a record is considered 'active' when it is the top record on the back stack.
• New: Add a rememberRetainedSaveable variant that participates in both RetainedStateRegistry and SaveableStateRegistry restoration, allowing layered state persistence.
  • The logic is the following upon rememberRetainedSaveable entering composition:
    • consume from both RetainedStateRegistry and SaveableStateRegistry, if available
    • if the retained value is available, use that
    • otherwise, if the saveable restored value is available, use that
    • otherwise, re-initialize the value
  • There is also an overload of rememberRetained that explicitly requires a Saver parameter.
• Behaviour Change: Presenters are now 'paused' when inactive and replay their last emitted CircuitUiState when they are not active. Presenters can opt-out of this behavior by implementing NonPausablePresenter.
• Behaviour Change: NavigatorImpl.goTo no longer navigates if the Screen is equal to Navigator.peek().
• Behaviour Change: Presenter.present is now annotated with @ComposableTarget("presenter"). This helps prevent use of Compose UI in the presentation logic as the compiler will emit a warning if you do. Note this does not appear in the IDE, so it's recommended to use allWarningsAsErrors to fail the build on this event.
• Behaviour Change: Guard against Navigator.goTo() calls to the same current screen.
• Change: Navigator.goTo now returns a Bool indicating navigation success.
• Change: Move iOS GestureNavigationDecoration impl to commonMain and rename to CupertinoGestureNavigationDecoration.
• Change: Target jvmTarget 1.8 in core libraries.
• Fix: Fix saveable state being restored when using reset root navigation events.
• Deprecation: FakeNavigator.assertIsEmpty and expectNoEvents (use the specific event type methods instead)
• Mark Presenter.Factory as @Stable.
• Mark Ui.Factory as @Stable.
• Mark CircuitContext as @Stable.
• Mark EventListener as @Stable.
• Mark EventListener.Factory as @Stable.
• [samples] Improve interop sample significantly.
• Update Kotlin to 1.9.24.
• Update KSP to 1.9.24-2.0.20.
• Update compose-compiler to 1.5.14.
• Update KotlinPoet to 1.17.0.
• Update androidx.lifecycle to 2.8.0.
• Update Molecule to 1.4.3.
• Update androidx.annotation to 1.8.0.
• Update kotlinx.coroutines to 1.8.1.
• Update Compose Multiplatform to 1.6.2.
• Update Compose UI to 1.6.7.
• Update Compose Runtime to 1.6.7.
• Update Compose Animation to 1.6.7.
• Update Compose Material to 1.6.7.
• Update androidx.core to 1.13.1.
• Update androidx.activity to 1.9.0.
• Update dagger to 2.51.1.
• Update uuid to 0.8.4.

Special thanks to @​chrisbanes, @​alexvanyo, @​eboudrant, @​edenman, and @​JustinBis for contributing to this release!

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[github-actions]

	Messages
📖	This PR has been checked by Danger

Generated by 🚫 Danger Kotlin against 6a43bbe