navigation-screens/io.github.lukwol.navigation.screens

Package-level declarations

Types

Link copied to clipboard
actual class ScreensController
expect class ScreensController

Manages navigation between the screens declared when building ScreensNavigation.

actual class ScreensController
Link copied to clipboard
actual open class ScreensMapBuilder
expect open class ScreensMapBuilder

Builds screens navigation map.

actual open class ScreensMapBuilder

Properties

Link copied to clipboard
val LocalScreensController: ProvidableCompositionLocal<ScreensController>

Provides local ScreensController that can be used for pushing or popping screens from within currently displayed screen.

Link copied to clipboard
const val NavArgsKey: String

Key for which JSON encoded navigation arguments are stored in SavedStateHandle and are appended to screen route.

Functions

Link copied to clipboard
@Composable
actual fun ScreensNavigation(startRoute: String, enterTransition: AnimatedContentTransitionScope<*>.() -> EnterTransition, exitTransition: AnimatedContentTransitionScope<*>.() -> ExitTransition, popEnterTransition: AnimatedContentTransitionScope<*>.() -> EnterTransition, popExitTransition: AnimatedContentTransitionScope<*>.() -> ExitTransition, builder: ScreensMapBuilder.() -> Unit)
@Composable
expect fun ScreensNavigation(startRoute: String, enterTransition: AnimatedContentTransitionScope<*>.() -> EnterTransition = { fadeIn(animationSpec = tween(700)) }, exitTransition: AnimatedContentTransitionScope<*>.() -> ExitTransition = { fadeOut(animationSpec = tween(700)) }, popEnterTransition: AnimatedContentTransitionScope<*>.() -> EnterTransition = enterTransition, popExitTransition: AnimatedContentTransitionScope<*>.() -> ExitTransition = exitTransition, builder: ScreensMapBuilder.() -> Unit)

Defines screens navigation map by declaring all possible screens and their contents identified by their routes.

@Composable
actual fun ScreensNavigation(startRoute: String, enterTransition: AnimatedContentTransitionScope<*>.() -> EnterTransition, exitTransition: AnimatedContentTransitionScope<*>.() -> ExitTransition, popEnterTransition: AnimatedContentTransitionScope<*>.() -> EnterTransition, popExitTransition: AnimatedContentTransitionScope<*>.() -> ExitTransition, builder: ScreensMapBuilder.() -> Unit)