UNPKG

1.62 kBTypeScriptView Raw
1import { type NavigationContainerRef, type ParamListBase, type StaticNavigation } from '@react-navigation/core';
2import * as React from 'react';
3import { NavigationContainer } from './NavigationContainer';
4import type { LinkingOptions } from './types';
5type Props = Omit<React.ComponentProps<typeof NavigationContainer>, 'linking' | 'children'> & {
6 /**
7 * Options for deep linking.
8 */
9 linking?: Omit<LinkingOptions<ParamListBase>, 'config' | 'enabled'> & {
10 /**
11 * Whether deep link handling should be enabled.
12 * Defaults to `true` if any `linking` options are specified, `false` otherwise.
13 *
14 * When 'auto' is specified, all leaf screens will get a autogenerated path.
15 * The generated path will be a kebab-case version of the screen name.
16 * This can be overridden for specific screens by specifying `linking` for the screen.
17 */
18 enabled?: 'auto' | true | false;
19 /**
20 * Additional configuration
21 */
22 config?: Omit<NonNullable<LinkingOptions<ParamListBase>['config']>, 'screens'>;
23 };
24};
25/**
26 * Create a navigation component from a static navigation config.
27 * The returned component is a wrapper around `NavigationContainer`.
28 *
29 * @param tree Static navigation config.
30 * @returns Navigation component to use in your app.
31 */
32export declare function createStaticNavigation(tree: StaticNavigation<any, any, any>): React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<NavigationContainerRef<ParamListBase>>>;
33export {};
34//# sourceMappingURL=createStaticNavigation.d.ts.map
\No newline at end of file