API index

Everything @umriss-ui/dashboard exports, with its signature. A component's props stand on its own page.

Components

HeadingType

The built-in heading widget type, to put inside Dashboard when the application wants readers to divide their dashboard: one size, full, one row, its text as its options, drawn as a title without a card.

function HeadingType(): null;

Used on Scenarios and Dashboard.

WidgetType

Dashboard – Declares one widget type inside a Dashboard. It draws nothing itself: the dashboard reads its props. The options type is inferred from defaultOptions.

Used on Scenarios and Dashboard.

Hooks

useDashboard

Declares a dashboard: hands back Dashboard, WidgetType, the view in view, setView and the editing actions.

function useDashboard({ defaultView, initialView, allowEdit, onViewChange, onDraftChange }: DashboardOptions): DashboardParts;

Used on Scenarios and Dashboard.

Types

DashboardOptions

Its table stands on Dashboard.

DashboardParts

Its table stands on Dashboard.

DashboardProps

Its table stands on Dashboard.

DashboardView

Its table stands on Dashboard.

Used on Scenarios and Dashboard.

DashboardWidget

Its table stands on Dashboard.

HeadingOptions

Its table stands on Dashboard.

Used on Scenarios and Dashboard.

SizeSpan

Its table stands on Dashboard.

WidgetContent

Its table stands on Dashboard.

WidgetFormProps

Its table stands on Dashboard.

WidgetSize

Its table stands on Dashboard.

Used on Dashboard.

WidgetTypeProps

Its table stands on Dashboard.

Every page of @umriss-ui/dashboard

Getting started

API index