API Reference / @gtkx/navigation / SplitViewScreenProps

Type Alias: SplitViewScreenProps<ParamList, RouteName, NavigatorID>

SplitViewScreenProps<ParamList, RouteName, NavigatorID> = object

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

Props a split view screen component receives.

Type Parameters

ParamList

ParamList extends ParamListBase

RouteName

RouteName extends keyof ParamList = keyof ParamList

NavigatorID

NavigatorID extends string | undefined = undefined

Properties

navigation

navigation: SplitViewNavigationProp<ParamList, RouteName, NavigatorID>

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

Navigation object of the screen.

---

route

route: RouteProp<ParamList, RouteName>

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

The route the screen renders.