Skip to main content

<List>

The page-level component for displaying a collection of records. It fetches data, manages pagination and sorting state, and renders a <Table> by default (or a <Cards> if set as the resource's listComponent).

Usage​

With no children, <List> renders a <Table> automatically using the resource's schema fields.

<List />

Custom columns​

Pass a <Table> child to control which columns appear.

<List>
  <Table>
    <Table.Column source="name" />
    <Table.NumberColumn source="price" label="Price (USD)" />
  </Table>
</List>

Include / Exclude columns​

Use include or exclude to filter the auto-generated table without writing a custom <Table>.

<List include={['name', 'price', 'category']} />
<List exclude={['internalNotes']} />

Title and description​

<List title="All Products" description="Browse and manage the product catalog." />

Disabling filtering or preferences​

<List filtering={false} preferences={false} />

Props​

PropTypeDefaultDescription