API Reference / @gtkx/navigation / TabViewTypeBag

Type Alias: TabViewTypeBag<ParamList, NavigatorID> ​

TabViewTypeBag<ParamList, NavigatorID> = object

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:26

Type bag describing the tab view navigator to React Navigation's typed APIs.

Type Parameters ​

ParamList ​

ParamList extends ParamListBase = ParamListBase

NavigatorID extends string | undefined = string | undefined

Properties ​

EventMap ​

EventMap: TabViewNavigationEventMap

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:39

Events the navigator emits.

NavigationList: { [RouteName in keyof ParamList]: TabViewNavigationProp<ParamList, RouteName, NavigatorID> }

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:41

Navigation object per route.

Navigator: typeof TabViewNavigator

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:45

The navigator component.

NavigatorID: NavigatorID

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:33

Optional navigator id.

ParamList ​

ParamList: ParamList

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:31

Route names and their params.

ScreenOptions ​

ScreenOptions: TabViewNavigationOptions

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:37

Per-screen options.

State ​

State: TabViewNavigationState<ParamList>

Defined in: packages/navigation/src/tab-view/create-tab-view-navigator.tsx:35

Shape of the navigator state.