GTKX

API Reference / @gtkx/navigation / StackTypeBag

Type Alias: StackTypeBag<ParamList, NavigatorID> ​

StackTypeBag<ParamList, NavigatorID> = object

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

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

Type Parameters ​

ParamList ​

ParamList extends ParamListBase = ParamListBase

NavigatorID extends string | undefined = string | undefined

Properties ​

EventMap ​

EventMap: StackNavigationEventMap

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

Events the navigator emits.

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

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

Navigation object per route.

Navigator: typeof StackNavigator

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

The navigator component.

NavigatorID: NavigatorID

Defined in: packages/navigation/src/stack/create-stack-navigator.tsx:29

Optional navigator id.

ParamList ​

ParamList: ParamList

Defined in: packages/navigation/src/stack/create-stack-navigator.tsx:27

Route names and their params.

ScreenOptions ​

ScreenOptions: StackNavigationOptions

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

Per-screen options.

State ​

State: StackNavigationState<ParamList>

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

Shape of the navigator state.