API Reference / @gtkx/navigation / createPathConfigForStaticNavigation

Function: createPathConfigForStaticNavigation()

createPathConfigForStaticNavigation(tree, options?, auto?): PathConfigMap<ParamListBase> | undefined

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

Create a path config object from a static navigation config for deep linking.

Parameters

tree

TreeForPathConfig

Static navigation config.

options?

Additional options from linking.config.

initialRouteName?

string

auto?

boolean

Whether to automatically generate paths for leaf screens.

Returns

PathConfigMap<ParamListBase> | undefined

Path config object to use in linking config.

Example

const config = {
  screens: {
    Home: {
      screens: createPathConfigForStaticNavigation(HomeTabs),
    },
  },
};