navigation-compose/com.episode6.typed2.navigation.compose

Package-level declarations

Types

typealias AsyncNavArg<T, BACKED_BY> = AsyncKey<T, BACKED_BY, PrimitiveKeyValueGetter, PrimitiveKeyValueSetter>

ComposeNavArgBuilder

class ComposeNavArgBuilder : PrimitiveKeyValueSetter

IllegalStartScreenException

class IllegalStartScreenException(screen: NavScreen) : IllegalArgumentException

MissingRequiredArgumentException

class MissingRequiredArgumentException(arg: KeyDescriptor<*, *>, screen: NavScreen) : IllegalArgumentException

typealias NavArg<T, BACKED_BY> = Key<T, BACKED_BY, PrimitiveKeyValueGetter, PrimitiveKeyValueSetter>

interface NavArgBuilder : PrimitiveKeyBuilder

open class NavScreen(val name: String, argPrefix: String = "") : RequiredEnabledKeyNamespace

object NavScreenRoute

UnexpectedKeyTypeException

class UnexpectedKeyTypeException(type: KClass<*>) : RuntimeException

Functions

composableScreen

fun NavGraphBuilder.composableScreen(screen: NavScreen, deepLinks: List<NavDeepLink> = emptyList(), content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit)

launchNavigateTo

fun NavController.launchNavigateTo(screen: NavScreen, scope: CoroutineScope, args: suspend ComposeNavArgBuilder.() -> Unit): Job

fun NavHost(navController: NavHostController, startScreen: NavScreen, modifier: Modifier = Modifier, builder: NavGraphBuilder.() -> Unit)

fun NavController.navigateTo(screen: NavScreen)

inline fun NavController.navigateTo(screen: NavScreen, args: ComposeNavArgBuilder.() -> Unit)

Replacement for NavController.navigate that allows type-safe setting of arguments Usage: navController.navigateTo(Screen) { set(Screen.Arg1, "someValue") set(Screen.Arg2, 42) }

fun ComposeNavArgBuilder.remove(key: AsyncNavArg<*, *>)

fun ComposeNavArgBuilder.remove(key: NavArg<*, *>)

suspend fun <T> ComposeNavArgBuilder.set(key: AsyncNavArg<T, *>, value: T)

fun <T> ComposeNavArgBuilder.set(key: NavArg<T, *>, value: T)