navigation-fragment-compose: Safe Args plugin cannot escape composable destination name [362791955]

Fixed

Bug

androidx-navigation-2.9.0-alpha06

androidx-navigation-2.8.7

Status Update

No update yet.

Description

je...@pinkfroot.com

created issue #1

Aug 29, 2024 07:39AM

Component used: Navigation (androidx.navigation:navigation-fragment-compose)

Version used: 2.8.0-rc01

Devices/Android versions reproduced on: N/A (build issue)

As soon as I add an action to a composable destination like so:

<composable
  android:id="@+id/home_screen"
  android:name="com.example.HomeScreenKt\$HomeScreen" >
  <action
    android:id="@+id/action_home_screen_to_other_fragment"
    app:destination="@id/other_fragment" />
</composable>

My project build fails on the :app:generateSafeArgs task with the following error:

Can't escape identifier `HomeScreenKt\$HomeScreenDirections` because it contains illegal characters: \

Comments

cl...@couchbits.com <cl...@couchbits.com> #2Sep 25, 2024 07:58AM

This happens even if you don't define an action inside the `<composable />`. The pure combination of `<composable />` and plugin `androidx.navigation.safeargs` seems enough.

See attached gradle build log. Used versions of `androidx.navigation.safeargs` and `navigation-fragment-compose` is `2.8.1`.

362791955.log

19 KB

View

Download

we...@gmail.com <we...@gmail.com> #3Oct 15, 2024 10:14PM

We are having the same issue with navigation-fragment-compose.
Adding a composable to nav graph leads to compilation error.
Has anyone started looking into this issue yet?

se...@gmail.com <se...@gmail.com> #4Nov 21, 2024 09:55PM

I just had the same issue and it seems to be working if you remove the "\" before the "$". In the above example the name would be "com.example.HomeScreenKt$HomeScreen".

Some other things that I noticed:
1. Make sure the composable function does not have any parameters ex: fun HomeScreen(){ }
2. If you use hilt and you need to inject a viewmodel you will have to use hiltViewModel() from hilt-navigation-compose(

https://developer.android.com/jetpack/androidx/releases/hilt) instead of viewModel() inside the composable function

jb...@google.com <jb...@google.com> Jan 14, 2025 08:02PM

Assigned to il...@google.com.

pr...@google.com <pr...@google.com> Jan 22, 2025 05:37PM

Reassigned to jb...@google.com.

aa...@gmail.com <aa...@gmail.com> #5Jan 27, 2025 06:35AM

Affected by the same issue. I can also confirm that removing the \ before the $ fixes the compilation error.

ap...@google.com <ap...@google.com> #6Feb 5, 2025 08:51PM

Project: platform/frameworks/support
Branch: androidx-main
Author: Jeremy Woods <jbwoods@google.com>
Link: https://android-review.googlesource.com/3478934

Provide safe args classes for composables in safe args

Expand for full commit details

Provide safe args classes for composables in safe args 
 
Adding support for Directions and Args classes in Navigation safe args. 
 
RelNote: "Navigation Safe Args now provides support for composable 
destinations." 
Test: added tests 
Bug: 362791955 
 
Change-Id: I353205e72fe2896cae7ca1f563bfe58798e59578

Files:

M navigation/navigation-safe-args-generator/src/main/kotlin/androidx/navigation/safe/args/generator/models/Destination.kt
M navigation/navigation-safe-args-generator/src/test/kotlin/androidx/navigation/safe/args/generator/NavGeneratorTest.kt
M navigation/navigation-safe-args-generator/src/test/kotlin/androidx/navigation/safe/args/generator/NavParserTest.kt
M navigation/navigation-safe-args-generator/src/test/test-data/naive_test.xml

Hash: 44dc2bd5961dfd6665e06246c9b38ec916ea9364
Date: Wed Feb 05 19:24:28 2025

jb...@google.com <jb...@google.com> #7Feb 5, 2025 09:01PM

Marked as fixed.

This has been fixed internally and will be available in the Navigation 2.9.0-alpha06 and 2.8.7 releases.

pr...@google.com <pr...@google.com> #8Feb 12, 2025 06:40PM

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.navigation:navigation-safe-args-generator:2.9.0-alpha06
androidx.navigation:navigation-safe-args-generator:2.8.7