calculatePaneScaffoldDirective API Reference in adaptive-layout

Calculates the recommended PaneScaffoldDirective from a given WindowAdaptiveInfo.

calculatePaneScaffoldDirective

Source set: Common

public fun calculatePaneScaffoldDirective(
    windowAdaptiveInfo: WindowAdaptiveInfo,
    verticalHingePolicy: HingePolicy = HingePolicy.AvoidSeparating,
): PaneScaffoldDirective

Calculates the recommended PaneScaffoldDirective from a given WindowAdaptiveInfo. Use this method with androidx.compose.material3.adaptive.currentWindowAdaptiveInfoV2 to acquire Material-recommended adaptive layout settings of the current activity window.

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.

Return

an PaneScaffoldDirective to be used to decide adaptive layout states.