rememberSupportingPaneScaffoldNavigator

Composable Function

Android

@ExperimentalMaterial3AdaptiveApi
@Composable
fun <T> rememberSupportingPaneScaffoldNavigator(
    scaffoldDirective: PaneScaffoldDirective =
        calculateStandardPaneScaffoldDirective(currentWindowAdaptiveInfo()),
    adaptStrategies: ThreePaneScaffoldAdaptStrategies =
        SupportingPaneScaffoldDefaults.adaptStrategies(),
    isDestinationHistoryAware: Boolean = true,
    initialDestinationHistory: List<ThreePaneScaffoldDestinationItem<T>> =
        DefaultSupportingPaneHistory,
): ThreePaneScaffoldNavigator<T>

Returns a remembered default implementation of ThreePaneScaffoldNavigator for SupportingPaneScaffold, which will be updated automatically when the input values change. The default navigator is supposed to be used independently from any navigation frameworks and it will address the navigation purely inside the SupportingPaneScaffold.

Parameters


scaffoldDirective	the current layout directives to follow. The default value will be calculated with `calculateStandardPaneScaffoldDirective` using `WindowAdaptiveInfo` retrieved from the current context.
adaptStrategies	adaptation strategies of each pane.
isDestinationHistoryAware	`true` if the scaffold value calculation should be aware of the full destination history, instead of just the current destination. See `calculateThreePaneScaffoldValue` for more relevant details.
initialDestinationHistory	the initial destination history of the scaffold, by default it will be just the main pane.