API Reference / @gtkx/navigation / StackScreenProps

Type Alias: StackScreenProps<ParamList, RouteName, NavigatorID>

StackScreenProps<ParamList, RouteName, NavigatorID> = object

Defined in: packages/navigation/dist/stack/types.d.ts:46

Props a stack 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: StackNavigationProp<ParamList, RouteName, NavigatorID>

Defined in: packages/navigation/dist/stack/types.d.ts:48

Navigation object of the screen.

---

route

route: RouteProp<ParamList, RouteName>

Defined in: packages/navigation/dist/stack/types.d.ts:50

The route the screen renders.