GTKX

API Reference / @gtkx/navigation / TabTypeBag

Type Alias: TabTypeBag<ParamList, NavigatorID> ​

TabTypeBag<ParamList, NavigatorID> = object

Defined in: packages/navigation/src/tabs/create-tab-navigator.tsx:17

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

Type Parameters ​

ParamList ​

ParamList extends ParamListBase = ParamListBase

NavigatorID extends string | undefined = string | undefined

Properties ​

EventMap ​

EventMap: TabNavigationEventMap

Defined in: packages/navigation/src/tabs/create-tab-navigator.tsx:30

Events the navigator emits.

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

Defined in: packages/navigation/src/tabs/create-tab-navigator.tsx:32

Navigation object per route.

Navigator: typeof TabNavigator

Defined in: packages/navigation/src/tabs/create-tab-navigator.tsx:36

The navigator component.

NavigatorID: NavigatorID

Defined in: packages/navigation/src/tabs/create-tab-navigator.tsx:24

Optional navigator id.

ParamList ​

ParamList: ParamList

Defined in: packages/navigation/src/tabs/create-tab-navigator.tsx:22

Route names and their params.

ScreenOptions ​

ScreenOptions: TabNavigationOptions

Defined in: packages/navigation/src/tabs/create-tab-navigator.tsx:28

Per-screen options.

State ​

State: TabNavigationState<ParamList>

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

Shape of the navigator state.