Svelte · Overview

OverviewGrid

No summary has been written for OverviewGrid. Everything below is generated from the declaration shipped in 0.57.40 and describes the real contract.

Public export

typescript

import { OverviewGrid } from '@happyvertical/smrt-svelte/overview';

Import path: @happyvertical/smrt-svelte/overview
Props: 10
Props described: 10 of 10
Bindable state: 0
Callback events: 0
Verified release: 0.57.40

Props

NameTypeRequiredDescription

controllerOverviewControllerYesThe overview's state, from `createOverview`.

componentsReadonlyMap<string, Component<WidgetComponentProps>>NoResolved widget components (see `resolveWidgetComponents`). A type with no entry falls back to the registered `component`, else renders as unavailable.

optionEditorsReadonlyMap<string, Component<WidgetOptionsEditorProps>>NoResolved custom option editors (see `resolveWidgetOptionsEditors`).

editingbooleanNoEdit mode. Omit to follow the shell's layout editor (the pencil), so a grid inside `AppShell` edits with the rest of the page.

labelstringNoAccessible name of the grid.

headingLevel2 | 3 | 4NoHeading level of widget titles (default 2).

headingSnippet<[widget: OverviewWidget, title: string]>NoOptional title content; the grid retains the heading element and accessible id.

presentation'card' | 'plain'NoTile presentation outside edit mode (default card). Editing retains its frame.

modelsreadonly OverviewModelChoice[]NoModels offered by `model` option fields (else a text box).

iconComponentComponent<{ name: string; size?: number; }>NoHost renderer for icon names that are not built in.

Public export

Props

Bindable state

Callback events

Examples and explanation