expo-router/build/react-navigation/routers/DrawerRouter.d.ts

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

import { type TabActionHelpers, type TabActionType, type TabNavigationState, type TabRouterOptions } from './TabRouter';
import { type CommonNavigationAction, type ParamListBase } from './types';
export type DrawerStatus = 'open' | 'closed';
export type DrawerActionType = TabActionType | {
    type: 'OPEN_DRAWER' | 'CLOSE_DRAWER' | 'TOGGLE_DRAWER';
    source?: string;
    target?: string;
};
export type DrawerRouterOptions = TabRouterOptions & {
    defaultStatus?: DrawerStatus;
};
export type DrawerNavigationState<ParamList extends ParamListBase> = Omit<TabNavigationState<ParamList>, 'type' | 'history'> & {
    /**
     * Type of the router, in this case, it's drawer.
     */
    type?: 'drawer';
    /**
     * List of previously visited route keys and drawer open status.
     */
    history?: ({
        type: 'route';
        key: string;
    } | {
        type: 'drawer';
        status: DrawerStatus;
    })[];
};
export type DrawerActionHelpers<ParamList extends ParamListBase> = TabActionHelpers<ParamList> & {
    /**
     * Open the drawer sidebar.
     */
    openDrawer(): void;
    /**
     * Close the drawer sidebar.
     */
    closeDrawer(): void;
    /**
     * Open the drawer sidebar if closed, or close if opened.
     */
    toggleDrawer(): void;
};
export declare const DrawerActions: {
    openDrawer(): {
        readonly type: "OPEN_DRAWER";
    };
    closeDrawer(): {
        readonly type: "CLOSE_DRAWER";
    };
    toggleDrawer(): {
        readonly type: "TOGGLE_DRAWER";
    };
    jumpTo(name: string, params?: object): {
        readonly type: "JUMP_TO";
        readonly payload: {
            readonly name: string;
            readonly params: object | undefined;
        };
    };
    replace(name: string, params?: object): {
        readonly type: "REPLACE";
        readonly payload: {
            readonly name: string;
            readonly params: object | undefined;
        };
    };
};
/**
 * DrawerRouter is considered internal implementation and its behavior may change without a notice between expo-router's version
 */
export declare const DrawerRouter: (options: DrawerRouterOptions) => import("./extendRouter").ExtendedRouter<DrawerNavigationState<ParamListBase>, CommonNavigationAction | DrawerActionType>;