API Reference / @gtkx/navigation / RouteConfigComponent

Type Alias: RouteConfigComponent<ParamList, RouteName>

RouteConfigComponent<ParamList, RouteName> = { children?: never; component: ScreenComponentType<ParamList, RouteName>; getComponent?: never; } | { children?: never; component?: never; getComponent: () => ScreenComponentType<ParamList, RouteName>; } | { children: (props) => React.ReactNode; component?: never; getComponent?: never; }

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:531

Type Parameters

ParamList

ParamList extends ParamListBase

RouteName

RouteName extends keyof ParamList

Union Members

Type Literal

{ children?: never; component: ScreenComponentType<ParamList, RouteName>; getComponent?: never; }

children?

optional children?: never

component

component: ScreenComponentType<ParamList, RouteName>

React component to render for this screen.

getComponent?

optional getComponent?: never

---

Type Literal

{ children?: never; component?: never; getComponent: () => ScreenComponentType<ParamList, RouteName>; }

children?

optional children?: never

component?

optional component?: never

getComponent

getComponent: () => ScreenComponentType<ParamList, RouteName>

Lazily get a React component to render for this screen.

Returns

ScreenComponentType<ParamList, RouteName>

---

Type Literal

{ children: (props) => React.ReactNode; component?: never; getComponent?: never; }

children

children: (props) => React.ReactNode

Render callback to render content of this screen.

Parameters

props

navigation

any

route

RouteProp<ParamList, RouteName>

Returns

React.ReactNode

component?

optional component?: never

getComponent?

optional getComponent?: never