Module: lib/router

    Interfaces

    Variables

    NotFoundRoute

    NotFoundRoute: Object

    Type declaration

    Name Type
    component () => Element
    exact boolean
    name string
    noAuthRequired boolean
    path string
    sidebar null

    Defined in

    lib/router.tsx:749

    Functions

    createRouteURL

    createRouteURL(routeName, params?): string

    Parameters

    Name Type
    routeName string
    params RouteURLProps

    Returns

    string

    Defined in

    lib/router.tsx:807


    getDefaultRoutes

    getDefaultRoutes(): Object

    Returns

    Object

    Defined in

    lib/router.tsx:835


    getRoute

    getRoute(routeName): Route

    Parameters

    Name Type
    routeName string

    Returns

    Route

    Defined in

    lib/router.tsx:758


    getRoutePath

    getRoutePath(route): string

    Parameters

    Name Type
    route Route

    Returns

    string

    Defined in

    lib/router.tsx:791


    getRouteUseClusterURL

    getRouteUseClusterURL(route): boolean

    Should the route use a cluster URL?

    Parameters

    Name Type
    route Route

    Returns

    boolean

    true when a cluster URL contains cluster in the URL. eg. /c/minikube/my-url false, the URL does not contain the cluster. eg. /my-url

    Defined in

    lib/router.tsx:779