Svelte · Cookbook

CookbookSectionOverview

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

Public export

typescript

import { CookbookSectionOverview } from '@happyvertical/smrt-svelte/cookbook';

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

Props

NameTypeRequiredDescription

presentation'plain' | 'card'NoHow the overview's tiles are drawn outside edit mode: `'card'` (default) uses the current theme's framed styles. Explicit `'plain'` lists entries as unframed rows or tiles. Editing always keeps its frame.

headingimport('svelte').Snippet<[{ section: CookbookSectionHeadingInfo; }]>NoReplaces the section heading with host content.

definitionOverviewDefinitionYesThe section's default overview from the cookbook; read once at mount (key the component on the section id).

registryWidgetRegistryYesWidget types available on this overview, with their option schemas and loaders.

storeCookbookOverviewStoreYesWhere the user's edits to this overview are read from and written back to (the cookbook override).

entriesReadonlyMap<string, CookbookEntry>YesThe section's menu entries by id, passed to loaders so shortcuts follow renames, hides and moves.

componentsWidgetComponentsYesSvelte component that renders each widget type.

modelsreadonly OverviewModelChoice[]YesModels the user may pick as a widget's data source in edit mode.

hostContext() => Record<string, unknown>YesHost capabilities for widget loaders.

labelstringYesAccessible name of the overview grid, usually the section title.

sectionCookbookSectionHeadingInfoNoThe section; needed for `heading`, which renders above the grid.

Public export

Props

Bindable state

Callback events

Examples and explanation