API Reference / @gtkx/navigation / DrawerNavigationOptions

Type Alias: DrawerNavigationOptions

DrawerNavigationOptions = HeaderOptions & object

Defined in: packages/navigation/dist/drawer/types.d.ts:15

Per-screen options of the drawer navigator.

Type Declaration

drawerIcon?

optional drawerIcon?: string

Icon name shown next to the sidebar label.

drawerLabel?

optional drawerLabel?: string

Label shown in the sidebar; defaults to title, then to the route name.

header?

optional header?: (props) => ReactNode

Renders a custom top bar instead of the default AdwHeaderBar.

Parameters

props

DrawerHeaderProps

Returns

ReactNode

lazy?

optional lazy?: boolean

Whether the screen mounts on first focus instead of at startup; defaults to true.

popToTopOnBlur?

optional popToTopOnBlur?: boolean

Whether a nested stack pops to its first screen when this screen loses focus; defaults to false.