Skip to content

basalt / dashboard/src / Dashboard

Class: Dashboard ​

Defined in: dashboard/src/dashboard.ts:24

The navigable model an admin shell (React, etc.) renders.

Constructors ​

Constructor ​

> new Dashboard(config): Dashboard

Defined in: dashboard/src/dashboard.ts:29

Parameters ​

config ​

DashboardConfig

Returns ​

Dashboard

Properties ​

branding ​

> readonly branding: Branding

Defined in: dashboard/src/dashboard.ts:26


sections ​

> readonly sections: Section[]

Defined in: dashboard/src/dashboard.ts:27


title ​

> readonly title: string

Defined in: dashboard/src/dashboard.ts:25

Methods ​

> nav(): object[]

Defined in: dashboard/src/dashboard.ts:40

Navigation model for the sidebar.

Returns ​

object[]


section() ​

> section(key): Section | undefined

Defined in: dashboard/src/dashboard.ts:35

Parameters ​

key ​

string

Returns ​

Section | undefined

Released under the MIT License.