Skip to contentSkip to content

Crud API

API reference docs for the React Crud component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import { Crud } from '@toolpad/core/Crud';
// or
import { Crud } from '@toolpad/core';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
dataSource*object-

Server-side data source.

rootPath*string-

Root path to CRUD pages.

dataSourceCache{ cache: object, clear: func, get: func, set: func, ttl: number }-

Cache for the data source.

defaultValuesobject{}

Default form values for a new item.

initialPageSizenumber100

Initial number of rows to show per page.

slotProps{ list: { dataGrid?: object } }{}

The props used for each slot inside.

slots{ list: { dataGrid?: func } }{}

The components used for each slot inside.

See Slots API below for more details.

The component cannot hold a ref.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.