GTKX

API Reference / @gtkx/navigation / SplitViewTypeBag

Type Alias: SplitViewTypeBag<ParamList, NavigatorID> ​

SplitViewTypeBag<ParamList, NavigatorID> = object

Defined in: packages/navigation/src/split-view/create-split-view-navigator.tsx:23

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

Type Parameters ​

ParamList ​

ParamList extends ParamListBase = ParamListBase

NavigatorID extends string | undefined = string | undefined

Properties ​

EventMap ​

EventMap: SplitViewNavigationEventMap

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

Events the navigator emits.

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

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

Navigation object per route.

Navigator: typeof SplitViewNavigator

Defined in: packages/navigation/src/split-view/create-split-view-navigator.tsx:42

The navigator component.

NavigatorID: NavigatorID

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

Optional navigator id.

ParamList ​

ParamList: ParamList

Defined in: packages/navigation/src/split-view/create-split-view-navigator.tsx:28

Route names and their params.

ScreenOptions ​

ScreenOptions: SplitViewNavigationOptions

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

Per-screen options.

State ​

State: StackNavigationState<ParamList>

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

Shape of the navigator state.