androidx.compose.material3.adaptive

Common/AllAndroid/JVM

Classes

HingeInfo	A class that contains the info of a hinge relevant to a Posture.	Cmn
Posture	Posture info that can help make layout adaptation decisions.	Cmn
WindowAdaptiveInfo	This class collects window info that affects adaptation decisions.	Cmn

Annotations

ExperimentalMaterial3AdaptiveApi

Cmn

Top-level functions summary

Posture	@ExperimentalMaterial3AdaptiveApi calculatePosture(foldingFeatures: List<FoldingFeature>) Calculates the Posture for a given list of FoldingFeatures.	android
State<List<FoldingFeature>>	@Composable collectFoldingFeaturesAsState() Collects the current window folding features from WindowInfoTracker in to a State.	android
WindowAdaptiveInfo	@Composable currentWindowAdaptiveInfo() Calculates and returns WindowAdaptiveInfo of the provided context.	Cmn android
IntSize	@Composable currentWindowSize() Returns and automatically update the current window size from WindowMetricsCalculator.	android

Extension properties summary

List<Rect>	Posture.allHorizontalHingeBounds Returns the list of all horizontal hinge bounds.	Cmn
List<Rect>	Posture.allVerticalHingeBounds Returns the list of all vertical hinge bounds.	Cmn
List<Rect>	Posture.occludingHorizontalHingeBounds Returns the list of horizontal hinge bounds that are occluding.	Cmn
List<Rect>	Posture.occludingVerticalHingeBounds Returns the list of vertical hinge bounds that are occluding.	Cmn
List<Rect>	Posture.separatingHorizontalHingeBounds Returns the list of horizontal hinge bounds that are separating.	Cmn
List<Rect>	Posture.separatingVerticalHingeBounds Returns the list of vertical hinge bounds that are separating.	Cmn

Top-level functions

calculatePosture

android

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

@ExperimentalMaterial3AdaptiveApi
fun calculatePosture(foldingFeatures: List<FoldingFeature>): Posture

Calculates the Posture for a given list of FoldingFeatures. This methods converts framework folding info into the Material-opinionated posture info.

collectFoldingFeaturesAsState

android

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

@Composable
fun collectFoldingFeaturesAsState(): State<List<FoldingFeature>>

Collects the current window folding features from WindowInfoTracker in to a State.

Returns
State<List<FoldingFeature>>	a State of a FoldingFeature list.

currentWindowAdaptiveInfo

Cmn android

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

@Composable
fun currentWindowAdaptiveInfo(): WindowAdaptiveInfo

Calculates and returns WindowAdaptiveInfo of the provided context. It's a convenient function that uses the default WindowSizeClass constructor and the default Posture calculation functions to retrieve WindowSizeClass and Posture.

Returns
WindowAdaptiveInfo	WindowAdaptiveInfo of the provided context

currentWindowSize

android

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

@Composable
fun currentWindowSize(): IntSize

Returns and automatically update the current window size from WindowMetricsCalculator.

Returns
IntSize	an IntSize that represents the current window size.

Extension properties

allHorizontalHingeBounds

Cmn

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

Added in 1.0.0

val Posture.allHorizontalHingeBounds: List<Rect>

Returns the list of all horizontal hinge bounds.

allVerticalHingeBounds

Cmn

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

Added in 1.0.0

val Posture.allVerticalHingeBounds: List<Rect>

Returns the list of all vertical hinge bounds.

occludingHorizontalHingeBounds

Cmn

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

Added in 1.0.0

val Posture.occludingHorizontalHingeBounds: List<Rect>

Returns the list of horizontal hinge bounds that are occluding.

occludingVerticalHingeBounds

Cmn

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

Added in 1.0.0

val Posture.occludingVerticalHingeBounds: List<Rect>

Returns the list of vertical hinge bounds that are occluding.

separatingHorizontalHingeBounds

Cmn

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

Added in 1.0.0

val Posture.separatingHorizontalHingeBounds: List<Rect>

Returns the list of horizontal hinge bounds that are separating.

separatingVerticalHingeBounds

Cmn

Artifact: androidx.compose.material3.adaptive:adaptive

View Source

Added in 1.0.0

val Posture.separatingVerticalHingeBounds: List<Rect>

Returns the list of vertical hinge bounds that are separating.