Skip to main content

Interface: Route

lib/router.Route

Properties

disabled

Optional disabled: boolean

Whether the route should be disabled (not registered).

Defined in

lib/router.tsx:118


exact

Optional exact: boolean

When true, will only match if the path matches the location.pathname exactly.

Defined in

lib/router.tsx:97


hideAppBar

Optional hideAppBar: boolean

Hide the appbar at the top.

Defined in

lib/router.tsx:116


name

Optional name: string

Human readable name. Capitalized and short.

Defined in

lib/router.tsx:99


noAuthRequired

Optional noAuthRequired: boolean

This route does not require Authentication.

Defined in

lib/router.tsx:110


noCluster

Optional noCluster: boolean

In case this route does not need a cluster prefix and context.

deprecated please use useClusterURL.

Defined in

lib/router.tsx:104


path

path: string

Any valid URL path or array of paths that path-to-regexp@^1.7.0 understands.

Defined in

lib/router.tsx:95


sidebar: null | string | { item: null | string ; sidebar: string }

The sidebar entry this Route should enable, or null if it shouldn't enable any. If an object is passed with item and sidebar, it will try to enable the given sidebar and the given item.

Defined in

lib/router.tsx:112


useClusterURL

Optional useClusterURL: boolean

Should URL have the cluster prefix? (default=true)

Defined in

lib/router.tsx:108

Methods

component

component(): Element

Shown component for this route.

Returns

Element

Defined in

lib/router.tsx:114