Skip to main content

SchemaList

Renders the list view of a resource: columns, filters, sorting, pagination and row actions, all from the view schema.

A resource gets this view automatically. Mount it explicitly only to pass one of the slots below or to wrap the generated content in your own.

Example​

<SchemaResource
name="eshop/product"
list={
<SchemaList listActions={<><SchemaListActions /><ImportButton /></>}>
<ProductListContent />
</SchemaList>
}
/>

A generated list view with filters, column selector and row actions

Props​

NameTypeDefaultDescription
namestring'list'Which list view of the schema to render, when the resource has several
childrenReactNodegenerated contentReplaces the generated datagrid
titleReactNode<SchemaViewTitle />Card header; null removes it
toolbarActionsReactNode<SchemaViewToolbarActions />Buttons next to the title; null removes them
listActionsReactNode<SchemaListActions />Utility row — column selector, resets, filter toggle
datagridButtonsReactNode—Extra buttons rendered in the datagrid's row action column

The slots are described in detail on View slots.

What the schema drives​

SchemaEffect
ListViewParameters.boxesWhich columns appear and in what order
ListViewParameters.filtersThe offered filters; each one with isAlwaysOn goes into the always-visible toolbar row, the rest into the filter drawer
ListViewParameters.extraFiltersFilters applied on top of the user's, and not shown
ListViewParameters.toolbarActionsButtons next to the title
ListViewParameters.listActionsUtility actions next to the filter bar
ListViewParameters.rowActionsButtons in the row action column
ListViewParameters.defaultSorting / sortableInitial sort, and drag-and-drop ordering
singleClickAction / doubleClickActionWhat clicking a row does; falls back to defaultRowAction on SchemaAdmin

See also​