Interface RouteProps

Single route configuration

interface RouteProps {
    allRolesRequired?: boolean;
    caseSensitive?: boolean;
    element?: ReactNode;
    fallback?: Partial<Pick<FallbackProps, "Suspense" | "InvalidRoles">> & {
        route?: string;
    };
    handle?: any;
    index?: boolean;
    path?: string;
    roles?: string[];
    routes?: RouteProps[];
}

Hierarchy

  • Pick<RouteObject, "index" | "path" | "element" | "caseSensitive" | "handle">
    • RouteProps

Properties

allRolesRequired? caseSensitive? element? fallback? handle? index? path? roles? routes?

Properties

Optional allRolesRequired

allRolesRequired?: boolean

If set to true - user must have all roles from route.roles Array. If set to false - user must have at least one role from route.roles Array.

Default

to false

Optional caseSensitive

caseSensitive?: boolean

Optional element

element?: ReactNode

Optional fallback

fallback?: Partial<Pick<FallbackProps, "Suspense" | "InvalidRoles">> & {
    route?: string;
}

Route fallback definitions

Type declaration

  • Optional route?: string

    Fallback route (applied for private or public routes)

Optional handle

handle?: any

Optional index

index?: boolean

Optional path

path?: string

Optional roles

roles?: string[]

Array of roles that protects the route. If not provided, then the page can be accessed by users without roles.

Optional routes

routes?: RouteProps[]

Nested routes definitions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc