API Reference / @gtkx/navigation / TabViewOverviewConfig

Type Alias: TabViewOverviewConfig ​

TabViewOverviewConfig = object

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

Settings of the AdwTabOverview rendered around the view.

Properties ​

enableNewTab? ​

optional enableNewTab?: boolean

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

Whether the overview shows a new tab button; defaults to false.

enableSearch? ​

optional enableSearch?: boolean

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

Whether the overview offers search; defaults to true.

onCreateTab? ​

optional onCreateTab?: () => TabViewTarget

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

Returns the screen the new tab button opens.

Returns ​

TabViewTarget

onOpenChange? ​

optional onOpenChange?: (open) => void

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

Called when the overview opens or closes natively.

Parameters ​

open ​

boolean

Returns ​

void

open? ​

optional open?: boolean

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

Whether the overview is open. When given, the overview follows it: the user opening or closing the overview calls onOpenChange, and a value the app does not update is restored. Leave it out to let the overview open and close on its own.