Function

calculatePaneScaffoldDirectiveWithTwoPanesOnMediumWidth

Calculates the recommended PaneScaffoldDirective from a given WindowAdaptiveInfo.

RevenueCat

RevenueCat

Add subscriptions to your apps in minutes

Ad Get started for free

calculatePaneScaffoldDirectiveWithTwoPanesOnMediumWidth

Common
@ExperimentalMaterial3AdaptiveApi
fun calculatePaneScaffoldDirectiveWithTwoPanesOnMediumWidth(
    windowAdaptiveInfo: WindowAdaptiveInfo,
    verticalHingePolicy: HingePolicy = HingePolicy.AvoidSeparating,
): PaneScaffoldDirective

Calculates the recommended PaneScaffoldDirective from a given WindowAdaptiveInfo. Use this method with currentWindowAdaptiveInfoV2 to acquire Material-recommended dense-mode adaptive layout settings of the current activity window. Note that this function results in a dual-pane layout when the window width falls in the Medium size bucket, while calculatePaneScaffoldDirective results in a single-pane layout instead. We recommend to use calculatePaneScaffoldDirective, unless you have a strong use case to show two panes on a medium-width window, which can make your layout look too packed.

See more details on the [Material design guideline site] (https://m3.material.io/foundations/layout/applying-layout/window-size-classes).

Parameters

windowAdaptiveInfo WindowAdaptiveInfo that collects useful information in making layout adaptation decisions like androidx.window.core.layout.WindowSizeClass.
verticalHingePolicy HingePolicy that decides how layouts are supposed to address vertical hinges.

Returns

an PaneScaffoldDirective to be used to decide adaptive layout states.