Safeargs library doesnt generate direction class

Question

I use navigation library and safeargs for passing data. I define argument to fragment like that.

<fragment
        android:id="@+id/otherFragment"
        android:name="com.asd.navigate.OtherFragment"
        android:label="OtherFragment">
        <argument
            android:name="screenTitle"
            android:defaultValue="0"
            app:type="string" />
    </fragment>

OtherFragmentArgs generated, I can use it but OtherFragmentDirection class doesnt generate when I click "make project". Is that bug or I have to do something different.

Thnx for advice.

buildscript {
    ...
    dependencies {
       ...
        classpath "android.arch.navigation:navigation-safe-args-gradle-plugin:1.0.0-alpha01"

    }
}

build.gradle

apply plugin: "androidx.navigation.safeargs"

MainActivity.kt

I had the same issue. **Build** > **Rebuild Project** solved it for me. — ban-geoengineering, Jun 17 '20 at 15:26
Try updating Kotlin Version and Gradle version of whole project to latest plugins you have in your studio — Arsh Ansari, Jul 16 '21 at 13:53

score 100 · Answer 1 · answered Jan 14 '20 at 11:06

100

I forgot to apply plugin in app.gradle file, just add this line

apply plugin: "androidx.navigation.safeargs.kotlin"

or this line if you are using java

apply plugin: "androidx.navigation.safeargs"

answered Jan 14 '20 at 11:06

Sanjeev

4,255
3
28
37

16

also, don't forget to add the `classpath "androidx.navigation:navigation-safe-args-gradle-plugin:2.3.0"` in the project-level `build.gradle` file, too – Eric Nov 14 '20 at 19:28
1

This pointed me to the solution. I had to include this plugin in the module's `build.gradle.kts` file, in my multi-module project. – peter.o Jan 25 '21 at 18:20
1

Very very thank you :) – Nov 19 '21 at 20:02
@VahitKeskin You are very very welcome :) – Sanjeev Dec 24 '21 at 18:02

score 88 · Accepted Answer · edited Apr 21 '20 at 10:26

88

Look for the class of the fragment which is the source of navigation. If you define navigation from FragmentA to FragmentB, you will find FragmentADirections class with the actions you defined (in nav_graph.xml) in it.

Then, to generate direction class ( Also argument class) you need to go Project level gradle then click the build command. Here I attached a screenshot to give a clear understanding.

edited Apr 21 '20 at 10:26

Gk Mohammad Emon

6,084
3
42
42

answered Jul 05 '18 at 19:25

shmulik.r

1,101
9
5

9

Additionally, I have to re-sync my project for it to show up. – Joshua King Oct 21 '19 at 16:40
1

even though I did all of the suggested solutions here before coming to SO, nothing worked, I even did invalidate cache/restart, still didn't work. This answer is the only one i did not know of or applied, but it still didn't directly work. It actually gave me a build error, but i think it triggered sth new. I then did a clean>rebuild again, and it finally worked. – Ace May 17 '20 at 14:26
Invalidate cache and restart does not work by itself, must clean and rebuild. – apsommer Oct 21 '20 at 02:02

score 52 · Answer 3 · edited Mar 04 '23 at 17:29

52

I faced a similar issue working with android studio 4.2 preview.

The issue was that the IDE somehow was not picking the source folders where the generated direction classes where being placed by the plugin. So adding the following to my app build.gradle file resolved the issue for me.

sourceSets {
    main {
        java {
            srcDirs += 'build/generated/source/navigation-args'
        }
    }
}

edited Mar 04 '23 at 17:29

Sunderam Dubey

1
11
20
40

answered Jun 25 '20 at 04:57

Christian

739
6
10

Yes, this was the correct answer for me. Already included the plugins. – Geert Berkers Oct 08 '20 at 14:58
the missing args broke the file analysis and inspections for me, the ide was not useable. U just saved my life – Kochchy Dec 21 '20 at 12:42
This breaks androidTest builds. – gosr May 05 '21 at 14:33
Solved the problem, every other answer did nothing. Thanks! – Giedrius Šlikas Dec 13 '21 at 15:03
Solved the issue in AS Chipmunk but now I get this warning `Duplicate content roots detected` – Jorge Guillermo Negrete Sep 26 '22 at 05:47
This was the solution for me. I already had the plugins in my build.gradle – Givver Aug 30 '23 at 16:27

Zdenek Sima · Answer 4 · 2022-09-16T05:11:05.080

20

As Christian wrote, adding source set to app gradle file helped. The problem occurs in Android Studio 4.1 and 4.2 for me. In Kotlin DSL:

android {
    ....
    sourceSets {
        getByName("main").java.srcDirs("build/generated/source/navigation-args")
    }
}

edited Sep 16 '22 at 05:11

answered Jun 26 '20 at 09:31

Zdenek Sima

311
2
6

2

This answer solved my issue on Android Studio 4.2 – MaxGDN Dec 04 '20 at 19:10
1

Thanks! You saved me a lot of time and frustration! Doesn't anyone at Google notice when they break things like this? – Kimble Nov 23 '21 at 07:57

score 18 · Answer 5 · answered Apr 26 '20 at 10:22

If all the answers above didn't work for you and you are still having a problem with the directions class not being generated. Make sure you are looking for the right directions class.

For example, we have to pass arguments from FragmentA to FragmentB.
In the navigation graph file, we have to add the <argument/> tag under FragmentB's tag. This way, we will get two generated classes FragmentBArgs and FragmentADirections. As you can see, it is the FragmentA's name who got used for the directions class created, not FragmentB.

So, keep in mind that unlike what this question's user is looking for, the directions class generated will get the class name of the action starter fragment appended with the word "Directions". Not the destination fragment's class name (argument's owner).

Here is what the documentation says:

A class is created for each destination where an action originates. The name of this class is the name of the originating destination, appended with the word "Directions".

A class is created for the receiving destination. The name of this class is the name of the destination, appended with the word "Args".

Also, adding the argument tag under the action tag will not generate a directions class. It's used to give a different default value for the destination fragment's argument.

Hope this helps!

Thank you for this. Even though I had the problem that my *Args class was not generated, in the end I was adding my tag under origin fragment instead of the destination fragment. — Chapz, Feb 02 '21 at 15:46

score 13 · Answer 6 · answered Apr 06 '20 at 07:47

13

If you already added the dependencies > classpath and apply plugin but changes aren't applied, be sure to Clean and Built the project in order changes are applied.

In Android Studio:

Build tab > Clean project
Build tab > ReBuild project

answered Apr 06 '20 at 07:47

Alexandre B.

5,387
2
17
40

1

i had the same problem and the solution worked for me – Hasan Haghniya Apr 18 '21 at 13:38

Fabi · Answer 7 · 2020-05-15T18:40:54.433

13

We can fix this issue by adding the below codes in gradle and rebuilding the app. In the project gradle add below code.

classpath "android.arch.navigation:navigation-safe-args-gradle-plugin:1.0.0"

In app gradle add below code

apply plugin: "androidx.navigation.safeargs"

edited May 15 '20 at 18:40

answered May 15 '20 at 18:34

Fabi

161
1
6

1

You'd better use `classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"` since you use AndroidX. – Micer Jun 20 '20 at 16:06

score 7 · Answer 8 · answered Apr 26 '20 at 06:50

For me, I realized that I also needed to put the same arguments into the receiver fragment in navi_graph.xml as well in order for Arg class to be generated(already have directions). For example:

<fragment android:id="@+id/receiver_fragment" ...>

    <argument android:name="arg_from_sender_fragment".../>

    <argument android:name="arg2_from_sender_fragment".../>

</fragment>

score 5 · Answer 9 · answered Jun 22 '20 at 09:47

5

Following two steps works for me:

Clean project.
Rebuild project

Android studio 4.0 Kotlin 1.3.72

answered Jun 22 '20 at 09:47

Yogesh Nikam Patil

1,192
13
18

When I had this problem cleaning and rebuilding didn't work. What eventually solved the problem was just changing one value in the `navigation.xml`, Clean and Build, then change the value back, Clean and Rebuild and it worked. Example. Do this for any value in the xml. Doesn't matter `app:popUpToInclusive="true"` -> `app:popUpToInclusive="false"` Clean and Rebuild `app:popUpToInclusive="false"` -> `app:popUpToInclusive="true"` Clean and Rebuild, Problem Gone. – Banane42 May 02 '22 at 15:17

score 5 · Answer 10 · answered Jun 27 '21 at 07:07

5

app->build.gradle:

Inside the plugins, I have added the below line to fix that issue:

plugins {
    id "androidx.navigation.safeargs.kotlin"
}

answered Jun 27 '21 at 07:07

Stephen

9,899
16
90
137

score 5 · Answer 11 · edited Jul 19 '21 at 13:18

5

All solutions didn't work for me and I had all synced in build.gradle. Only way I could've find directions and args was by changing from Android to Project. Open app -> package -> build -> generated -> source -> navigation-args. And you'll get fragment directions and args. Here is screenshot, hope it works for you guys!

fragment directions and args

edited Jul 19 '21 at 13:18

Ticherhaz FreePalestine

2,738
4
20
46

answered Jul 16 '21 at 11:35

clone_fg

51
1
1

score 4 · Answer 12 · answered Dec 28 '20 at 16:18

Follow these steps:

Step 1: Add dependencies

def nav_version = "2.3.2"

implementation "androidx.navigation:navigation-fragment-ktx:$nav_version"
implementation "androidx.navigation:navigation-ui-ktx:$nav_version"

Step 2: In your app-level build.gradle make sure you have below plugins added.

plugins {
    id 'com.android.application'
    id 'kotlin-android'
    id 'kotlin-kapt'
    id 'kotlin-android-extensions'
    id 'androidx.navigation.safeargs.kotlin'
}

Step 3: Add this in project_level build.gradle inside dependencies section :

classpath "androidx.navigation:navigation-safe-args-gradle-plugin:2.3.2"

Step 4: In your nav_graph.xml make sure to connect one fragment to another with actions.

Step 5: Clean & Rebuild your project.

Javatar · Answer 13 · 2020-03-13T14:27:07.760

Also make sure to use an up to date version. Had the problem, that I had an 1.X version.

// Navigation
implementation "androidx.navigation:navigation-fragment-ktx:2.2.1"
implementation "androidx.navigation:navigation-ui-ktx:2.2.1"

And the args correctely in the nav.xml:

<fragment
    android:id="@+id/categoryFragment"
    android:name="com...CategoryFragment"
    android:label="CategoryFragment"
    tools:layout="@layout/fragment_category">
    <action
        android:id="@+id/action_categoryFragment_to_ProductFragment" // /!\
        app:destination="@id/productFragment"
        <argument
            android:name="products"
            android:defaultValue=""
            app:argType="string" />
    </action>
</fragment>

Code:

override fun onItemClicked(category: Category) {
     val action = CategoryFragmentDirections.actionCategoryToProductFragment(products = "myString") // /!\
     view?.findNavController()?.navigate(action)
}

Fyi: Also had to add: `kotlinOptions { jvmTarget = JavaVersion.VERSION_1_8.toString() }` to build.gradle — Javatar, Mar 13 '20 at 15:01

score 3 · Answer 14 · answered Nov 30 '21 at 10:40

If none of the other answers worked for you and you are using multiple NavGraphs, make sure that your NavGraph id's in xml are different.

<navigation
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/nav_graph">

Tonui Nicholus · Answer 15 · 2020-03-19T07:19:44.377

2

In your app/module level add the following dependency :

    def nav_version = "2.3.0-alpha04"  //your nav_version defined 

    implementation "androidx.navigation:navigation-dynamic-features-fragment:$nav_version"

all the answers are correct too. just felt that I should add this info. It worked for me

edited Mar 19 '20 at 07:19

answered Mar 19 '20 at 07:13

Tonui Nicholus

395
2
8

score 2 · Answer 16 · answered Jun 09 '20 at 02:15

In my case, the problem was that I was using the same fragment with the same id in 2 navigation graphs.

Android Studio didn’t recognize the actions of one of the navigation graphs.

So the solution for me was to change the id of one of the navigation graphs, rebuild, change again the id and rebuild again.

After that everything worked again

score 2 · Answer 17 · answered Jun 11 '20 at 21:36

2

I followed all instructions to the letter and noticed the Directions classes were being generated, but would not compile when called in code. This happened while using Android Studio 4.1 and 4.2 Preview.

After a few hours, I decided to try downgrading to 4.0 Stable. All issues are now gone, I can call the FragmentDirections and it compiles.

I added a bug in the issue tracker: https://issuetracker.google.com/issues/158777967

answered Jun 11 '20 at 21:36

Sean Blahovici

5,350
4
28
38

1

You just saved me a few hours! I had exactly the same issue, downgraded to stable and boom, Directions classes are generated! Thanks for sharing this! – Micer Jun 20 '20 at 16:15

score 2 · Answer 18 · answered Jun 25 '20 at 00:46

2

If anybody's having trouble with auto-generated classes with SafeArgs, check your AndroidStudio version. I was using 4.1 beta (at this moment) and when downgraded to 4.0 it works perfectly. Definitely do try that. Cheers!

answered Jun 25 '20 at 00:46

Lheonair

468
5
14

score 2 · Answer 19 · answered Aug 04 '20 at 12:11

Took a bit to figure out but you need both action and arguments in your nav xml file to generate both.

<fragment
    android:id="@+id/nav_someId"
    android:name=".CategoriesFragment"
    android:label="@string/someName"
    tools:layout="@layout/fragment_categories">
    <argument
        android:name="@string/category"
        android:defaultValue="0"
        app:argType="string" />
    <action
        android:id="@+id/startCategoriesFragment"
        app:destination="@+id/categoriesFragment">
        <argument
            android:name="@string/category"
            android:defaultValue="0"
            app:argType="string" />
    </action>
</fragment>

What do you mean ? action and arg in same fragment tag? doesn't make sense. The argument should be in destination and action should be in the action originating fragment tag — Antroid, Sep 26 '20 at 23:01

score 2 · Answer 20 · answered Aug 27 '20 at 16:13

In my case, the missing part was firstly in the build.gradle.kts

buildscript {
repositories {
    google()
}
dependencies {
    def nav_version = "X.X.X" // Use the latest version
    classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
}

}

and then, I had to add the plugin in app and navigation modules (I usually separate navigation in a different one):

apply plugin: "androidx.navigation.safeargs.kotlin"

Clean -> Build But still had to add manually the path to the action

import yourpackage.FragmentDirections.Companion.actionFirstFragmentToSecondFragment

In my case adding plugin for kotlin helped me, thanks – Abror Esonaliev Apr 01 '21 at 04:22 — Abror Esonaliev, Apr 01 '21 at 04:22

score 1 · Answer 21 · answered Apr 23 '21 at 20:45

I just forgot to rebuild my project after cleaning it :)

Also dont forget these two steps:

Add safe-args dependency to project Gradle file

"android.arch.navigation:navigation-safe-args-gradle-plugin:$version_navigation"

Add safeargs plugin to app Gradle file // Adding the apply plugin statement for safeargs

apply plugin: 'kotlin-kapt'
apply plugin: 'androidx.navigation.safeargs'

score 1 · Answer 22 · answered Jun 07 '21 at 04:15

For some reason (I'm still learning details of the gradle files in Android) the above plugin lines didn't work. But this did. Add this line inside the plugin section of your build.gradle (app).

id ("androidx.navigation.safeargs")

No colon, no equals. And of course sync, rebuild, etc. This is slightly different from other answers. But details count in programming!

score 1 · Answer 23 · edited May 25 '22 at 16:43

1

Apply the plugin in the build.gradle (module level)

apply plugin: "androidx.navigation.safeargs.kotlin"

Add the dependencies in the build.gradle (Project Level)

classpath "androidx.navigation:navigation-safe-args-gradle-plugin:2.1.0-rc01"

This would solve the problem.

edited May 25 '22 at 16:43

Boken

4,825
10
32
42

answered Dec 15 '21 at 03:08

Ramya Bm

27
2

score 0 · Answer 24 · answered Nov 17 '20 at 05:56

0

the problem may be with your apply plugin thing please check if you are using java then add:

apply plugin: "androidx.navigation.safeargs"

and for kotlin use this:

apply plugin: "androidx.navigation.safeargs.kotlin"

answered Nov 17 '20 at 05:56

Asad

1,241
3
19
32

score 0 · Answer 25 · answered Jan 10 '21 at 08:31

In my case I manually added the arguments... in the wrong place ‍♂️

Select the destination in your navigation graph and click the "+" button next to "Arguments". Add the relevant info and you should be able to see the generated SafeArgs with by navArgs().

Here's a helpful guide with pictures. https://medium.com/androiddevelopers/navigating-with-safeargs-bf26c17b1269

score 0 · Answer 26 · answered Feb 21 '21 at 12:44

0

In my case, instead of control-dragging from Fragment A to B, I did B to A and thus they were not being generated in the correct Fragment class, rookie mistake! So check this too guys!

answered Feb 21 '21 at 12:44

Tarantino

1

score 0 · Answer 27 · answered Mar 31 '21 at 08:41

0

When you update some actions or arguments on the nav graph. You need to Build > Rebuild Project to see this changes applied

answered Mar 31 '21 at 08:41

DavidUps

366
3
9

score 0 · Answer 28 · answered Mar 04 '23 at 17:11

UPDATE

if you are using Kotlin add this plugin to the app build.gradle level:

plugins {
    ...
    id "androidx.navigation.safeargs.kotlin"
}

and in the build.gradle project level add this plugin:

 plugins {
        ...
         id 'com.google.dagger.hilt.android' version '2.42' apply false
    }

if you are missing generated safe args classes add this to tell gradle to add the generated classes under the main folder in the kotlin file:

android {
...
    sourceSets {
        main {
            kotlin {
                srcDirs += 'build/generated/source/navigation-args/'
            }
        }
    }
}

Safeargs library doesnt generate direction class

28 Answers28

Linked