Package-level declarations
Types
Link copied to clipboard
object NavDisplay
Object that indicates the features that can be handled by the NavDisplay
Properties
Link copied to clipboard
Local provider of AnimatedContentScope to NavEntry.Content.
Functions
Link copied to clipboard
fun <T : Any> defaultPopTransitionSpec(): AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform
Default transitionSpec for pop navigation to be used by NavDisplay.
Link copied to clipboard
fun <T : Any> defaultPredictivePopTransitionSpec(): AnimatedContentTransitionScope<Scene<T>>.(Int) -> ContentTransform
Link copied to clipboard
fun <T : Any> defaultTransitionSpec(): AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform
Default transitionSpec for forward navigation to be used by NavDisplay.
Link copied to clipboard
fun <T : Any> NavDisplay(sceneState: SceneState<T>, navigationEventState: NavigationEventState<SceneInfo<T>>, modifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, sizeTransform: SizeTransform? = null, transitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = defaultTransitionSpec(), popTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = defaultPopTransitionSpec(), predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.(Int) -> ContentTransform = defaultPredictivePopTransitionSpec())
fun <T : Any> NavDisplay(entries: List<NavEntry<T>>, modifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, sceneStrategies: List<SceneStrategy<T>> = listOf(SinglePaneSceneStrategy()), sceneDecoratorStrategies: List<SceneDecoratorStrategy<T>> = emptyList(), sharedTransitionScope: SharedTransitionScope? = null, sizeTransform: SizeTransform? = null, transitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = defaultTransitionSpec(), popTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = defaultPopTransitionSpec(), predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.(Int) -> ContentTransform = defaultPredictivePopTransitionSpec(), onBack: () -> Unit)
fun <T : Any> NavDisplay(backStack: List<T>, modifier: Modifier = Modifier, contentAlignment: Alignment = Alignment.TopStart, onBack: () -> Unit = {
if (backStack is MutableList<T>) {
backStack.removeLastOrNull()
}
}, entryDecorators: List<NavEntryDecorator<T>> = listOf(rememberSaveableStateHolderNavEntryDecorator()), sceneStrategies: List<SceneStrategy<T>> = listOf(SinglePaneSceneStrategy()), sceneDecoratorStrategies: List<SceneDecoratorStrategy<T>> = emptyList(), sharedTransitionScope: SharedTransitionScope? = null, sizeTransform: SizeTransform? = null, transitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = defaultTransitionSpec(), popTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = defaultPopTransitionSpec(), predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.(Int) -> ContentTransform = defaultPredictivePopTransitionSpec(), entryProvider: (key: T) -> NavEntry<T>)