Kotlin multi-platform application navigation library. Supports Jetpack Compose.
val navigator = rememberNavigatorByKey("Greeting") { key ->
when (key) {
"Greeting" -> Text("Hello")
"Farewell" -> Text("Good-bye")
else -> Text("Unexpected Key: $key")
}
}
navigator.goTo("Farewell")Navigation is handled differently for each platform and UI framework. This library provides some common navigation components that serve as a recommended structure, but each platform and UI framework is independently responsible for handling navigation and choosing whether to conform to the provided components.
There are three different ComposeNavigators that can handle navigation in Jetpack Compose. Which one to use depends on
the application needs and personal preference.
This approach allows for specifying the @Composable content on demand, rather than up-front.
val navigator = rememberNavigatorByContent("Greeting") { Text("Hello") }
// The NavContainer will start by displaying the initial content, which in this case is "Hello".
NavContainer(navigator)
// The above NavContainer will display "Good-bye" after the following call:
navigator.goTo("Farewell") { Text("Good-bye") }
// Goes back to the initial content: "Hello":
navigator.goBack()This approach allows for specifying the @Composable content for each key up-front. Then navigation can be done by
simply providing a key.
val navigator = rememberNavigatorByKey("Greeting") { key ->
when (key) {
"Greeting" -> Text("Hello")
"Farewell" -> Text("Good-bye")
else -> Text("Unexpected Key: $key")
}
}
// The NavContainer will start by displaying the initial content, which in this case is "Hello"
NavContainer(navigator)
// The above NavContainer will display "Good Bye" after the following call:
navigator.goTo("Farewell")
// Goes back to the initial content: "Hello":
navigator.goBack()This approach is similar to the key approach, but the key is a NavigationIntent and the returned ComposeNavigator
implements the NavigationEventNavigator interface from the core module.
val navigator = rememberNavigatorByIntent(HomeNavigationIntent.Greeting) { navigationIntent ->
when (navigationIntent) {
HomeNavigationIntent.Greeting -> Text("Hello")
HomeNavigationIntent.Farewell -> Text("Good-bye")
}
}
// The NavContainer will start by displaying the initial content, which in this case is "Hello"
NavContainer(navigator)
// The above NavContainer will display "Good Bye" after the following call:
navigator.goTo(HomeNavigationIntent.Farewell)
// Goes back to the initial content: "Hello":
navigator.goBack()To create a Navigator use one the provided navigator() functions. For instance:
val navigator = navigator<NavigationIntent>(activity = activity, onGoTo = { navigationIntent ->
activity.startActivity(...)
})
navigator.goBack()The library is provided through Repsy.io. Checkout
the releases page to get the latest version.
repositories {
maven {
url = uri("https://repo.repsy.io/mvn/chrynan/public")
}
}implementation("com.chrynan.navigation:navigation-core:VERSION")implementation("com.chrynan.navigation:navigation-compose:VERSION")More detailed documentation is available in the docs folder. The entry point to the documentation can be found here.
Copyright 2021 chRyNaN
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:https://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.