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

Svelte · Screens

ListScreen

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

Public export

typescript
import { ListScreen } from '@happyvertical/smrt-svelte/screens';
Import path
@happyvertical/smrt-svelte/screens
Props
18
Props described
16 of 18
Bindable state
0
Callback events
3
Verified release
0.57.40

Props

NameTypeRequiredDescription
definitionScreenCollectionDefinitionYesGenerated browser-safe collection definition.
policyScreenPolicy | nullNoResolved field policy for the same object; omit for the code seed.
rowsreadonly ScreenRecord[]YesRows to show.
titlestringNoPage title. Defaults to the pluralized class name.
descriptionstringNoSubtitle under the title.
columnsreadonly string[]NoExplicit column field names, in order (overrides the derived set).
maxColumnsnumberNoCap on derived columns.
pageSizenumberNoRows per page.
searchablebooleanNoShow the search box.
loadingbooleanNoNot described
errorstring | nullNoLoad failure message; rows already present stay visible.
currencystringNoISO 4217 code used by money fields.
localestringNoBCP-47 locale for number and date formatting.
showHeaderbooleanNoRender the page header (title and create action).
onselect(row: ScreenRecord) => voidNoRow activation (click or Enter).
oncreate() => voidNoWhen set, a create action is offered.
onretry() => voidNoNot described
extraActionsSnippetNoExtra header actions, rendered before the create action.

Bindable state

This component has no bindable public state.

Callback events

  • onselect(row: ScreenRecord) => void
  • oncreate() => void
  • onretry() => void

Examples and explanation