Interface FallbackProps

Globally configured fallback properties (can be configured at route level as well)

interface FallbackProps {
    InvalidRoles: ComponentType<RouteProps>;
    Suspense: ReactNode;
    privateRoute: string;
    publicRoute: string;
}

Properties

InvalidRoles Suspense privateRoute publicRoute

Properties

InvalidRoles

InvalidRoles: ComponentType<RouteProps>

Fallback component, rendered if user does not have required role to visit the route (configurable globally and at route level)

Example

const fallback: FallbackProps = {
  InvalidRoles: (route) => <>User has no access to {route.path}, required roles are: {JSON.stringify(route.roles)}</>
}

Suspense

Suspense: ReactNode

Fallback for lazy loaded routes (configurable globally and at route level)

Example

const fallback: FallbackProps = {
  Suspense: <>...loading...<>
}

privateRoute

privateRoute: string

Unauthorized users on private routes will be redirected to this route

Default

common[0].path ?? '/'

publicRoute

publicRoute: string

Authorized users on public routes will be redirected to this route

Default

common[0].path ?? '/'

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc