TopLevelDestination

The destinations shown in the navigation bar or rail.

Each entry owns a back stack of its own, so switching between them preserves where the user was. The first entry is the start destination: the app exits from there, and back from any other top-level destination returns to it.

Entries

Link copied to clipboard
Link copied to clipboard

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard

Label under the icon.

Link copied to clipboard
val key: NavKey

The navigation key this destination maps to.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Icon shown when this destination is current.

Link copied to clipboard

Title shown in the top app bar.

Link copied to clipboard

Icon shown otherwise.

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.