AndroidJetpack/voyager/docs/setup.md

Setup

1. Add Maven Central to your repositories if needed

   repositories {
       mavenCentral()
   }
   

2. Add the desired dependencies to your module's build.gradle file

=== "Dependencies"

```kotlin
dependencies {
    val voyagerVersion = "1.0.0"
    
    // Multiplatform
    
    // Navigator
    implementation("cafe.adriel.voyager:voyager-navigator:$voyagerVersion")
    
    // Screen Model
    implementation("cafe.adriel.voyager:voyager-screenmodel:$voyagerVersion")
    
    // BottomSheetNavigator
    implementation("cafe.adriel.voyager:voyager-bottom-sheet-navigator:$voyagerVersion")
    
    // TabNavigator
    implementation("cafe.adriel.voyager:voyager-tab-navigator:$voyagerVersion")
    
    // Transitions
    implementation("cafe.adriel.voyager:voyager-transitions:$voyagerVersion")
    
    // Android
    
    // Koin integration
    implementation("cafe.adriel.voyager:voyager-koin:$voyagerVersion")
    
    // Hilt integration
    implementation("cafe.adriel.voyager:voyager-hilt:$voyagerVersion")
    
    // LiveData integration
    implementation("cafe.adriel.voyager:voyager-livedata:$voyagerVersion")
    
    // Desktop + Android
    
    // Kodein integration
    implementation("cafe.adriel.voyager:voyager-kodein:$voyagerVersion")
    
    // RxJava integration
    implementation("cafe.adriel.voyager:voyager-rxjava:$voyagerVersion")
}
```

=== "Version Catalog"

```toml
[versions]
voyager = "1.0.0"

[libraries]
voyager-navigator = { module = "cafe.adriel.voyager:voyager-navigator", version.ref = "voyager" }
voyager-screenModel = { module = "cafe.adriel.voyager:voyager-screenmodel", version.ref = "voyager" }
voyager-bottomSheetNavigator = { module = "cafe.adriel.voyager:voyager-bottom-sheet-navigator", version.ref = "voyager" }
voyager-tabNavigator = { module = "cafe.adriel.voyager:voyager-tab-navigator", version.ref = "voyager" }
voyager-transitions = { module = "cafe.adriel.voyager:voyager-transitions", version.ref = "voyager" }
voyager-koin = { module = "cafe.adriel.voyager:voyager-koin", version.ref = "voyager" }
voyager-hilt = { module = "cafe.adriel.voyager:voyager-hilt", version.ref = "voyager" }
voyager-kodein = { module = "cafe.adriel.voyager:voyager-kodein", version.ref = "voyager" }
voyager-rxjava = { module = "cafe.adriel.voyager:voyager-rxjava", version.ref = "voyager" }
```

!!! note "Current version here."

Platform compatibility

Multiplatform targets: Android, iOS, Desktop, Mac Native, Web.

	Android	Desktop	Multiplatform
voyager-navigator	✅	✅	✅
voyager-screenModel	✅	✅	✅
voyager-bottom-sheet-navigator	✅	✅	✅
voyager-tab-navigator	✅	✅	✅
voyager-transitions	✅	✅	✅
voyager-koin	✅	✅	✅
voyager-kodein	✅	✅	✅
voyager-hilt	✅
voyager-rxjava	✅	✅
voyager-livedata	✅