NavDisplay
A nav display that renders and animates between different Scenes, each of which can render one or more NavEntrys.
The Scenes are calculated with the given list of SceneStrategy in the order of the list. If no Scene is calculated, the fallback will be to a SinglePaneSceneStrategy.
It is allowable for different Scenes to render the same NavEntrys, perhaps on some conditions as determined by the sceneStrategies based on window size, form factor, other arbitrary logic.
If this happens, and these Scenes are rendered at the same time due to animation or predictive back, then the content for the NavEntry will only be rendered in the most recent Scene that is the target for being the current scene as determined by sceneStrategies. This enforces a unique invocation of each NavEntry, even if it is displayable by two different Scenes.
By default, AnimatedContent transitions are prioritized in this order:
transitioning [NavEntry.metadata] > current [Scene.metadata] > NavDisplay defaultsHowever, a Scene.metadata does have the ability to override NavEntry.metadata. Nevertheless, the final fallback will always be the NavDisplay's default transitions.
Parameters
the collection of keys that represents the state that needs to be handled
the modifier to be applied to the layout.
The Alignment of the AnimatedContent
a callback for handling system back press. By default, this pops a single item off of the given back stack if it is a MutableList, otherwise you should provide this parameter.
list of NavEntryDecorator to add information to the entry content
the list of SceneStrategy to determine which scene to render a list of entries.
list of SceneDecoratorStrategy to add content to the scene.
the SharedTransitionScope to allow transitions between scenes.
the SizeTransform for the AnimatedContent.
Default ContentTransform when navigating to NavEntrys.
Default ContentTransform when popping NavEntrys.
Default ContentTransform when popping with predictive back NavEntrys.
lambda used to construct each possible NavEntry
Samples
androidx.navigation3.ui.samples.SceneNavandroidx.navigation3.ui.samples.SceneNavSharedEntrySampleandroidx.navigation3.ui.samples.SceneNavSharedElementSampleA nav display that renders and animates between different Scenes, each of which can render one or more NavEntrys.
The Scenes are calculated with the given list of SceneStrategy in the order of the list. If no Scene is calculated, the fallback will be to a SinglePaneSceneStrategy.
It is allowable for different Scenes to render the same NavEntrys, perhaps on some conditions as determined by the sceneStrategies based on window size, form factor, other arbitrary logic.
If this happens, and these Scenes are rendered at the same time due to animation or predictive back, then the content for the NavEntry will only be rendered in the most recent Scene that is the target for being the current scene as determined by sceneStrategies. This enforces a unique invocation of each NavEntry, even if it is displayable by two different Scenes.
By default, AnimatedContent transitions are prioritized in this order:
transitioning [NavEntry.metadata] > current [Scene.metadata] > NavDisplay defaultsHowever, a Scene.metadata does have the ability to override NavEntry.metadata. Nevertheless, the final fallback will always be the NavDisplay's default transitions.
WHEN TO USE This overload can be used when you need to switch between different backStacks and each with their own separate decorator states, or when you want to concatenate backStacks and their states to form a larger backstack.
HOW TO USE The entries can first be created via rememberDecoratedNavEntries in order to associate a backStack with a particular set of states.
Parameters
the list of NavEntry built from a backStack. The entries can be created from a backStack decorated with NavEntryDecorator via rememberDecoratedNavEntries.
the modifier to be applied to the layout.
The Alignment of the AnimatedContent
the list of SceneStrategy to determine which scene to render a list of entries.
list of SceneDecoratorStrategy to add content to the scene.
the SharedTransitionScope to allow transitions between scenes.
the SizeTransform for the AnimatedContent.
Default ContentTransform when navigating to NavEntrys.
Default ContentTransform when popping NavEntrys.
Default ContentTransform when popping with predictive back NavEntrys.
a callback for handling system back press.
See also
Samples
androidx.navigation3.ui.samples.MultipleBackStackSampleandroidx.navigation3.ui.samples.ConcatenatedBackStackSampleandroidx.navigation3.ui.samples.SceneNavSharedEntrySampleA nav display that renders and animates between different Scenes, each of which can render one or more NavEntrys.
By default, AnimatedContent transitions are prioritized in this order:
transitioning [NavEntry.metadata] > current [Scene.metadata] > NavDisplay defaultsHowever, a Scene.metadata does have the ability to override NavEntry.metadata. Nevertheless, the final fallback will always be the NavDisplay's default transitions.
Parameters
the state that determines what current scene of the NavDisplay.
the modifier to be applied to the layout.
The Alignment of the AnimatedContent
the NavigationEventState responsible for handling back navigation
the SizeTransform for the AnimatedContent.
Default ContentTransform when navigating to NavEntrys.
Default ContentTransform when popping NavEntrys.
Default ContentTransform when popping with predictive back NavEntrys.