Provide NavigationEventDispatcherOwner for non-android targets by terrakok · Pull Request #2382 · JetBrains/compose-multiplatform-core

terrakok · 2025-09-08T14:59:23Z

Suppot the NavigationEventDispatcherOwner for a correct Navigation3 support on non-android targets.

Fixes CMP-7646 Support Navigation 3 for Compose Multiplatform

Testing

Manually checked the demo app

Release Notes

Highlights - Navigation

Provide required NavigationEventDispatcherOwner for a correct Navigation3 support.

MULTIPLATFORM.md

.../uikitMain/kotlin/androidx/compose/ui/navigationevent/UIKitNavigationEventDispatcherOwner.kt

...src/uikitMain/kotlin/androidx/compose/ui/uikit/ComposeUIViewControllerConfiguration.uikit.kt

.../ui/ui/src/uikitMain/kotlin/androidx/compose/ui/navigationevent/UIKitNavigationEventInput.kt

terrakok · 2025-09-09T14:28:27Z

checked iOS layers with a dialog and a popup. works like a charm

nave.mp4

… Compose.

…ration

…integration.

…ollerConfiguration`

…nfigurability.

…ler`

…lStore and NavigationEventDispatcher owners. And instead of a new NavigationEventDispatcher in the UIKitComposeSceneLayer, a new UIKitNavigationEventInput is used

…to the skiko only source set.

…ationEvent` and `NavigationEventHandler`. Remove unused dependencies and dump API.

MatkovIvan

Revert experimental annotations. Removing it means stabilization that we do not want to

...ui-backhandler/src/androidMain/kotlin/androidx/compose/ui/backhandler/BackHandler.android.kt

MatkovIvan

LGTM in general, but let's add proper metadata in depracation annotations to help with migration

MatkovIvan · 2025-09-10T12:20:14Z

...ui-backhandler/src/androidMain/kotlin/androidx/compose/ui/backhandler/BackHandler.android.kt

 import androidx.compose.ui.ExperimentalComposeUiApi
 import kotlinx.coroutines.flow.Flow

+@Deprecated("Use NavigationEventHandler instead")


Suggested change

@Deprecated("Use NavigationEventHandler instead")

@Deprecated(

message = "Use a {@link androidx.navigationevent.compose.NavigationEventHandler} instead",

replaceWith = ReplaceWith(

expression = "NavigationEventHandler(enabled, onBack)",

imports = arrayOf("androidx.navigationevent.compose.NavigationEventHandler"),

),

level = DeprecationLevel.WARNING, // TODO: Replace to ERROR in 1.11

)

KTIJ-35595 ReplaceWith works wrong with expect/actual and default arguments

ASalavei · 2025-09-10T13:56:18Z

.../ui/ui/src/uikitMain/kotlin/androidx/compose/ui/platform/UIKitArchitectureComponentsOwner.kt

+import androidx.navigationevent.NavigationEventDispatcherOwner

-internal class IOSLifecycleOwner: LifecycleOwner, ViewModelStoreOwner {
+internal class UIKitArchitectureComponentsOwner :


I'm not happy with the idea to put everything in a single class by the criteria that they are Owners interfaces.
Also, ViewModelStore placed here incorrectly. ViewModelStoreOwner and NavigationEventDispatcher should be implemented by the separate instances - either that can be separate classes or anonymous object.
It's up to you - you can do it in the current MR, or I'll fix it by myself later.

Since I've already refactored this part of the code let's give it to you. ok? I have no strict preferences here but it seems logical though because on other platforms we have these interfaces in a single place

ASalavei · 2025-09-10T14:11:38Z

compose/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/scene/UIKitComposeSceneLayer.uikit.kt

-        content = content
-    )
+    ) {
+        val navigationEventDispatcherOwner = LocalInternalNavigationEventDispatcherOwner.current


Two different approaches where used in ComposeHostingViewController and here. Either this code should be used in ComposeSceneMediator once or it's looks like the optimal solution will be to:

make the navigationEventInput internal

Add input at the place where UIKitComposeSceneLayer is created

use onClose callback to remove input

ASalavei · 2025-09-10T14:16:15Z

...e/ui/ui/src/uikitMain/kotlin/androidx/compose/ui/scene/ComposeHostingViewController.uikit.kt

        density = rootView.density,
        getTopLeftOffsetInWindow = { IntOffset.Zero } //full screen
-    )
+    ).also { eventInput -> archComponentsOwner.navigationEventDispatcher.addInput(eventInput) }


The eventInput added here never removes. It should not be a big issue since navigationEventDispatcher and eventInput have the same lifetime, but it would be better to add event input in the viewControllerDidEnterWindowHierarchy and remove in viewControllerDidLeaveWindowHierarchy

igordmn · 2025-10-01T15:20:39Z

compose/ui/ui/build.gradle

                    api(project(":compose:ui:ui-text"))
                    api(libs.skikoCommon)
                    implementation(libs.atomicFu)
-                    implementation(project(":compose:ui:ui-backhandler"))


This probably broke backward compatibility for klibs due to KT-60874 [KLIB Resolve] Don't save transitive dependencies in manifest's depends property.

Please fix it before beta01, creating a stub project for backhandler

creating a stub project for backhandler

the project is still here and contains valid code. What's required is only restoring this dependency

* What went wrong: Circular dependency between the following tasks: :navigationevent:navigationevent-compose:compileDesktopMainJava +--- :navigationevent:navigationevent-compose:compileKotlinDesktop | \--- :compose:ui:ui:desktopJar | +--- :compose:ui:ui:compileDesktopMainJava | | +--- :compose:ui:ui:compileKotlinDesktop | | | \--- :compose:ui:ui-backhandler:desktopJar | | | +--- :compose:ui:ui-backhandler:compileDesktopMainJava | | | | +--- :navigationevent:navigationevent-compose:desktopJar

I'll try to use a non-compose library then

terrakok requested a review from MatkovIvan September 8, 2025 14:59

MatkovIvan changed the title ~~Provide NavigationEventDispatcherOwner for non-android targets.~~ Provide NavigationEventDispatcherOwner for non-android targets Sep 8, 2025

MatkovIvan reviewed Sep 8, 2025

View reviewed changes

MULTIPLATFORM.md Show resolved Hide resolved

terrakok force-pushed the navevent-int branch from 95ae7db to 44ccf02 Compare September 8, 2025 16:32

MatkovIvan reviewed Sep 8, 2025

View reviewed changes

.../uikitMain/kotlin/androidx/compose/ui/navigationevent/UIKitNavigationEventDispatcherOwner.kt Outdated Show resolved Hide resolved

...src/uikitMain/kotlin/androidx/compose/ui/uikit/ComposeUIViewControllerConfiguration.uikit.kt Show resolved Hide resolved

terrakok force-pushed the navevent-int branch from 44ccf02 to 2d53b0c Compare September 9, 2025 09:11

terrakok requested a review from MatkovIvan September 9, 2025 09:19

ASalavei reviewed Sep 9, 2025

View reviewed changes

.../ui/ui/src/uikitMain/kotlin/androidx/compose/ui/navigationevent/UIKitNavigationEventInput.kt Outdated Show resolved Hide resolved

terrakok added 16 commits September 10, 2025 13:40

Add navigation event handling support for Desktop in Compose UI

ae70616

Use default NavigationEventDispatcherOwner for non-Android targets in…

31bff21

… Compose.

Replace BackGestureDispatcher with NavigationEventInput for iOS Integ…

6577004

…ration

Remove DesktopBackGestureDispatcher in favor of NavigationEventInput …

60d709a

…integration.

Remove unused ui-backhandler module dependency from Compose UI

d7251d5

Remove experimental enableBackGesture flag from `ComposeUIViewContr…

ba4f894

…ollerConfiguration`

Migrate the ui-backhandler module on the navigationevent library

7e124b5

Extract navigationevent version to a project property for better co…

7980bc8

…nfigurability.

Dump API

eb48c33

Add null-check for LocalNavigationEventDispatcherOwner in `BackHand…

8ae207b

…ler`

Enable ios gesture recognizers only when there are active callbacks.

e209aa1

Introduce UIKitArchitectureComponentsOwner with Lifecycle, ViewMode…

8e307f1

…lStore and NavigationEventDispatcher owners. And instead of a new NavigationEventDispatcher in the UIKitComposeSceneLayer, a new UIKitNavigationEventInput is used

Add Popup with Predictive Back Handler in the iOS demo.

e2c413b

Remove unused UIKitNavigationEventDispatcherOwner and related imports.

6c4cced

Move navigationevent-compose dependency in ui-backhandler module …

b6c4a7c

…to the skiko only source set.

Deprecate BackEventCompat and BackHandler APIs in favor of `Navig…

d7523b3

…ationEvent` and `NavigationEventHandler`. Remove unused dependencies and dump API.

terrakok force-pushed the navevent-int branch from 8e1a2f4 to d7523b3 Compare September 10, 2025 11:40

MatkovIvan requested changes Sep 10, 2025

View reviewed changes

...ui-backhandler/src/androidMain/kotlin/androidx/compose/ui/backhandler/BackHandler.android.kt Show resolved Hide resolved

Return @ExperimentalComposeUiApi in ui-backhandler module.

3deb607

terrakok requested a review from MatkovIvan September 10, 2025 11:58

MatkovIvan reviewed Sep 10, 2025

View reviewed changes

terrakok requested a review from ASalavei September 10, 2025 13:34

MatkovIvan approved these changes Sep 10, 2025

View reviewed changes

ASalavei reviewed Sep 10, 2025

View reviewed changes

terrakok requested a review from ASalavei September 10, 2025 14:01

ASalavei reviewed Sep 10, 2025

View reviewed changes

Integrate NavigationEventDispatcher into UIKitComposeSceneLayer.

9a7bf82

ASalavei approved these changes Sep 10, 2025

View reviewed changes

terrakok merged commit a428770 into jb-main Sep 10, 2025
10 checks passed

terrakok deleted the navevent-int branch September 10, 2025 15:14

igordmn reviewed Oct 1, 2025

View reviewed changes

MatkovIvan mentioned this pull request Oct 24, 2025

Add ui-backhandler dependency shortcut JetBrains/compose-multiplatform#5436

Closed

-@Deprecated("Use NavigationEventHandler instead")
+@Deprecated(
+    message = "Use a {@link androidx.navigationevent.compose.NavigationEventHandler} instead",
+    replaceWith = ReplaceWith(
+        expression = "NavigationEventHandler(enabled, onBack)",
+        imports = arrayOf("androidx.navigationevent.compose.NavigationEventHandler"),
+    ),
+    level = DeprecationLevel.WARNING, // TODO: Replace to ERROR in 1.11
+)

Comments

Conversation

terrakok commented Sep 8, 2025

Testing

Release Notes

Highlights - Navigation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

terrakok commented Sep 9, 2025

Uh oh!

MatkovIvan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MatkovIvan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ASalavei Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

igordmn Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ASalavei Sep 10, 2025 •

edited

Loading

igordmn Oct 1, 2025 •

edited

Loading