UNPKG

1.86 kBTypeScriptView Raw
1import * as React from 'react';
2import { NavigationContainerProps, NavigationContainerRef } from '@react-navigation/core';
3import type { Theme, LinkingOptions, DocumentTitleOptions } from './types';
4/**
5 * Container component which holds the navigation state designed for React Native apps.
6 * This should be rendered at the root wrapping the whole app.
7 *
8 * @param props.initialState Initial state object for the navigation tree. When deep link handling is enabled, this will override deep links when specified. Make sure that you don't specify an `initialState` when there's a deep link (`Linking.getInitialURL()`).
9 * @param props.onReady Callback which is called after the navigation tree mounts.
10 * @param props.onStateChange Callback which is called with the latest navigation state when it changes.
11 * @param props.theme Theme object for the navigators.
12 * @param props.linking Options for deep linking. Deep link handling is enabled when this prop is provided, unless `linking.enabled` is `false`.
13 * @param props.fallback Fallback component to render until we have finished getting initial state when linking is enabled. Defaults to `null`.
14 * @param props.documentTitle Options to configure the document title on Web. Updating document title is handled by default unless `documentTitle.enabled` is `false`.
15 * @param props.children Child elements to render the content.
16 * @param props.ref Ref object which refers to the navigation object containing helper methods.
17 */
18declare const NavigationContainer: React.ForwardRefExoticComponent<NavigationContainerProps & {
19 theme?: Theme | undefined;
20 linking?: LinkingOptions | undefined;
21 fallback?: React.ReactNode;
22 documentTitle?: DocumentTitleOptions | undefined;
23 onReady?: (() => void) | undefined;
24} & React.RefAttributes<NavigationContainerRef>>;
25export default NavigationContainer;
26
\No newline at end of file