API Reference / @gtkx/navigation / TabNavigationOptions

Type Alias: TabNavigationOptions

TabNavigationOptions = HeaderOptions & object

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

Per-screen options of the tab navigator.

Type Declaration

animation?

optional animation?: "fade" | "none"

Whether switching to this tab crossfades; defaults to "none".

header?

optional header?: (props) => ReactNode

Renders a custom top bar instead of the default AdwHeaderBar.

Parameters

props

TabHeaderProps

Returns

ReactNode

lazy?

optional lazy?: boolean

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

needsAttention?

optional needsAttention?: boolean

Whether the view switcher highlights the tab as needing attention.

popToTopOnBlur?

optional popToTopOnBlur?: boolean

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

tabBarBadge?

optional tabBarBadge?: number

Badge number shown in the view switcher; 0 hides the badge.

tabBarIcon?

optional tabBarIcon?: string

Icon name shown in the view switcher.

tabBarLabel?

optional tabBarLabel?: string

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