navigation-compose-screen

Screen object support for navigation-compose

Requirements

Android Gradle Plugin 8.3.0 or later
Jetpack Compose 1.5.4
navigation-compose 2.7.1
Kotlin 1.9.22
minimum SDK version 23 (Android 6.0)

What can I do?

Provide type safe navigation to navigation-compose

// screenBaseClass is optional
@AutoScreenId(
    "ExampleScreen",
    screenBaseClass = MyScreen::class,
)
enum class ExampleScreenId {
    // Deep Link support
    @Route(
        "/",
        deepLinks = ["https://takuji31.jp/compose-navigation/"],
    )
    Home,

    // arguments support
    @Route(
        "/blog/{blogId}",
        stringArguments = [StringArgument("blogId")],
    )
    Blog,

    // auto argument type is String
    @Route("/blog/{blogId}/entry/{entryId}")
    Entry,

    // enum type arguments supported
    @Route(
        "/ranking/?rankingType={rankingType}",
        enumArguments = [
            EnumArgument(
                "rankingType",
                RankingType::class,
                hasDefaultValue = true,
                "daily",
            ),
        ],
    )
    Ranking,

    @Route("/settings")
    Settings,
}

You can use generated screen code in your code!

@Composable
fun Main(navController: ScreenNavController) { // val navController = rememberScreenNavController()
    val currentScreen by navController.currentScreen.collectAsState()
    ScreenNavHost(
        navController = navController,
        startScreen = ExampleScreen.Home,
    ) {
        val onBottomSheetItemClicked: (ExampleScreen) -> Unit = { screen ->
            navController.navigate(screen) {
                popUpTo(ExampleScreenId.Home) { inclusive = screen == ExampleScreen.Home }
            }
        }
        exampleScreenComposable {
            home { screen ->
                val viewModel = navViewModel<HomeViewModel>()
                val state by viewModel.state.collectAsState()
                Home(
                    state = state,
                    screen = screen,
                    onBottomSheetItemClicked = onBottomSheetItemClicked,
                    onReloadButtonClick = { viewModel.reload() },
                    onItemClick = { navController.navigate(ExampleScreen.Blog(it.id)) },
                )
            }
            blog { screen ->
                val viewModel = navViewModel<BlogViewModel>()
                val state by viewModel.state.collectAsState()
                Blog(
                    state = state,
                    screen = screen,
                    onReloadButtonClick = { viewModel.reload() },
                    onItemClick = {
                        navController.navigate(
                            ExampleScreen.Entry(
                                screen.blogId,
                                it.id,
                            ),
                        )
                    },
                )
            }
            // ...
        }
    }
}

Setup

Add JitPack to your repositories

allprojects {
    repositories {
        google()
        jcenter()
        maven { url 'https://jitpack.io' } // or maven("https://jitpack.io") in Kotlin DSL
    }
}

Apply kapt plugin

plugins {
    id("com.android.library")
    id("kotlin-kapt") // or kotlin("kapt") in Kotlin DSL
}

Add dependencies

dependencies {
    implementation("com.github.takuji31.navigation-compose-screen:navigation-compose-screen:+")
    kapt("com.github.takuji31.navigation-compose-screen:compiler:+")
}

Crash with deeplink navigation

I faced a crash when trying deeplink navigation in the sample code for this project.

navController.navController.navigate("compose-navigation-example://blog.takuji31.jp/blog/${it.id}".toUri())

Crash Log

java.lang.IllegalStateException: Screen factory for route[/blog/{blogId}] not registered.
        at jp.takuji31.compose.navigation.screen.ScreenFactoryRegistry.findByRoute(ScreenFactoryRegistry.kt:16)
        at jp.takuji31.compose.navigation.screen.ScreenNavController$1.onDestinationChanged(ScreenNavController.kt:20)
        at androidx.navigation.NavController.dispatchOnDestinationChanged(NavController.kt:861)
        at androidx.navigation.NavController.navigate(NavController.kt:1641)
        at androidx.navigation.NavController.navigate(NavController.kt:1577)
        at androidx.navigation.NavController.navigate(NavController.kt:1545)
        at androidx.navigation.NavController.navigate(NavController.kt:1528)
        at androidx.navigation.NavController.navigate(NavController.kt:1475)
        at jp.takuji31.compose.navigation.example.ui.MainKt$Main$1$1$1$4.invoke(Main.kt:53)
        at jp.takuji31.compose.navigation.example.ui.MainKt$Main$1$1$1$4.invoke(Main.kt:51)
        at jp.takuji31.compose.navigation.example.ui.HomeKt$Home$2$1$1$1.invoke(Home.kt:69)
        at jp.takuji31.compose.navigation.example.ui.HomeKt$Home$2$1$1$1.invoke(Home.kt:69)

Also, if initialized Screen and called the ScreenFactoryRegistry before the deeplink navigation, it didn't crash.

ExampleScreen.Blog(it.id)
navController.navController.navigate("compose-navigation-example://blog.takuji31.jp/blog/${it.id}".toUri())

takuji31 / navigation-compose-screen Goto Github PK

navigation-compose-screen's Introduction

navigation-compose-screen

Requirements

What can I do?

Setup

navigation-compose-screen's People

Contributors

Stargazers

Watchers

Forkers

navigation-compose-screen's Issues

Overview

Repository problems

Rate-Limited

Open

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org