NavigationSuiteType

value class NavigationSuiteType private constructor(private val description: String)

Class that describes the different navigation suite types of the NavigationSuiteScaffold.

The NavigationSuiteType informs the NavigationSuite of what navigation component to expect.

Companion Object

Properties

val ShortNavigationBarCompact =
        NavigationSuiteType(description = "ShortNavigationBarCompact")

A navigation suite type that instructs the NavigationSuite to expect a ShortNavigationBar with vertical ShortNavigationBarItems that will be displayed at the bottom of the screen.

val ShortNavigationBarMedium = NavigationSuiteType(description = "ShortNavigationBarMedium")

A navigation suite type that instructs the NavigationSuite to expect a ShortNavigationBar with horizontal ShortNavigationBarItems that will be displayed at the bottom of the screen.

val WideNavigationRailCollapsed =
        NavigationSuiteType(description = "WideNavigationRailCollapsed")

A navigation suite type that instructs the NavigationSuite to expect a collapsed WideNavigationRail that will be displayed at the start of the screen.

val WideNavigationRailExpanded =
        NavigationSuiteType(description = "WideNavigationRailExpanded")

A navigation suite type that instructs the NavigationSuite to expect an expanded WideNavigationRail that will be displayed at the start of the screen.

val NavigationBar = NavigationSuiteType(description = "NavigationBar")

A navigation suite type that instructs the NavigationSuite to expect a NavigationBar that will be displayed at the bottom of the screen.

Note: It's recommended to use ShortNavigationBarCompact instead of this layout type.

val NavigationRail = NavigationSuiteType(description = "NavigationRail")

A navigation suite type that instructs the NavigationSuite to expect a NavigationRail that will be displayed at the start of the screen.

Note: It's recommended to use WideNavigationRailCollapsed instead of this layout type.

val NavigationDrawer = NavigationSuiteType(description = "NavigationDrawer")

A navigation suite type that instructs the NavigationSuite to expect a PermanentDrawerSheet that will be displayed at the start of the screen.

Note: It's recommended to use WideNavigationRailExpanded instead of this layout type.

val None = NavigationSuiteType(description = "None")

A navigation suite type that instructs the NavigationSuite to not display any navigation components on the screen.

Note: It's recommended to use NavigationSuiteScaffoldState instead of this layout type and set the visibility of the navigation component to hidden.