Compose Navigation
This library will make it easier to pass arguments between screens in Jetpack Compose
Setup
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'com.github.doctor-blue:compose-navigation:1.1.0'
}
How to use?
Step 1: Create your screen class and extend it with ComposeScreen class
- Example: I have 3 screens (MainScreen, Screen1, Screen2). As you can see the _route variable is my screen name
mport com.devcomentry.lib.ComposeScreen
sealed class Screen(_route: String) : ComposeScreen(_route) {
object MainScreen : Screen("main_screen")
object Screen1 : Screen("screen1")
object Screen2 : Screen("screen2")
}
Step 2: Create a class and implement it with Argument interface. Variables in this class is your argument you wanna pass to other screen.
- Example: I want to pass a number from MainScreen to Screen2. More variables means more arguments
package com.devcomentry.composenavigation.ui.screen
import com.devcomentry.lib.Argument
data class Screen2Argument(val number: Int = -1) : Argument
Step 3: Setup your navigation
- Same as using navigation component, but at the composable function you can give ComposeScreen and Argument object, let me help you with the rest.
- Support get argument from Bundle or SavedStateHandle. If Bundle or SavedStateHandle object doen't contains key argument will be default of Argument object
package com.devcomentry.composenavigation
import android.os.Bundle
import androidx.activity.compose.setContent
import androidx.appcompat.app.AppCompatActivity
import androidx.compose.material.MaterialTheme
import androidx.compose.material.Surface
import androidx.navigation.compose.NavHost
import androidx.navigation.compose.rememberNavController
import com.devcomentry.composenavigation.ui.screen.*
import com.devcomentry.lib.composable
import com.devcomentry.lib.from
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContent {
Surface {
Surface(
color = MaterialTheme.colors.background,
) {
val navController = rememberNavController()
NavHost(
navController = navController,
startDestination = Screen.MainScreen.route
) {
composable(Screen.MainScreen) {
MainScreen(navController = navController)
}
composable(Screen.Screen1) {
Screen1()
}
composable(Screen.Screen2, Screen2Argument()) {
// get data from arguments
it.arguments?.let { bundle->
val argument = Screen2Argument().from(bundle)
Screen2(argument)
}
}
}
}
}
}
}
}
Step 4: Navigate to other screen
- Example 1: just open Screen1
navController.navigate(Screen.Screen1.route)
- Example 2: pass random number to Screen2
navController.navigate(
Screen.Screen2.setParam(
Screen2Argument(
Random.nextInt(
0,
50
)
)
)
)
Note
- You can get Argument object from arguments (Instance of Bundle) like example above.
val argument = Screen2Argument().from(bundle)
// use your argument
- Or get data from SavedStateHandle like this
val argument = Screen2Argument().from(savedStateHandle)
// use your argument
Want more an example?
- See Note app
Donate
3 Dec 31, 2022
1 Aug 11, 2022
180 Jan 2, 2023
5 Apr 5, 2022
3 Dec 15, 2022
5 Dec 29, 2022
3 Dec 21, 2022
44 Dec 10, 2022
3 May 15, 2022
4.9k Dec 31, 2022
178 Jan 4, 2023
64 Oct 13, 2022
0 Dec 8, 2021
20 Dec 22, 2022
56 Dec 22, 2022
38 Sep 25, 2022
186 Jan 1, 2023
382 Jan 5, 2023