Collections and tables

CollectionToolbar

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

Public export

typescript

import { CollectionToolbar } from '@happyvertical/smrt-ui/data';

Import path: @happyvertical/smrt-ui/data
Props: 15
Props described: 15 of 15
Bindable state: 0
Callback events: 2
Verified release: 0.44.0

Props

NameTypeRequiredDescription

searchstringNoCurrent search query string (bindable).

searchLabelstringNoLabel for the search input field.

searchPlaceholderstringNoPlaceholder text shown in the search input when empty.

view'list' | 'grid' | 'table'NoCurrently active view mode: list, grid, or table.

viewsArray<'list' | 'grid' | 'table'>NoAvailable view modes to choose from.

resultCountnumberNoTotal number of results in the current collection.

selectedCountnumberNoNumber of items currently selected.

filtersSnippetNoSnippet to render filter controls in the toolbar.

actionsSnippetNoSnippet to render action buttons in the toolbar.

bulkActionsSnippetNoSnippet to render bulk action buttons (shown when items are selected).

onsearchchange(value: string) => voidNoCallback when the user types in the search field.

onviewchange(view: 'list' | 'grid' | 'table') => voidNoCallback when the view mode is changed.

controllerDataTableControllerNoShares search state with a DataTable controller when supplied.

dataSurfaceCollectionToolbarDataSurfaceOptionsNoRegisters this toolbar only when explicitly supplied.

classstringNoCSS class to apply to the toolbar container.

Bindable state

This component has no bindable public state.

Callback events

onsearchchange(value: string) => void
onviewchange(view: 'list' | 'grid' | 'table') => void

Public export

Props

Bindable state

Callback events

Examples and explanation