InsetsType

@Stable()

Represents the values for a type of insets, and stores information about the layout insets, animating insets, and visibility of the insets.

InsetsType instances are commonly stored in a WindowInsets instance.

Constructors

InsetsType

fun InsetsType()

Functions

copy

open fun copy(left: Int = this.left, top: Int = this.top, right: Int = this.right, bottom: Int = this.bottom): Insets

minus

open operator fun minus(other: Insets): Insets

plus

open operator fun plus(other: Insets): Insets

Properties

animatedInsets

val animatedInsets: Insets

The animated insets for this InsetsType.

animationFraction

var animationFraction: Float

The progress of any ongoing animations, in the range of 0 to 1.

animationInProgress

val animationInProgress: Boolean

Whether this insets type is being animated at this moment.

bottom

open override val bottom: Int

The bottom dimension of the insets in pixels.

isVisible

var isVisible: Boolean

Whether the insets are currently visible.

layoutInsets

val layoutInsets: Insets

The layout insets for this InsetsType.

left

open override val left: Int

The left dimension of the insets in pixels.

right

open override val right: Int

The right dimension of the insets in pixels.

top

open override val top: Int

The top dimension of the insets in pixels.

Extensions

coerceEachDimensionAtLeast

fun InsetsType.coerceEachDimensionAtLeast(minimumValue: InsetsType): Insets

Ensures that each dimension is not less than corresponding dimension in the specified minimumValue.

toPaddingValues

@Composable()

inline fun InsetsType.toPaddingValues(start: Boolean = true, top: Boolean = true, end: Boolean = true, bottom: Boolean = true, additionalHorizontal: Dp = 0.dp, additionalVertical: Dp = 0.dp): PaddingValues

Returns the current insets converted into a PaddingValues.

@Composable()

fun InsetsType.toPaddingValues(start: Boolean = true, top: Boolean = true, end: Boolean = true, bottom: Boolean = true, additionalStart: Dp = 0.dp, additionalTop: Dp = 0.dp, additionalEnd: Dp = 0.dp, additionalBottom: Dp = 0.dp): PaddingValues

Returns the current insets converted into a PaddingValues.