Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xxfast/Decompose-Router
A Compose-multiplatform navigation library that leverage Decompose to create an API inspired by Conductor
https://github.com/xxfast/Decompose-Router
android compose-multiplatform decompose jetpack-compose kotlin kotlin-multiplatform navigation
Last synced: 3 months ago
JSON representation
A Compose-multiplatform navigation library that leverage Decompose to create an API inspired by Conductor
- Host: GitHub
- URL: https://github.com/xxfast/Decompose-Router
- Owner: xxfast
- Created: 2023-02-09T08:16:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-19T05:23:57.000Z (5 months ago)
- Last Synced: 2024-07-12T19:02:14.149Z (4 months ago)
- Topics: android, compose-multiplatform, decompose, jetpack-compose, kotlin, kotlin-multiplatform, navigation
- Language: Kotlin
- Homepage: https://xxfast.github.io/Decompose-Router/
- Size: 29.6 MB
- Stars: 221
- Watchers: 4
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- mobile-awesome - Decompose-Router - A Compose-multiplatform navigation library that leverage Decompose to create an API inspired by Conductor. (Multiplatform / Multiplatform libraries)
- kmp-awesome - Decompose-Router - navigation (Libraries / 🏗 Architecture)
README
# Decompose Router
[](https://kotlinlang.org/docs/components-stability.html)
[](https://github.com/xxfast/Decompose-Router/actions/workflows/build.yml)
[](https://kotlinlang.org)
[](https://search.maven.org/search?q=g:io.github.xxfast)
A Compose-multiplatform navigation library that leverage [Decompose](https://github.com/arkivanov/Decompose) to create an API inspired by [Conductor](https://github.com/bluelinelabs/Conductor)
A detailed breakdown available in this [Medium article](https://proandroiddev.com/diy-compose-multiplatform-navigation-with-decompose-94ac8126e6b5)
## Features
- 🚏 A `Router` that manages a stack, pages or slot for your screen configurations
- 📦 `rememberOnRoute()` lets you retain your view model across configuration changes and gets cleared when the user leaves the screen
- 🚉 Multiplatform! Supports Android, WearOS, Desktop, iOS and Web
## At a glance
```kotlin
// Declare your screen configurations for type-safety
@Serializable
sealed class Screen {
object List : Screen()
data class Details(val detail: String) : Screen()
}
@Composable
fun ListDetailScreen() {
// Create a router with a stack of screen configurations 🚏
val router: Router = rememberRouter { listOf(List) }
// Hoist your screens for each configuration 🏗️
RoutedContent(router = router) { screen ->
when (screen) {
List -> ListScreen(
// Navigate by pushing new configurations on the router 🧭
onSelectItem = { detail -> router.push(detail) }
)
is Details -> DetailsScreen(screen.detail)
}
}
}
```
### Installation
Decompose-Router is published on Maven Central. Latest version [](https://search.maven.org/search?q=g:io.github.xxfast)
```kotlin
repositories {
mavenCentral()
// or for snapshot builds
maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
```
> **Note** - Check for compatible versions of Decompose and Compose in the [version catalog](gradle/libs.versions.toml)
```toml
[versions]
decompose-router = ""
[libraries]
# For Jetpack Compose / Compose Multiplatform
decompose-router = { module = "io.github.xxfast:decompose-router", version.ref = "decompose-router" }
# For Compose Wear
decompose-router-wear = { module = "io.github.xxfast:decompose-router-wear", version.ref = "decompose-router" }
```
Read more
- Documentation [here](https://xxfast.github.io/Decompose-Router/)
- API Reference [here](https://xxfast.github.io/Decompose-Router//docs/)
## Licence
Copyright 2024 Isuru Rajapakse
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.