PaneScaffoldDirective

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

Kotlin |Java

Cmn

@ExperimentalMaterial3AdaptiveApi
class PaneScaffoldDirective

Top-level directives about how a pane scaffold should be arranged and spaced, like how many partitions the layout can be split into and what should be the gutter size.

Summary

Public companion properties
`PaneScaffoldDirective`	`Default` A default instance of `PaneScaffoldDirective` that suggests a single-pane layout that occupies the full window.	Cmn

Public constructors
`PaneScaffoldDirective( maxHorizontalPartitions: Int, horizontalPartitionSpacerSize: Dp, maxVerticalPartitions: Int, verticalPartitionSpacerSize: Dp, defaultPanePreferredWidth: Dp, excludedBounds: List<Rect> )`	Cmn

Public functions
`PaneScaffoldDirective`	`copy( maxHorizontalPartitions: Int, horizontalPartitionSpacerSize: Dp, maxVerticalPartitions: Int, verticalPartitionSpacerSize: Dp, defaultPanePreferredWidth: Dp, excludedBounds: List<Rect> )` Returns a new copy of `PaneScaffoldDirective` with specified fields overwritten.	Cmn
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`open String`	`toString()`	Cmn

Public properties
`Dp`	`defaultPanePreferredWidth` Default preferred width of panes that will be used by the scaffold if there's no Modifier.preferredWidth provided with a pane.	Cmn
`List<Rect>`	`excludedBounds` the bounds of all areas in the window that the layout needs to avoid displaying anything upon it.	Cmn
`Dp`	`horizontalPartitionSpacerSize` Size of the spacers between horizontal partitions.	Cmn
`Int`	`maxHorizontalPartitions` the max number of partitions along the horizontal axis the layout can be split into.	Cmn
`Int`	`maxVerticalPartitions` the max number of partitions along the vertical axis the layout can be split into.	Cmn
`Dp`	`verticalPartitionSpacerSize` Size of the spacers between vertical partitions.	Cmn

Public companion properties

Default

Cmn

Added in 1.0.0-alpha11

val Default: PaneScaffoldDirective

A default instance of PaneScaffoldDirective that suggests a single-pane layout that occupies the full window. To create a customized PaneScaffoldDirective, you can use PaneScaffoldDirective.copy on the default instance to create a copy with custom values.

Public constructors

PaneScaffoldDirective

Cmn

PaneScaffoldDirective(
    maxHorizontalPartitions: Int,
    horizontalPartitionSpacerSize: Dp,
    maxVerticalPartitions: Int,
    verticalPartitionSpacerSize: Dp,
    defaultPanePreferredWidth: Dp,
    excludedBounds: List<Rect>
)

Public functions

copy

Cmn

fun copy(
    maxHorizontalPartitions: Int = this.maxHorizontalPartitions,
    horizontalPartitionSpacerSize: Dp = this.horizontalPartitionSpacerSize,
    maxVerticalPartitions: Int = this.maxVerticalPartitions,
    verticalPartitionSpacerSize: Dp = this.verticalPartitionSpacerSize,
    defaultPanePreferredWidth: Dp = this.defaultPanePreferredWidth,
    excludedBounds: List<Rect> = this.excludedBounds.toList()
): PaneScaffoldDirective

Returns a new copy of PaneScaffoldDirective with specified fields overwritten. Use this method to create a custom PaneScaffoldDirective from the default instance or the result of calculatePaneScaffoldDirective.

Parameters
`maxHorizontalPartitions: Int = this.maxHorizontalPartitions`	the max number of partitions along the horizontal axis the layout can be split into.
`horizontalPartitionSpacerSize: Dp = this.horizontalPartitionSpacerSize`	Size of the spacers between horizontal partitions. It's equivalent to the left/right margins the horizontal partitions.
`maxVerticalPartitions: Int = this.maxVerticalPartitions`	the max number of partitions along the vertical axis the layout can be split into.
`verticalPartitionSpacerSize: Dp = this.verticalPartitionSpacerSize`	Size of the spacers between vertical partitions. It's equivalent to the top/bottom margins of the vertical partitions.
`defaultPanePreferredWidth: Dp = this.defaultPanePreferredWidth`	Default preferred width of panes that will be used by the scaffold if there's no Modifier.preferredWidth provided with a pane.
`excludedBounds: List<Rect> = this.excludedBounds.toList()`	the bounds of all areas in the window that the layout needs to avoid displaying anything upon it. Usually these bounds represent where physical hinges are.

equals

Cmn

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

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

Public properties

defaultPanePreferredWidth

Cmn

Added in 1.0.0-alpha11

val defaultPanePreferredWidth: Dp

Default preferred width of panes that will be used by the scaffold if there's no Modifier.preferredWidth provided with a pane. See Modifier.preferredWidth for more info about how and when preferred width will be used.

excludedBounds

Cmn

Added in 1.0.0-alpha11

val excludedBounds: List<Rect>

the bounds of all areas in the window that the layout needs to avoid displaying anything upon it. Usually these bounds represent where physical hinges are.

horizontalPartitionSpacerSize

Cmn

Added in 1.0.0-alpha11

val horizontalPartitionSpacerSize: Dp

Size of the spacers between horizontal partitions. It's equivalent to the left/right margins the horizontal partitions.

maxHorizontalPartitions

Cmn

Added in 1.0.0-alpha11

val maxHorizontalPartitions: Int

the max number of partitions along the horizontal axis the layout can be split into.

maxVerticalPartitions

Cmn

Added in 1.0.0-alpha11

val maxVerticalPartitions: Int

the max number of partitions along the vertical axis the layout can be split into.

verticalPartitionSpacerSize

Cmn

Added in 1.0.0-alpha11

val verticalPartitionSpacerSize: Dp

Size of the spacers between vertical partitions. It's equivalent to the top/bottom margins of the vertical partitions.