GTKX

API Reference / @gtkx/navigation / RouteGroupConfig

Type Alias: RouteGroupConfig<ParamList, ScreenOptions, Navigation> ​

RouteGroupConfig<ParamList, ScreenOptions, Navigation> = object

Type Parameters ​

ParamList ​

ParamList extends ParamListBase

ScreenOptions ​

ScreenOptions extends object

Navigation

Properties ​

children ​

children: React.ReactNode

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

optional navigationKey?: string

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) | { }

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

screenOptions? ​

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

Navigator options for this screen.