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

Svelte · Screens

RecipeScreens

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

Public export

typescript
import { RecipeScreens } from '@happyvertical/smrt-svelte/screens';
Import path
@happyvertical/smrt-svelte/screens
Props
14
Props described
10 of 14
Bindable state
0
Callback events
1
Verified release
0.57.40

Props

NameTypeRequiredDescription
definitionScreenCollectionDefinitionYesNot described
policyScreenPolicy | nullNoResolved field policy for the same object; omit for the code seed.
sourceRecipeScreensSourceYesNot described
viewRecipeScreenViewNoCurrent screen (bindable).
recordIdstring | nullNoRecord shown by `view` and `edit` (bindable).
titlestringNoList title. Defaults to the pluralized class name.
columnsreadonly string[]NoExplicit list columns, in order.
fieldsreadonly string[]NoExplicit view / edit field names, in order.
currencystringNoNot described
localestringNoNot described
can{ create?: boolean; update?: boolean; delete?: boolean; }NoTurn operations off even when the source supports them.
onnavigate(view: RecipeScreenView, recordId: string | null) => voidNoCalled on every user navigation, for router synchronization.
definitionsReadonly<Record<string, ScreenCollectionDefinition>>NoEvery exposed collection definition, keyed by collection name; the record view derives this model's relations from it. Omit for none.
recordPick<RecordScreenProps, 'loaders' | 'registry' | 'widgetContext' | 'overview' | 'override' | 'onoverviewchange' | 'layoutEditing' | 'canCustomize' | 'hrefFor' | 'labels' | 'viewAllHref' | 'lineItemStoredTotals' | 'statusTones'>NoPassed to `RecordScreen` for the record view and edit.

Bindable state

This component has no bindable public state.

Callback events

  • onnavigate(view: RecipeScreenView, recordId: string | null) => void

Examples and explanation