one/types/router/useScreens.d.ts

One is a React framework for web, iOS, and Android apps.

import type { EventMapBase, NavigationState, ParamListBase, RouteProp, ScreenListeners } from '@react-navigation/native';
import React from 'react';
import { type RouteNode } from './Route';
export declare const Screen: <RouteName extends string>(_: import("@react-navigation/core").RouteConfig<ParamListBase, RouteName, Readonly<{
    key: string;
    index: number;
    routeNames: string[];
    history?: unknown[] | undefined;
    routes: import("@react-navigation/routers").NavigationRoute<ParamListBase, string>[];
    type: string;
    stale: false;
}>, {}, {}, import("@react-navigation/core").NavigationProp<ParamListBase, string, Readonly<{
    key: string;
    index: number;
    routeNames: string[];
    history?: unknown[] | undefined;
    routes: import("@react-navigation/routers").NavigationRoute<ParamListBase, string>[];
    type: string;
    stale: false;
}>, {}, {}, {}>>) => null, Group: React.ComponentType<import("@react-navigation/core").RouteGroupConfig<ParamListBase, {}, import("@react-navigation/core").NavigationProp<ParamListBase, string, Readonly<{
    key: string;
    index: number;
    routeNames: string[];
    history?: unknown[] | undefined;
    routes: import("@react-navigation/routers").NavigationRoute<ParamListBase, string>[];
    type: string;
    stale: false;
}>, {}, {}, {}>>>;
export type ScreenProps<TOptions extends Record<string, any> = Record<string, any>, State extends NavigationState = NavigationState, EventMap extends EventMapBase = EventMapBase> = {
    /** Name is required when used inside a Layout component. */
    name?: string;
    /**
     * Redirect to the nearest sibling route.
     * If all children are redirect={true}, the layout will render `null` as there are no children to render.
     */
    redirect?: boolean;
    initialParams?: Record<string, any>;
    options?: TOptions;
    listeners?: ScreenListeners<State, EventMap> | ((prop: {
        route: RouteProp<ParamListBase, string>;
        navigation: any;
    }) => ScreenListeners<State, EventMap>);
    getId?: ({ params }: {
        params?: Record<string, any>;
    }) => string | undefined;
};
type Remaining = 'all' | 'authored' | 'none';
/**
 * @returns React Navigation screens sorted by the `route` property.
 */
export declare function useSortedScreens(order: ScreenProps[], options?: {
    remaining?: Remaining;
    /** Set of route names to filter out (protected routes with guard=false) */
    protectedScreens?: Set<string>;
}): React.ReactNode[];
/** Wrap the component with various enhancements and add access to child routes. */
export declare function getQualifiedRouteComponent(value: RouteNode): React.NamedExoticComponent<Omit<any, "ref"> & React.RefAttributes<unknown>> | React.ComponentType<any>;
/** @returns a function which provides a screen id that matches the dynamic route name in params. */
export declare function createGetIdForRoute(route: Pick<RouteNode, 'dynamic' | 'route' | 'contextKey' | 'children'>): ({ params }?: {
    params?: Record<string, any>;
}) => string;
export {};
//# sourceMappingURL=useScreens.d.ts.map