usage.md

Usage

Overview

The integration comes with a simple API for easier usage of Jetpack Navigation. The API is available under the package shared.presentation.navigation.

Create Destination

To create your own destination, utilize the provided template app.presentation.template.screen_with_args.TemplateDestination.

object TemplateDestination : NavigationDestination<TemplateDestination.Data>() {

    /** Unique identifier for this destination. */
    override val id: String = "template_screen"
    /** Strategy for navigation behavior. */
    override val navStrategy: NavigationStrategy = NavigationStrategy.NewInstance
    /** Strategy for handling arguments associated with this destination. */
    override val argsStrategy: ArgsStrategy<Data> = ArgsStrategy.json(Data.serializer())
    /** Binds this destination to the provided NavGraphBuilder, using one of the available methods (composable, dialog, navigation). */
    override fun doBind(builder: NavGraphBuilder) = composable(builder) { TemplateScreen(it) }
    
    /**
     * Data class representing the arguments for the template destination.
     */
    @Serializable
    data class Data(
        val title: String
    )
}

Register Destination

All app destinations should be registered within an instance of the class shared.presentation.navigation.NavigationStore. This instance is already pre-configured in dependency injection (DI) through the app.di.presentation.NavigationModule class. Simply place all your destinations within this instance.

val navigationModule = module {
    single {
        NavigationStore(
            destinations = listOf(
                ShowcasesDestination,
                TemplateDestination,
                TemplateNoArgsDestination,
                ChangeThemeDestination,
                ChangeThemeDialogDestination,
                NavigationADestination,
                NavigationBDestination,
                NavigationCDestination,
            )
        )
    }
}

Navigate to Destination

Once the navigation is aware of the destinations, you can initiate navigation to them using the onBack and onNext methods available in the shared.presentation.navigation.NavigationStore class. Simply inject NavigationStore into your ViewModel or other dependency injection managed class, and navigate whenever necessary.

class HomeViewModel(
    private val navigationStore: NavigationStore
) : BaseViewModel() {

    fun onBack() {
        navigationStore.onBack()
    }
    
    fun onShowSettings() {
        navigationStore.onNext(SettingsDestination)
    }

}

Set Initial Destination

When the app is first opened, you need to provide NavigationStore with an initial destination. It can be done in pre-configured AppNavigationRouter class.

class AppNavigationRouter() {

    fun getStartDestination(): NavigationDestination<*> {
        return ShowcasesDestination
    }

}