NavigationSuiteScaffoldDefaults

object NavigationSuiteScaffoldDefaults


Contains the default values used by the NavigationSuiteScaffold.

Summary

Public functions

NavigationSuiteType

Returns the standard NavigationSuiteType according to the provided WindowAdaptiveInfo.

NavigationSuiteType

Returns the recommended NavigationSuiteType according to the provided WindowAdaptiveInfo, following the Material specifications.

Public properties

Color

Default container color for a navigation suite scaffold.

Color

Default content color for a navigation suite scaffold.

Alignment.Horizontal

Default primary action content alignment for a navigation suite scaffold.

Public functions

calculateFromAdaptiveInfo

Added in 1.3.0
fun calculateFromAdaptiveInfo(adaptiveInfo: WindowAdaptiveInfo): NavigationSuiteType

Returns the standard NavigationSuiteType according to the provided WindowAdaptiveInfo. Usually used with the NavigationSuiteScaffold and related APIs.

Note: It's recommended to use navigationSuiteType instead of this function, as that one offers extended and preferred types.

Parameters
adaptiveInfo: WindowAdaptiveInfo

the provided WindowAdaptiveInfo

Added in 1.4.0
fun navigationSuiteType(adaptiveInfo: WindowAdaptiveInfo): NavigationSuiteType

Returns the recommended NavigationSuiteType according to the provided WindowAdaptiveInfo, following the Material specifications. Usually used with the NavigationSuiteScaffold and related APIs.

Parameters
adaptiveInfo: WindowAdaptiveInfo

the provided WindowAdaptiveInfo

Public properties

containerColor

Added in 1.3.0
val containerColorColor

Default container color for a navigation suite scaffold.

contentColor

Added in 1.3.0
val contentColorColor

Default content color for a navigation suite scaffold.

primaryActionContentAlignment

Added in 1.4.0
val primaryActionContentAlignmentAlignment.Horizontal

Default primary action content alignment for a navigation suite scaffold.