Indicate the associated pane should be reflowed when certain conditions are met. With the default calculation functions calculateThreePaneScaffoldValue we provide, when it's a single pane layout, a pane with a reflow strategy will be adapted to either:

  1. PaneAdaptedValue.Reflowed, when either the reflowed pane or the target pane it's supposed to be reflowed to is the current destination; or

  2. PaneAdaptedValue.Hidden otherwise.

Note that if the current layout can have more than one horizontal partition, the pane will never be reflowed.

To provide custom adapt strategies, see the following sample:

import androidx.compose.material3.Scaffold
import androidx.compose.material3.adaptive.layout.AdaptStrategy
import androidx.compose.material3.adaptive.layout.ListDetailPaneScaffold
import androidx.compose.material3.adaptive.layout.ListDetailPaneScaffoldDefaults
import androidx.compose.material3.adaptive.layout.ListDetailPaneScaffoldRole
import androidx.compose.material3.adaptive.navigation.rememberListDetailPaneScaffoldNavigator
import androidx.compose.runtime.remember
import androidx.compose.ui.semantics.Role

rememberListDetailPaneScaffoldNavigator<T>(
        adaptStrategies =
            ListDetailPaneScaffoldDefaults.adaptStrategies(
                extraPaneAdaptStrategy =
                    AdaptStrategy.Reflow(targetPane = ListDetailPaneScaffoldRole.Detail)
            )
    )

Summary

Public constructors
Reflow(targetPane: Any)
Cmn

Public functions
open operator Boolean
equals(other: Any?)
Cmn
open Int
Cmn
open String
Cmn

Public properties
Any

the target pane of the reflowing, i.e., the pane that the reflowed pane will be put under.
Cmn

Inherited functions
From androidx.compose.material3.adaptive.layout.AdaptStrategy
open PaneAdaptedValue

This function is deprecated. This function is deprecated in favor of directly using the info carried by the strategy instances to make adaptation decisions.
Cmn

Public constructors

Reflow

Cmn
Added in 1.2.0-alpha05
Reflow(targetPane: Any)
Parameters
targetPane: Any

the target pane of the reflowing, i.e., the pane that the reflowed pane will be put under.

Public functions

equals

Cmn 
open operator fun equals(other: Any?): Boolean

hashCode

Cmn 
open fun hashCode(): Int

toString

Cmn 
open fun toString(): String

Public properties

targetPane

Cmn
Added in 1.2.0-alpha05
val targetPane: Any

the target pane of the reflowing, i.e., the pane that the reflowed pane will be put under.