API Reference / @gtkx/navigation / RouteConfigProps

Type Alias: RouteConfigProps<ParamList, RouteName, State, ScreenOptions, EventMap, Navigation>

RouteConfigProps<ParamList, RouteName, State, ScreenOptions, EventMap, Navigation> = object

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:556

Type Parameters

ParamList

ParamList extends ParamListBase

RouteName

RouteName extends keyof ParamList

State

State extends NavigationState

ScreenOptions

ScreenOptions extends object

EventMap

EventMap extends EventMapBase

Navigation

Navigation

Properties

getId?

optional getId?: ({ params, }) => string | undefined

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:594

Function to return an unique ID for this screen. Receives an object with the route params. For a given screen name, there will always be only one screen corresponding to an ID. If undefined is returned, it acts same as no getId being specified.

Parameters

{ params, }

params

Readonly<ParamList[RouteName]>

Returns

string | undefined

---

initialParams?

optional initialParams?: Partial<ParamList[RouteName]>

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:600

Initial params object for the route.

---

layout?

optional layout?: (props) => React.ReactElement

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:587

Layout for this screen. Useful for wrapping the screen with custom containers. e.g. for styling, error boundaries, suspense, etc.

Parameters

props

ScreenLayoutArgs<ParamList, RouteName, ScreenOptions, Navigation>

Returns

React.ReactElement

---

listeners?

optional listeners?: ScreenListeners<State, EventMap> | ((props) => ScreenListeners<State, EventMap>)

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:578

Event listeners for this screen.

---

name

name: RouteName

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:566

Route name of this screen.

---

navigationKey?

optional navigationKey?: string

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:562

Optional key for this screen. This doesn't need to be unique. If the key changes, existing screens with this name will be removed or reset. Useful when we have some common screens and have conditional rendering.

---

options?

optional options?: ScreenOptions | ((props) => ScreenOptions)

Defined in: node_modules/.pnpm/@react-navigation+core@7.21.13_react@19.2.8/node_modules/@react-navigation/core/lib/typescript/src/types.d.ts:570

Navigator options for this screen.