# API index

> Package `@umriss-ui/dashboard`, version 0.40.0. Demo page: <https://romanhaendler.github.io/umriss-ui/dashboard/api/>. Every page in one line: [llms.txt](https://romanhaendler.github.io/umriss-ui/dashboard/llms.txt); every page in full: [llms-full.txt](https://romanhaendler.github.io/umriss-ui/dashboard/llms-full.txt).

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

Demo page: https://romanhaendler.github.io/umriss-ui/dashboard/api/

## 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.

```ts
function HeadingType(): null;
```

Used on [Scenarios](https://romanhaendler.github.io/umriss-ui/dashboard/) and [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/).

### `WidgetType`

[Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/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](https://romanhaendler.github.io/umriss-ui/dashboard/) and [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/).

## Hooks

### `useDashboard`

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

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

Used on [Scenarios](https://romanhaendler.github.io/umriss-ui/dashboard/) and [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/).

## Types

### `DashboardOptions`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-DashboardOptions).

### `DashboardParts`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-DashboardParts).

### `DashboardProps`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-DashboardProps).

### `DashboardView`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-DashboardView).

Used on [Scenarios](https://romanhaendler.github.io/umriss-ui/dashboard/) and [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/).

### `DashboardWidget`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-DashboardWidget).

### `HeadingOptions`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-HeadingOptions).

Used on [Scenarios](https://romanhaendler.github.io/umriss-ui/dashboard/) and [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/).

### `SizeSpan`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-SizeSpan).

### `WidgetContent`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-WidgetContent).

### `WidgetFormProps`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-WidgetFormProps).

### `WidgetSize`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-WidgetSize).

Used on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/).

### `WidgetTypeProps`

Its table stands on [Dashboard](https://romanhaendler.github.io/umriss-ui/dashboard/dashboard/#type-WidgetTypeProps).