expo-router/build/views/Navigator.d.ts

Expo Router is a file-based router for React Native and web applications.

import * as React from 'react';
import { StackRouter } from '../layouts/StackClient';
import type { RouterFactory } from '../react-navigation/native';
import { useNavigationBuilder } from '../react-navigation/native';
import type { ErrorBoundaryProps } from './Try';
export type NavigatorContextValue = ReturnType<typeof useNavigationBuilder> & {
    contextKey: string;
    router: RouterFactory<any, any, any>;
};
export declare const NavigatorContext: React.Context<NavigatorContextValue | null>;
type UseNavigationBuilderRouter = Parameters<typeof useNavigationBuilder>[0];
type UseNavigationBuilderOptions = Parameters<typeof useNavigationBuilder>[1];
export type NavigatorProps<T extends UseNavigationBuilderRouter> = {
    screenOptions?: UseNavigationBuilderOptions['screenOptions'];
    children?: UseNavigationBuilderOptions['children'];
    activityEnabled?: UseNavigationBuilderOptions['activityEnabled'];
    /**
     * Number of screens above a route that hides its content when `activityEnabled` is `true`.
     * @default 2
     */
    activityDefaultThreshold?: number;
    router?: T;
    routerOptions?: Omit<Parameters<T>[0], 'initialRouteName'>;
    /** A component to render when an individual screen in this navigator throws an error. */
    unstable_screenErrorBoundary?: React.ComponentType<ErrorBoundaryProps>;
};
/**
 * An unstyled custom navigator. Good for basic web layouts.
 *
 * @hidden
 */
export declare function Navigator<T extends UseNavigationBuilderRouter = typeof StackRouter>({ screenOptions, children, activityEnabled, activityDefaultThreshold, router, routerOptions, unstable_screenErrorBoundary, }: NavigatorProps<T>): React.JSX.Element | null;
export declare namespace Navigator {
    var Slot: typeof NavigatorSlot;
    var useContext: typeof useNavigatorContext;
    var Screen: typeof import("./Screen").Screen;
}
/**
 * @hidden
 */
export declare function useNavigatorContext(): NavigatorContextValue;
/**
 * Renders the currently selected content.
 *
 * There are actually two different implementations of `<Slot/>`:
 *  - Used inside a `_layout` as the `Navigator`
 *  - Used inside a `Navigator` as the content
 *
 * Since a custom `Navigator` will set the `NavigatorContext.contextKey` to
 * the current `_layout`, you can use this to determine if you are inside
 * a custom navigator or not.
 */
export declare function Slot(props: Omit<NavigatorProps<any>, 'children' | 'activityEnabled' | 'activityDefaultThreshold'> & {
    activityEnabled?: boolean;
}): React.JSX.Element;
/**
 * Render the current navigator content.
 */
declare function NavigatorSlot(): React.JSX.Element | null;
/**
 * The default navigator for the app when no root _layout is provided.
 */
export declare function DefaultNavigator(): React.JSX.Element;
export {};