API Reference / @gtkx/navigation / RouteGroupConfig

Type Alias: RouteGroupConfig<ParamList, ScreenOptions, Navigation>

RouteGroupConfig<ParamList, ScreenOptions, 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:603

Type Parameters

ParamList

ParamList extends ParamListBase

ScreenOptions

ScreenOptions extends object

Navigation

Navigation

Properties

children

children: React.ReactNode

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

Children React Elements to extract the route configuration from. Only Screen, Group and React.Fragment are supported as children.

---

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

Optional key for the screens in this group. If the key changes, all existing screens in this group will be removed or reset.

---

screenLayout?

optional screenLayout?: ((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:621

Layout for the screens inside the group. This will override the screenLayout of parent group or navigator.

---

screenOptions?

optional screenOptions?: 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:612

Navigator options for this screen.