butterfly-compose/io.getstream.butterfly.compose

Package io.getstream.butterfly.compose

Types

Link copied to clipboard
sealed class WindowDpSize
Content copied to clipboard

Copyright 2022 Google LLC. SPDX-License-Identifier: Apache-2.0

Link copied to clipboard
enum WindowOrientation : Enum<WindowOrientation>
Content copied to clipboard

Defines the current orientation of the window.

Properties

Link copied to clipboard
@get:Composable
val FoldingFeature.hingeDp: Dp
Content copied to clipboard

Returns a dp size of the hinge according to the window orientation from a FoldingFeature.

Link copied to clipboard
val FoldingFeature.hingeDpSize: DpSize
Content copied to clipboard

Returns a dp size of the hinge from a FoldingFeature.

Link copied to clipboard
val FoldingFeature.hingeHeightDp: Dp
Content copied to clipboard

Returns a height dp size of the hinge from a FoldingFeature.

Link copied to clipboard
val FoldingFeature.hingeWidthDp: Dp
Content copied to clipboard

Returns a height dp size of the hinge from a FoldingFeature.

Link copied to clipboard
val LocalPosture: ProvidableCompositionLocal<Posture>
Content copied to clipboard

Definition of the Posture local provider.

Link copied to clipboard
val LocalWindowDpSize: ProvidableCompositionLocal<WindowDpSize>
Content copied to clipboard

Definition of the WindowDpSize local provider.

Link copied to clipboard
val LocalWindowLayoutInfo: ProvidableCompositionLocal<WindowLayoutInfo>
Content copied to clipboard

Definition of the WindowLayoutInfo local provider.

Link copied to clipboard
@get:Composable
val Activity.postureState: State<Posture>
Content copied to clipboard

Returns a State of the Posture by tracking the WindowLayoutInfo.

Link copied to clipboard
@get:Composable
val Fragment.postureState: State<Posture>
Content copied to clipboard

Returns a State of the Posture by tracking the WindowLayoutInfo.

Link copied to clipboard
@get:Composable
val Activity.windowLayoutInfoState: State<WindowLayoutInfo>
Content copied to clipboard

Returns a State of the WindowLayoutInfo.

Link copied to clipboard
@get:Composable
val Fragment.windowLayoutInfoState: State<WindowLayoutInfo>
Content copied to clipboard

Returns a State of the WindowLayoutInfo.

Link copied to clipboard
@get:Composable
val windowOrientation: WindowOrientation
Content copied to clipboard

Returns WindowOrientation according to the current window orientation.

Functions

Link copied to clipboard
@Composable
fun Activity.rememberWindowDpSize(): WindowDpSize
Content copied to clipboard

Copyright 2022 Google LLC. SPDX-License-Identifier: Apache-2.0

@Composable
fun Fragment.rememberWindowDpSize(): WindowDpSize
Content copied to clipboard

Remembers the WindowSize class for the window corresponding to the current window metrics.

Link copied to clipboard
@Composable
fun WindowInfoTracker.windowLayoutInfoState(activity: Activity): State<WindowLayoutInfo>
Content copied to clipboard

Returns a State of the WindowLayoutInfo.