NavigationSuiteType

Artifact: androidx.compose.material3:material3-adaptive-navigation-suite

Added in 1.3.0

value class NavigationSuiteType

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

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

Summary

Public companion properties
`NavigationSuiteType`	`NavigationBar` A navigation suite type that instructs the `NavigationSuite` to expect a `NavigationBar` that will be displayed at the bottom of the screen.
`NavigationSuiteType`	`NavigationDrawer` A navigation suite type that instructs the `NavigationSuite` to expect a `PermanentDrawerSheet` that will be displayed at the start of the screen.
`NavigationSuiteType`	`NavigationRail` A navigation suite type that instructs the `NavigationSuite` to expect a `NavigationRail` that will be displayed at the start of the screen.
`NavigationSuiteType`	`None` A navigation suite type that instructs the `NavigationSuite` to not display any navigation components on the screen.
`NavigationSuiteType`	`ShortNavigationBarCompact` A navigation suite type that instructs the `NavigationSuite` to expect a `ShortNavigationBar` with vertical `ShortNavigationBarItem`s that will be displayed at the bottom of the screen.
`NavigationSuiteType`	`ShortNavigationBarMedium` A navigation suite type that instructs the `NavigationSuite` to expect a `ShortNavigationBar` with horizontal `ShortNavigationBarItem`s that will be displayed at the bottom of the screen.
`NavigationSuiteType`	`WideNavigationRailCollapsed` A navigation suite type that instructs the `NavigationSuite` to expect a collapsed `WideNavigationRail` that will be displayed at the start of the screen.
`NavigationSuiteType`	`WideNavigationRailExpanded` A navigation suite type that instructs the `NavigationSuite` to expect an expanded `WideNavigationRail` that will be displayed at the start of the screen.

Public functions
`open String`	`toString()`

Public companion properties

NavigationBar

Added in 1.3.0

val NavigationBar: NavigationSuiteType

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.

See also
`NavigationBar`

NavigationDrawer

Added in 1.3.0

val NavigationDrawer: NavigationSuiteType

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.

See also
`PermanentDrawerSheet`

NavigationRail

Added in 1.3.0

val NavigationRail: NavigationSuiteType

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.

See also
`NavigationRail`

None

Added in 1.3.0

val None: NavigationSuiteType

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.

ShortNavigationBarCompact

val ShortNavigationBarCompact: NavigationSuiteType

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.

See also
`ShortNavigationBar`

ShortNavigationBarMedium

val ShortNavigationBarMedium: NavigationSuiteType

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.

See also
`ShortNavigationBar`

WideNavigationRailCollapsed

val WideNavigationRailCollapsed: NavigationSuiteType

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

See also
`WideNavigationRail`

WideNavigationRailExpanded

val WideNavigationRailExpanded: NavigationSuiteType

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

See also
`WideNavigationRail`

Public functions

toString

open fun toString(): String