safer-navigation-compose

safer-navigation-compose copied to clipboard

Safer Jetpack Compose Navigation Extension

Type-safe extension library for the official Jetpack Compose Navigation library with Serializable data classes support.

This library is trying to solve many of the androidx.navigation:navigation-compose flaws, i.e. you can't send a class when navigating, no type-safety and boilerplate setup.

Features

• Navigating and getting data with type-safe manner.
• The library is just an extension on top of the navigation-compose library, so you can partially adopt it.
• Easy migration path, you only need to modify a small amount of code in an existing codebase to get started.
• Every features from the official library are still available, like nested navigation graph, deep links, etc.
• Accompanist Navigation Animation supported in a separate artifact.
• No annotation processor like kapt or KSP required.
• Based on Kotlinx.Serialization plugin.

Setup

Add JitPack repository to your project's settings.gradle file.

dependencyResolutionManagement {
    // ...

    repositories {
        // ...
        maven { url "https://www.jitpack.io" }
    }
}

Add Kotlinx.Serialization plugin to your project's build.gradle file.

plugins {
    // Adjust with your project's Kotlin compiler version
    id("org.jetbrains.kotlin.plugin.serialization") version "1.8.10" apply false
}

Add the library and Kotlinx.Serialization dependencies to your project's :app module build.gradle file.

plugins {
    id("org.jetbrains.kotlin.plugin.serialization")
}

// ...

dependencies {
    def safer_navigation_version = "1.2.0"
    // NOTE: You only need to add ONE of these that your project currently use to avoid wrong extension to import
    
    // Navigation Compose support
    implementation("com.github.uragiristereo.safer.navigation.compose:navigation-compose:$safer_navigation_version")

    // Or, Accompanist Navigation Animation support
    implementation("com.github.uragiristereo.safer.navigation.compose:navigation-animation:$safer_navigation_version")
}

Usage

Refer to the quick start guide page.

Available extension functions

• Core
  • NavGraphBuilder.dialog()
  • NavHostController.navigate()
  • NavOptionsBuilder.popUpTo()
  • SavedStateHandle.getData()
• Navigation Compose
  • NavHost()
  • NavGraphBuilder.composable()
  • NavGraphBuilder.navigation()
• Accompanist Navigation Animation
  • AnimatedNavHost()
  • NavGraphBuilder.composable()
  • NavGraphBuilder.navigation()

License

This project is distributed under the terms of the BSD-4-Clause License. See the license for more information.