https://github.com/adrielcafe/voyager
🛸 A pragmatic navigation library for Jetpack Compose
https://github.com/adrielcafe/voyager
android android-compose android-library android-navigation bottom-sheet bottomsheet compose deep-links deeplink jetpack-compose kotlin kotlin-android navigation navigator router stack tab-navigation transition-animation transitions
Last synced: 5 days ago
JSON representation
🛸 A pragmatic navigation library for Jetpack Compose
- Host: GitHub
- URL: https://github.com/adrielcafe/voyager
- Owner: adrielcafe
- License: mit
- Created: 2021-07-19T22:57:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T19:44:34.000Z (29 days ago)
- Last Synced: 2025-04-09T22:07:50.653Z (5 days ago)
- Topics: android, android-compose, android-library, android-navigation, bottom-sheet, bottomsheet, compose, deep-links, deeplink, jetpack-compose, kotlin, kotlin-android, navigation, navigator, router, stack, tab-navigation, transition-animation, transitions
- Language: Kotlin
- Homepage: https://voyager.adriel.cafe
- Size: 20.2 MB
- Stars: 2,787
- Watchers: 21
- Forks: 149
- Open Issues: 177
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-list - adrielcafe/voyager - 🛸 A pragmatic navigation library for Jetpack Compose (Kotlin)
- kmp-awesome - Voyager
- jetpack-compose-awesome - voyager - A pragmatic navigation library for Jetpack Compose (Articles / Navigation)
- jetpack-compose-awesome - voyager - A pragmatic navigation library for Jetpack Compose (Articles / Navigation)
- mobile-awesome - voyager - 🛸 A pragmatic navigation library for Jetpack Compose. (Multiplatform / Android samples)
README
[](https://repo.maven.apache.org/maven2/cafe/adriel/voyager/)
[](https://android-arsenal.com/api?level=21)
[](https://kotlinlang.org/)
[](https://ktlint.github.io/)
[](LICENSE.md)
Voyager: Compose on Warp Speed
A multiplatform navigation library built for, and seamlessly integrated with, [Jetpack Compose](https://developer.android.com/jetpack/compose).
Create scalable Single-Activity apps powered by a [pragmatic API](https://voyager.adriel.cafe/navigation):
```kotlin
class HomeScreenModel : ScreenModel {
// ...
}
class HomeScreen : Screen {
@Composable
override fun Content() {
val screenModel = rememberScreenModel()
// ...
}
}
class SingleActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContent {
Navigator(HomeScreen())
}
}
}
```
Turn on the Warp Drive and enjoy the voyage 🖖
### Documentation
See the [project website](https://voyager.adriel.cafe) for documentation and APIs.
### Features
- [Supported platforms](https://voyager.adriel.cafe/setup#platform-compatibility): Android, iOS, Desktop, Web.
- [Linear navigation](https://voyager.adriel.cafe/navigation)
- [BottomSheet navigation](https://voyager.adriel.cafe/navigation/bottomsheet-navigation)
- [Tab navigation](https://voyager.adriel.cafe/navigation/tab-navigation) like [Youtube app](https://play.google.com/store/apps/details?id=com.google.android.youtube)
- [Nested navigation](https://voyager.adriel.cafe/navigation/nested-navigation) (multiple stacks, parent navigation)
- [ScreenModel](https://voyager.adriel.cafe/screenmodel) (a.k.a ViewModel) integrated with [Koin](https://voyager.adriel.cafe/screenmodel/koin-integration), [Kodein](https://voyager.adriel.cafe/screenmodel/kodein-integration), [Hilt](https://voyager.adriel.cafe/screenmodel/hilt-integration), [Coroutines](https://voyager.adriel.cafe/screenmodel/coroutines-integration), [RxJava](https://voyager.adriel.cafe/screenmodel/rxjava-integration), [LiveData](https://voyager.adriel.cafe/screenmodel/livedata-integration)
- [Android ViewModel](https://voyager.adriel.cafe/android-viewmodel) integration (with [Hilt support](https://voyager.adriel.cafe/android-viewmodel/hilt-integration))
- Type-safe [multi-module navigation](https://voyager.adriel.cafe/navigation/multi-module-navigation)
- State-aware [Stack API](https://voyager.adriel.cafe/stack-api)
- Built-in [transitions](https://voyager.adriel.cafe/transitions)
- [State restoration](https://voyager.adriel.cafe/state-restoration) after Activity recreation
- [Lifecycle](https://voyager.adriel.cafe/lifecycle) callbacks
- [Back press](https://voyager.adriel.cafe/back-press) handling
- [Deep linking](https://voyager.adriel.cafe/deep-links) support
### Samples
| [Stack API](https://github.com/adrielcafe/voyager/tree/main/samples/android/src/main/java/cafe/adriel/voyager/sample/stateStack) | [Android ViewModel](https://github.com/adrielcafe/voyager/tree/main/samples/android/src/main/java/cafe/adriel/voyager/sample/androidViewModel) | [ScreenModel](https://github.com/adrielcafe/voyager/tree/main/samples/android/src/main/java/cafe/adriel/voyager/sample/screenModel) | [Basic nav.](https://github.com/adrielcafe/voyager/tree/main/samples/android/src/main/java/cafe/adriel/voyager/sample/basicNavigation) |
|----------|----------|----------|----------|
|  |  |  |  |
| [BottomSheet nav.](https://github.com/adrielcafe/voyager/tree/main/samples/android/src/main/java/cafe/adriel/voyager/sample/bottomSheetNavigation) | [Tab nav.](https://github.com/adrielcafe/voyager/tree/main/samples/android/src/main/java/cafe/adriel/voyager/sample/tabNavigation) | [Multi-module nav.](https://github.com/adrielcafe/voyager/tree/main/samples/multi-module) | [Nested nav.](https://github.com/adrielcafe/voyager/tree/main/samples/android/src/main/java/cafe/adriel/voyager/sample/nestedNavigation) |
|----------|----------|----------|----------|
|  |  |  |  |