Kotlin Multiplatform

https://www.jetbrains.com/help/kotlin-multiplatform-dev/
Admin
Kotlin Multiplatform is a technology for sharing code across different platforms like Android, iOS,...
Tokens:2,141
Snippets:19
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Navigate to a Destination using Kotlin

Source: https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-navigation

Demonstrates how to trigger navigation to a defined destination using the `NavController.navigate()` function. This is typically done within a UI element's click handler, such as a `Button`.

```kotlin
Button(onClick = { navController.navigate(Profile) }) {
    Text("Go to profile")
}
```

--------------------------------

### Configure NavHost Transitions in Kotlin Multiplatform

Source: https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-navigation

This snippet demonstrates how to explicitly define enter and exit transitions for a NavHost in Kotlin Multiplatform. Specifying these transitions overrides the default back gesture animations, allowing for custom animations like slide transitions.

```kotlin
NavHost(
    navController = navController,
    startDestination = Profile,
    // Explicitly specifying transitions turns off default animations
    // in favor of the selected ones
    enterTransition = { slideInHorizontally() },
    exitTransition = { slideOutVertically() }
) { ... }
```

--------------------------------

### Pass Arguments to a Destination using Kotlin

Source: https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-navigation

Shows how to define a route with parameters using a data class and pass arguments when navigating to that destination. The arguments are then retrieved at the destination using `backStackEntry.toRoute()`.

```kotlin
@Serializable
data class Profile(val name: String)

Button(onClick = { navController.navigate(Profile("Alice")) }) {
    Text("Go to profile")
}

composable<Profile> { backStackEntry ->
    val profile: Profile = backStackEntry.toRoute()

    // Use `profile.name` wherever a user's name is needed
}
```

--------------------------------

### Define Navigation Routes and Graph using Kotlin

Source: https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-navigation

Defines serializable routes for navigation destinations and sets up a `NavHost` composable to manage the navigation graph. It requires the `navigation-compose` dependency. This snippet illustrates the foundational structure for app navigation.

```kotlin
// Creates routes
@Serializable
object Profile
@Serializable
object FriendsList

// Creates the NavController
val navController = rememberNavController()

// Creates the NavHost with the navigation graph consisting of supplied destinations
NavHost(navController = navController, startDestination = Profile) {
    composable<Profile> { ProfileScreen( /* ... */ ) }
    composable<FriendsList> { FriendsListScreen( /* ... */ ) }
    // You can add more destinations similarly
}
```

--------------------------------

### Disable Back Gesture on iOS in Kotlin Multiplatform

Source: https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-navigation

This code shows how to disable the default back gesture handler on iOS within a Kotlin Multiplatform application. By setting `enableBackGesture = false` in the `ViewController` configuration, the native back swipe gesture will no longer trigger navigation.

```kotlin
ComposeUIViewController(
    configure = { enableBackGesture = false }
) {
    App()
}
```
Tokens:
Raw