annotations/io.github.thomaskioko.codegen.annotations/DestinationKind

DestinationKind

enum DestinationKind : Enum<DestinationKind> (source)

The role a NavDestination plays at runtime. The processor uses this value to choose which pair of files to emit and which NavDestination subclass the generated binding contributes to.

Entries

SCREEN

A screen pushed onto the navigation back stack. Tapping the system back button pops it off and returns to the previous destination.

OVERLAY

A modal overlay that appears on top of the current screen without affecting the back stack. Examples include bottom sheets, dialogs, and menus. Dismissing the overlay returns to the screen that was visible underneath.

TAB_ROOT

The destination shown when the user selects a top level tab in a bottom navigation bar. Each tab anchors its own back stack and persists across tab switches.

Properties

entries

val entries: EnumEntries<DestinationKind>

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

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): DestinationKind

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.)

values

fun values(): Array<DestinationKind>

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