ThreePaneMotion

Artifact: androidx.compose.material3.adaptive:adaptive-layout

View Source

Added in 1.1.0-alpha05

Common/All

• Cmn

  @ExperimentalMaterial3AdaptiveApi
  class ThreePaneMotion

---

The class that provides motion settings for three pane scaffolds like ListDetailPaneScaffold and SupportingPaneScaffold.

Summary

Public companion properties
ThreePaneMotion	NoMotion A default ThreePaneMotion instance that specifies no motions.	Cmn

Public constructors
ThreePaneMotion(     primaryPaneMotion: PaneMotion,     secondaryPaneMotion: PaneMotion,     tertiaryPaneMotion: PaneMotion,     animationSpecs: PaneAnimationSpecs,     delayedAnimationSpecs: PaneAnimationSpecs )	Cmn

Public functions
ThreePaneMotion	copy(     primaryPaneMotion: PaneMotion,     secondaryPaneMotion: PaneMotion,     tertiaryPaneMotion: PaneMotion,     animationSpecs: PaneAnimationSpecs,     delayedAnimationSpecs: PaneAnimationSpecs ) Makes a copy of ThreePaneMotion with override values.	Cmn
open operator Boolean	equals(other: Any?)	Cmn
operator PaneMotion	get(role: ThreePaneScaffoldRole) Gets the specified PaneMotion of a given pane role.	Cmn
open Int	hashCode()	Cmn
open String	toString()	Cmn

Public properties
PaneAnimationSpecs	animationSpecs the specified PaneAnimationSpecs when animating pane motions.	Cmn
PaneAnimationSpecs	delayedAnimationSpecs the specified PaneAnimationSpecs when animating pane motions with a delay to emphasize entering panes.	Cmn

Public companion properties

NoMotion

Cmn

Added in 1.1.0-alpha05

val NoMotion: ThreePaneMotion

A default ThreePaneMotion instance that specifies no motions.

Public constructors

ThreePaneMotion

Cmn

Added in 1.1.0-alpha05

ThreePaneMotion(
    primaryPaneMotion: PaneMotion,
    secondaryPaneMotion: PaneMotion,
    tertiaryPaneMotion: PaneMotion,
    animationSpecs: PaneAnimationSpecs = ThreePaneMotionDefaults.AnimationSpecs,
    delayedAnimationSpecs: PaneAnimationSpecs = ThreePaneMotionDefaults.AnimationSpecsDelayed
)

Parameters
primaryPaneMotion: PaneMotion	the specified PaneMotion of the primary pane, i.e., ListDetailPaneScaffoldRole.Detail or SupportingPaneScaffoldRole.Main.
secondaryPaneMotion: PaneMotion	the specified PaneMotion of the secondary pane, i.e., ListDetailPaneScaffoldRole.List or SupportingPaneScaffoldRole.Supporting.
tertiaryPaneMotion: PaneMotion	the specified PaneMotion of the tertiary pane, i.e., ListDetailPaneScaffoldRole.Extra or SupportingPaneScaffoldRole.Extra.
animationSpecs: PaneAnimationSpecs = ThreePaneMotionDefaults.AnimationSpecs	the specified PaneAnimationSpecs when animating pane motions.
delayedAnimationSpecs: PaneAnimationSpecs = ThreePaneMotionDefaults.AnimationSpecsDelayed	the specified PaneAnimationSpecs when animating pane motions with a delay to emphasize entering panes.

Public functions

copy

Cmn

Added in 1.1.0-alpha05

fun copy(
    primaryPaneMotion: PaneMotion = this.primaryPaneMotion,
    secondaryPaneMotion: PaneMotion = this.secondaryPaneMotion,
    tertiaryPaneMotion: PaneMotion = this.tertiaryPaneMotion,
    animationSpecs: PaneAnimationSpecs = this.animationSpecs,
    delayedAnimationSpecs: PaneAnimationSpecs = this.delayedAnimationSpecs
): ThreePaneMotion

Makes a copy of ThreePaneMotion with override values.

Parameters
primaryPaneMotion: PaneMotion = this.primaryPaneMotion	the specified PaneMotion of the primary pane, i.e., ListDetailPaneScaffoldRole.Detail or SupportingPaneScaffoldRole.Main.
secondaryPaneMotion: PaneMotion = this.secondaryPaneMotion	the specified PaneMotion of the secondary pane, i.e., ListDetailPaneScaffoldRole.List or SupportingPaneScaffoldRole.Supporting.
tertiaryPaneMotion: PaneMotion = this.tertiaryPaneMotion	the specified PaneMotion of the tertiary pane, i.e., ListDetailPaneScaffoldRole.Extra or SupportingPaneScaffoldRole.Extra.
animationSpecs: PaneAnimationSpecs = this.animationSpecs	the specified PaneAnimationSpecs when animating pane motions.
delayedAnimationSpecs: PaneAnimationSpecs = this.delayedAnimationSpecs	the specified PaneAnimationSpecs when animating pane motions with a delay to emphasize entering panes.

equals

Cmn

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

get

Cmn

Added in 1.1.0-alpha05

operator fun get(role: ThreePaneScaffoldRole): PaneMotion

Gets the specified PaneMotion of a given pane role.

Parameters
role: ThreePaneScaffoldRole	the specified role of the pane, see ListDetailPaneScaffoldRole and SupportingPaneScaffoldRole.

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

Public properties

animationSpecs

Cmn

Added in 1.1.0-alpha05

val animationSpecs: PaneAnimationSpecs

the specified PaneAnimationSpecs when animating pane motions.

delayedAnimationSpecs

Cmn

Added in 1.1.0-alpha05

val delayedAnimationSpecs: PaneAnimationSpecs

the specified PaneAnimationSpecs when animating pane motions with a delay to emphasize entering panes.