GTKX

API Reference / @gtkx/navigation / DrawerTypeBag

Type Alias: DrawerTypeBag<ParamList, NavigatorID> ​

DrawerTypeBag<ParamList, NavigatorID> = object

Defined in: packages/navigation/src/drawer/create-drawer-navigator.tsx:25

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

Type Parameters ​

ParamList ​

ParamList extends ParamListBase = ParamListBase

NavigatorID extends string | undefined = string | undefined

Properties ​

EventMap ​

EventMap: DrawerNavigationEventMap

Defined in: packages/navigation/src/drawer/create-drawer-navigator.tsx:38

Events the navigator emits.

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

Defined in: packages/navigation/src/drawer/create-drawer-navigator.tsx:40

Navigation object per route.

Navigator: typeof DrawerNavigator

Defined in: packages/navigation/src/drawer/create-drawer-navigator.tsx:44

The navigator component.

NavigatorID: NavigatorID

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

Optional navigator id.

ParamList ​

ParamList: ParamList

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

Route names and their params.

ScreenOptions ​

ScreenOptions: DrawerNavigationOptions

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

Per-screen options.

State ​

State: DrawerNavigationState<ParamList>

Defined in: packages/navigation/src/drawer/create-drawer-navigator.tsx:34

Shape of the navigator state.