React Router API Reference
    Preparing search index...

    Interface IndexRouteProps

    interface IndexRouteProps {
        action?: boolean | ActionFunction<any>;
        caseSensitive?: boolean;
        children?: undefined;
        Component?: null | ComponentType<{}>;
        element?: ReactNode;
        ErrorBoundary?: null | ComponentType<{}>;
        errorElement?: ReactNode;
        handle?: any;
        hasErrorBoundary?: boolean;
        HydrateFallback?: null | ComponentType<{}>;
        hydrateFallbackElement?: ReactNode;
        id?: string;
        index: true;
        lazy?: LazyRouteFunction<IndexRouteObject>;
        loader?: boolean | LoaderFunction<any>;
        middleware?: MiddlewareFunction<unknown>[];
        path?: string;
        shouldRevalidate?: ShouldRevalidateFunction;
    }
    Index

    Properties

    action? caseSensitive? children? Component? element? ErrorBoundary? errorElement? handle? hasErrorBoundary? HydrateFallback? hydrateFallbackElement? id? index lazy? loader? middleware? path? shouldRevalidate?

    Properties

    action?: boolean | ActionFunction<any>

    The route action. See action.

    caseSensitive?: boolean

    Whether the path should be case-sensitive. Defaults to false.

    children?: undefined

    Child Route components

    Component?: null | ComponentType<{}>

    The React Component to render when this route matches. Mutually exclusive with element.

    element?: ReactNode

    The React element to render when this Route matches. Mutually exclusive with Component.

    ErrorBoundary?: null | ComponentType<{}>

    The React Component to render at this route if an error occurs. Mutually exclusive with errorElement.

    errorElement?: ReactNode

    The React element to render at this route if an error occurs. Mutually exclusive with ErrorBoundary.

    handle?: any

    The route handle.

    hasErrorBoundary?: boolean
    HydrateFallback?: null | ComponentType<{}>

    The React Component to render while this router is loading data. Mutually exclusive with hydrateFallbackElement.

    hydrateFallbackElement?: ReactNode

    The React element to render while this router is loading data. Mutually exclusive with HydrateFallback.

    id?: string

    The unique identifier for this route (for use with DataRouters)

    index: true

    Whether this is an index route.

    lazy?: LazyRouteFunction<IndexRouteObject>

    A function that returns a promise that resolves to the route object. Used for code-splitting routes. See lazy.

    loader?: boolean | LoaderFunction<any>

    The route loader. See loader.

    middleware?: MiddlewareFunction<unknown>[]

    The route middleware. See middleware.

    path?: string

    The path pattern to match. If unspecified or empty, then this becomes a layout route.

    shouldRevalidate?: ShouldRevalidateFunction

    The route shouldRevalidate function. See shouldRevalidate.

    Settings

    Member Visibility

    On This Page

    Properties