API Reference / @gtkx/navigation / SplitViewTypeBag

Type Alias: SplitViewTypeBag<ParamList, NavigatorID>

SplitViewTypeBag<ParamList, NavigatorID> = object

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:5

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

Type Parameters

ParamList

ParamList extends ParamListBase = ParamListBase

NavigatorID

NavigatorID extends string | undefined = string | undefined

Properties

EventMap

EventMap: SplitViewNavigationEventMap

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:15

Events the navigator emits.

---

NavigationList

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

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:17

Navigation object per route.

---

Navigator

Navigator: typeof SplitViewNavigator

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:21

The navigator component.

---

NavigatorID

NavigatorID: NavigatorID

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:9

Optional navigator id.

---

ParamList

ParamList: ParamList

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:7

Route names and their params.

---

ScreenOptions

ScreenOptions: SplitViewNavigationOptions

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:13

Per-screen options.

---

State

State: StackNavigationState<ParamList>

Defined in: packages/navigation/dist/split-view/create-split-view-navigator.d.ts:11

Shape of the navigator state.