Compose NavGen
Generate helper methods for compose navigation using KSP.
TODO
- Support default value and nullable.
- Support argument types.
- Support animation navigation.
- Add unit test.
- Add Github Actions.
Usage
Add @NavGen annotation to each compose screen.
@NavGen("list")
@Composable
fun ListScreen(navController: NavController) {
// ...
}
@NavGen("detail")
@Composable
fun DetailScreen(data: String, navController: NavController) {
// ...
}
When build, the processor generates helper methods from @NavGen.
Generated code
DetailScreen( backStackEntry.arguments!!.getString("data")!!, navController, ) } } fun NavController.detail(`data`: String) { navigate("detail/$data") } ">
// list fun NavGraphBuilder.list(navController: NavController) { composable("list") { ListScreen(navController) } } public fun NavController.list(): Unit { navigate("list") } // detail fun NavGraphBuilder.detail(navController: NavController) { composable( "detail/{data}", arguments = listOf(navArgument("data") { type = NavType.StringType }) ) { backStackEntry -> DetailScreen( backStackEntry.arguments!!.getString("data")!!, navController, ) } } fun NavController.detail(`data`: String) { navigate("detail/$data") }
You can use generated code for compose navigation.
val navController = rememberNavController()
NavHost(navController = navController, startDestination = NavGenRoutes.list) {
list(navController) // Add route 'list'
detail(navController) // Add route 'detail/{data}'
}
// navigate to next screen
navController.detail(data) // Call NavController.navigate("detail/$data")
Set srcDirs
Android Studio does not automatically index generated codes by KSP. You have to add sourceSets manually.
Ref: https://github.com/google/ksp/issues/37
- build.gradle.kts
android {
// ...
applicationVariants.all {
val variantName = name
sourceSets {
getByName("main") {
java.srcDir(File("build/generated/ksp/$variantName/kotlin"))
}
}
}
}
- build.gradle
android {
// ...
applicationVariants.all { variant ->
variant.sourceSets.java.each {
it.srcDirs += "build/generated/ksp/${variant.name}/kotlin"
}
}
}
Download
plugins {
id("com.google.devtools.ksp") version "1.5.30-1.0.0"
}
dependencies {
implementation("androidx.navigation:navigation-compose:2.4.0-alpha10")
implementation("com.star-zero:compose-navgen:1.0.0-alpha01")
ksp("com.star-zero:compose-navgen-processor:1.0.0-alpha01")
}
License
Copyright 2021 Kenji Abe
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
95 Nov 25, 2022
23 May 8, 2021
13 Aug 29, 2022
76 Jan 3, 2023
53 Jan 1, 2023
2 Oct 25, 2021
67 Dec 29, 2022
0 Feb 15, 2022
5 May 18, 2022
283 Nov 11, 2022
20 Jul 8, 2020
2 Dec 3, 2021
634 Dec 28, 2022
528 Dec 28, 2022
4 Jul 29, 2022
321 Dec 27, 2022
565 Jan 2, 2023
667 Dec 22, 2022
512 Nov 20, 2022