Easiest routing for compose-jb
Supported targets:
- Jvm
- Js
Installation
repositories {
mavenCentral()
}
dependencies {
implementation("io.github.artemmey:compose-jb-routing:0.9.2-a2")
}
Usage
- Declare your app routes:
object MyAppRoute {
const val Home = "/"
const val Articles = "/articles"
// {id} is route param
const val Article = "$Articles/{id}"
}
- Configure routing
@Composable
fun App() {
initRouting(MyAppRoute.Home)
Router {
// `exact = true` means that current location matches exactly the given route.
route(MyAppRoute.Home, exact = true) { Home() }
// Default value of `exact` (false) means that current location can be any of those that starts with the given route. In this example location matches "/articles.*"
route(MyAppRoute.Articles) { Articles() }
}
}
@Composable
fun Articles() {
// Nested routing
Router {
route(MyAppRoute.Articles, exact = true) { ArticleList() }
// Obtaining {id} param
route(MyAppRoute.Article) { Article(param("id")) }
}
}
- Perform routing
@Composable
fun ArticleList() {
articles.forEach {
ArticlePreview(onClick = {
// Navigate to next location and add current to the back stack
routing.push(MyAppRoute.Article, "id" to it.id)
// Here we can see the back stack
println(routing.history)
})
}
}
@Composable
fun Article(id: String) {
BackButton(onClick = {
// Navigate to prev location
routing.pop()
})
}
- Make redirects
@Composable
fun PrivateRoute() {
if (!auth) {
// Redirecting to login and setting current location as ref
Redirect("${MyAppRoute.Login}?ref=${routing.location}")
return
}
}
@Composable
fun Login() {
LoginButton(onClick = {
performLogin()
// If have ref - redirecting back to it, else - just navigate back
routing.location.query()["ref"]
?.let { routing.redirect(it) }
?: routing.pop()
})
}