ComposableRoutes
This library is a helper for the Android Compose Navigation routes:
- generates routes for the annotated screens
- provides helpers to register routes in the
NavController - reduces boiler-plate code for arguments parsing
- and more...
How does it work?
Add annotation to the Compose screen:
@Composable
@ComposableRoute
fun HomeScreen() {
// ...
}
@Composable
@ComposableRoute
fun ContactScreen(id: String) { // required parameter
// ...
}
@Composable
@ComposableRoute
fun AboutScreen(overrideTitle: String?) { // optional parameter
// ...
}
Build your project and it will automatically generate NavRoutes object.
The next step is to register this route:
val navController = rememberNavController()
NavHost(navController = navController, startDestination = NavRoutes.HomeScreen.PATH) {
NavRoutes.HomeScreen.register(this)
NavRoutes.ContactScreen.register(this)
NavRoutes.AboutScreen.register(this)
}
NavRoutes also provides a helper to register all generated routes with one call:
val navController = rememberNavController()
NavHost(navController = navController, startDestination = NavRoutes.HomeScreen.PATH) {
NavRoutes.registerAll(this)
}
There are few ways to navigate to the specified route:
// NavController.navigate
navController.navigate(NavRoutes.HomeScreen())
// generated navigateToXXX helpers
navController.navigateToHomeScreen()
// required arguments
navController.navigateToContactScreen(id = "1")
// optional arguments
navController.navigateToAboutScreen(overrideTitle = "Ny About Title")
navController.navigateToAboutScreen()
Library supports following type of arguments:
- primitives -
Boolean,Int,Float, etc.) StringsParcelableobjectsSerializableobjects
How to pass NavController to the Screen?
Usually you can just pass NavController to the Screen when registering it with the HavHost. Unfortunately, this is not possible - this library will only propagate arguments available in the route. But there is a very easy solution to this problem.
One of the solutions is to use CompositionLocalProvider. The first step is to declare our CompositionLocal key for the provider:
val LocalNavController = compositionLocalOf<NavHostController> {
error("NavController was not provided")
}
Then we need to add this key to the provider:
val navController = rememberNavController()
CompositionLocalProvider(LocalNavController provides navController) {
NavHost(navController = navController, startDestination = NavRoutes.JoinAsGuestScreen()) {
NavRoutes.registerAll(this)
}
}
That's it. Now you can get NavController in any descendant @Composable function like this:
LocalNavController.current.navigateToHomeScreen()
Add to your project
To add this library into your project:
Step 1. Add a JitPack repository to your root build.gradle:
allprojects {
repositories {
maven(url = "https://jitpack.io")
}
}
Step 2. Add library and compiler dependencies:
dependencies {
implementation("com.github.MatrixDev.ComposableRoutes:composable-routes-lib:{latest}")
kapt("com.github.MatrixDev.ComposableRoutes:composable-routes-processor:{latest}")
}
More info can be found at https://jitpack.io/#MatrixDev/ComposableRoutes
TODO
These are just few more nice things to have in the future:
- Migrate from KAPT to KSP
License
MIT License
Copyright (c) 2018 Rostyslav Lesovyi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
13 Aug 31, 2022
10 Nov 16, 2022
31 Dec 24, 2022
452 Jan 1, 2023
34 Nov 4, 2022
9 Nov 3, 2022
588 Dec 27, 2022
9 Jul 5, 2022
59 Oct 19, 2022
6 Jul 13, 2022
4 Oct 10, 2022
1.9k Jan 5, 2023
168 Jan 5, 2023
5 Oct 28, 2022
43 Jan 1, 2023
55 Jan 3, 2023
3 Sep 15, 2021
10 Dec 28, 2022