Skip to main content

Interface: Route

Properties

component()

component: () => ReactNode;

Shown component for this route.

Returns

ReactNode

Defined in

src/lib/router.tsx:143


disabled?

optional disabled: boolean;

Whether the route should be disabled (not registered).

Defined in

src/lib/router.tsx:147


exact?

optional exact: boolean;

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

Defined in

src/lib/router.tsx:126


hideAppBar?

optional hideAppBar: boolean;

Hide the appbar at the top.

Defined in

src/lib/router.tsx:145


isFullWidth?

optional isFullWidth: boolean;

Render route for full width

Defined in

src/lib/router.tsx:149


name?

optional name: string;

Human readable name. Capitalized and short.

Defined in

src/lib/router.tsx:128


noAuthRequired?

optional noAuthRequired: boolean;

This route does not require Authentication.

Defined in

src/lib/router.tsx:139


noCluster?

optional noCluster: boolean;

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

Deprecated

please use useClusterURL.

Defined in

src/lib/router.tsx:133


path

path: string;

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

Defined in

src/lib/router.tsx:124


sidebar: null | string | object;

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

src/lib/router.tsx:141


useClusterURL?

optional useClusterURL: boolean;

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

Defined in

src/lib/router.tsx:137