API Reference / @gtkx/navigation / TabViewNavigationOptions

Type Alias: TabViewNavigationOptions ​

TabViewNavigationOptions = HeaderOptions & object

Defined in: packages/navigation/src/tab-view/types.ts:103

Per-screen options of the tab view navigator.

Type Declaration ​

optional header?: (props) => ReactNode

Renders a custom top bar instead of the default AdwHeaderBar.

Parameters ​

props ​

TabViewHeaderProps

Returns ​

ReactNode

icon? ​

optional icon?: TabViewIcon | null

Icon shown in the tab; null shows the view's default icon.

indicatorActivatable? ​

optional indicatorActivatable?: boolean

Whether clicking the indicator emits indicatorActivated.

indicatorIcon? ​

optional indicatorIcon?: TabViewIcon | null

Indicator icon shown at the end of the tab.

indicatorTooltip? ​

optional indicatorTooltip?: string

Tooltip of the indicator icon; supports Pango markup.

keyword? ​

optional keyword?: string

Search keyword for the tab overview.

lazy? ​

optional lazy?: boolean

Whether the screen mounts on first selection instead of as soon as the tab opens; defaults to true.

liveThumbnail? ​

optional liveThumbnail?: boolean

Whether the overview thumbnail stays live while the tab is not selected.

loading? ​

optional loading?: boolean

Whether the tab shows a loading spinner instead of its icon.

needsAttention? ​

optional needsAttention?: boolean

Whether the tab is highlighted as needing attention.

thumbnailXalign? ​

optional thumbnailXalign?: number

Horizontal alignment of the overview thumbnail, from 0 to 1.

thumbnailYalign? ​

optional thumbnailYalign?: number

Vertical alignment of the overview thumbnail, from 0 to 1.

tooltip? ​

optional tooltip?: string

Tooltip of the tab; supports Pango markup.