s-m-r-t
Open the s-m-r-t source on GitHub Switch to dark color scheme
← All UI components

Svelte · Cookbook

CookbookApp

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

Public export

typescript
import { CookbookApp } from '@happyvertical/smrt-svelte/cookbook';
Import path
@happyvertical/smrt-svelte/cookbook
Props
8
Props described
5 of 8
Bindable state
0
Callback events
1
Verified release
0.57.40

Props

Also accepts Omit<ComponentProps<typeof AppShell>, 'navGroups' | 'nav' | 'navMode' | 'layout' | 'onlayoutchange' | 'preset' | 'colorScheme' | 'borderRadius' | 'density' | 'contrast' | 'sectionHref' | 'title' | 'children'>, Pick<BuildCookbookShellOptions, 'recipeOrder' | 'entryPath' | 'sectionPath' | 'href' | 'title'>. The table lists the component-specific contract.

NameTypeRequiredDescription
cookbookCookbookYesNot described
catalogCookbookCatalogYesNot described
navMode'sections' | 'sections-with-items'NoExpanded section entries are the default; use `sections` for headings only.
loadersCookbookLoadersNoData loaders for the `metric`, `records` and `chart` widgets. With `metric` and `records`, section pages also show a record count and the latest records of the section's lead model. `shortcuts` composes with the registry's own entries (see {@link CookbookShortcutsLoader}).
widgetContext() => Record<string, unknown>NoHost capabilities handed to widget loaders that run in the browser.
resolveExportRecipeExportResolverNoTurns a recipe export reference (`'@acme/shop/svelte#SalesTotal'`) into the export: a static map of dynamic imports in a bundled app. Without it, recipe `widget` and `shell-widget` surfaces are ignored.
oncookbookchange(cookbook: Cookbook) => voidNoCalled with the cookbook after a layout or overview edit.
childrenimport('svelte').SnippetYesNot described

Bindable state

This component has no bindable public state.

Callback events

  • oncookbookchange(cookbook: Cookbook) => void

Examples and explanation