SpatialDialogProperties

class SpatialDialogProperties

Properties for configuring a SpatialDialog.

See also
`SpatialDialog`

Summary

Public constructors
`SpatialDialogProperties( dismissOnBackPress: Boolean, dismissOnClickOutside: Boolean, usePlatformDefaultWidth: Boolean, backgroundContentAnimationSpec: FiniteAnimationSpec<Float>, elevation: Dp )`

Public functions
`SpatialDialogProperties`	`copy( dismissOnBackPress: Boolean, dismissOnClickOutside: Boolean, usePlatformDefaultWidth: Boolean, restingLevelAnimationSpec: FiniteAnimationSpec<Float>, elevation: Dp )`
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open String`	`toString()`

Public properties
`FiniteAnimationSpec<Float>`	`backgroundContentAnimationSpec` the animation specification for the depth offset of the app content as it animates away from the user towards its recessed resting level when a spatial dialog is shown.
`Boolean`	`dismissOnBackPress` whether the dialog should be dismissed when the device's back button is pressed.
`Boolean`	`dismissOnClickOutside` whether the dialog should be dismissed when the user touches outside of it.
`Dp`	`elevation` the elevation level of the dialog.
`Boolean`	`usePlatformDefaultWidth` whether the dialog should use the platform's default width.

Public constructors

SpatialDialogProperties

Added in 1.0.0-alpha09

SpatialDialogProperties(
    dismissOnBackPress: Boolean = true,
    dismissOnClickOutside: Boolean = true,
    usePlatformDefaultWidth: Boolean = true,
    backgroundContentAnimationSpec: FiniteAnimationSpec<Float> = spring(),
    elevation: Dp = SpatialElevationLevel.DialogDefault
)

Public functions

copy

Added in 1.0.0-alpha09

fun copy(
    dismissOnBackPress: Boolean = this.dismissOnBackPress,
    dismissOnClickOutside: Boolean = this.dismissOnClickOutside,
    usePlatformDefaultWidth: Boolean = this.usePlatformDefaultWidth,
    restingLevelAnimationSpec: FiniteAnimationSpec<Float> = this.backgroundContentAnimationSpec,
    elevation: Dp = this.elevation
): SpatialDialogProperties

equals

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

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

backgroundContentAnimationSpec

Added in 1.0.0-alpha09

val backgroundContentAnimationSpec: FiniteAnimationSpec<Float>

the animation specification for the depth offset of the app content as it animates away from the user towards its recessed resting level when a spatial dialog is shown. The same specification is used when the app content animates back towards the user to its original resting level when the dialog is dismissed. This is only used in spatial environments.

dismissOnBackPress

Added in 1.0.0-alpha09

val dismissOnBackPress: Boolean

whether the dialog should be dismissed when the device's back button is pressed. Defaults to true.

dismissOnClickOutside

Added in 1.0.0-alpha09

val dismissOnClickOutside: Boolean

whether the dialog should be dismissed when the user touches outside of it. Defaults to true.

elevation

val elevation: Dp

the elevation level of the dialog. Defaults to SpatialElevationLevel.DialogDefault.

usePlatformDefaultWidth

Added in 1.0.0-alpha09

val usePlatformDefaultWidth: Boolean

whether the dialog should use the platform's default width. Defaults to true. This is only used in non-spatial environments.