Skip to main content
Version: 4.xx.xx
Swizzle Ready

List

<List> provides us a layout to display the page. It does not contain any logic and just adds extra functionalities like a create button and being able to give titles to the page.

We will show what <List> does using properties with examples.

localhost:3000/posts
import { List, DateField } from "@refinedev/mantine";
import { Table, Pagination } from "@mantine/core";
import { useTable } from "@refinedev/react-table";
import { ColumnDef, flexRender } from "@tanstack/react-table";

const PostList: React.FC = () => {
const columns = React.useMemo<ColumnDef<IPost>[]>(
() => [
{
id: "id",
header: "ID",
accessorKey: "id",
},
{
id: "title",
header: "Title",
accessorKey: "title",
},
{
id: "status",
header: "Status",
accessorKey: "status",
},
{
id: "createdAt",
header: "Created At",
accessorKey: "createdAt",
cell: function render({ getValue }) {
return <DateField value={getValue() as string} format="LLL" />;
},
},
],
[],
);

const {
getHeaderGroups,
getRowModel,
refineCore: { setCurrent, pageCount, current },
} = useTable({
columns,
});

return (
<List>
<Table>
<thead>
{getHeaderGroups().map((headerGroup) => (
<tr key={headerGroup.id}>
{headerGroup.headers.map((header) => (
<th key={header.id}>
{header.isPlaceholder
? null
: flexRender(
header.column.columnDef.header,
header.getContext(),
)}
</th>
))}
</tr>
))}
</thead>
<tbody>
{getRowModel().rows.map((row) => (
<tr key={row.id}>
{row.getVisibleCells().map((cell) => (
<td key={cell.id}>
{flexRender(cell.column.columnDef.cell, cell.getContext())}
</td>
))}
</tr>
))}
</tbody>
</Table>
<br />
<Pagination
position="right"
total={pageCount}
page={current}
onChange={setCurrent}
/>
</List>
);
};
Good to know:

You can swizzle this component with the Refine CLI to customize it.

Properties

title

title allows adding a title for the <List> component. If you don't pass title props, it uses plural form of resource name by default.

localhost:3000/posts
import { List } from "@refinedev/mantine";
import { Title } from "@mantine/core";

const PostList: React.FC = () => {
return (
<List title={<Title order={3}>Custom Title</Title>}>
<p>Rest of your page here</p>
</List>
);
};

resource

<List> component reads the resource information from the route by default. If you want to use a custom resource for the <List> component, you can use the resource prop.

localhost:3000/custom
import { List } from "@refinedev/mantine";

const CustomPage: React.FC = () => {
return (
<List resource="categories">
<p>Rest of your page here</p>
</List>
);
};

If you have multiple resources with the same name, you can pass the identifier instead of the name of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name of the resource defined in the <Refine/> component.

For more information, refer to the identifier section of the <Refine/> component documentation

canCreate and createButtonProps

canCreate allows us to add the create button inside the <List> component. If resource is passed a create component, Refine adds the create button by default. If you want to customize this button you can use createButtonProps property like the code below.

Create button redirects to the create page of the resource according to the value it reads from the URL.

localhost:3000/posts
import { List } from "@refinedev/mantine";
import { usePermissions } from "@refinedev/core";

const PostList: React.FC = () => {
const { data: permissionsData } = usePermissions();
return (
<List
canCreate={permissionsData?.includes("admin")}
createButtonProps={{ variant: "subtle" }}
>
<p>Rest of your page here</p>
</List>
);
};

To customize or disable the breadcrumb, you can use the breadcrumb property. By default it uses the Breadcrumb component from @refinedev/mantine package.

localhost:3000/posts
import { List } from "@refinedev/mantine";

const CustomBreadcrumb: React.FC = () => {
return (
<p
style={{
padding: "3px 6px",
border: "2px dashed cornflowerblue",
}}
>
My Custom Breadcrumb
</p>
);
};

const PostList: React.FC = () => {
return (
<List
breadcrumb={<CustomBreadcrumb />}
>
<p>Rest of your page here</p>
</List>
);
};

For more information, refer to the Breadcrumb documentation

wrapperProps

If you want to customize the wrapper of the <List/> component, you can use the wrapperProps property. For @refinedev/mantine wrapper element is <Card>s and wrapperProps can get every attribute that <Card> can get.

localhost:3000/posts
import { List } from "@refinedev/mantine";

const PostList: React.FC = () => {
return (
<List
wrapperProps={{
style: {
border: "2px dashed cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</List>
);
};

For more information, refer to the Card documentation from Mantine

headerProps

If you want to customize the header of the <List/> component, you can use the headerProps property.

localhost:3000/posts
import { List } from "@refinedev/mantine";

const PostList: React.FC = () => {
return (
<List
headerProps={{
style: {
border: "2px dashed cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</List>
);
};

For more information, refer to the Group documentation from Mantine

contentProps

If you want to customize the content of the <List/> component, you can use the contentProps property.

localhost:3000/posts
import { List } from "@refinedev/mantine";

const PostList: React.FC = () => {
return (
<List
contentProps={{
style: {
border: "2px dashed cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</List>
);
};

For more information, refer to the Box documentation from Mantine

headerButtons

By default, the <List/> component has a <CreateButton> at the header.

You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons, createButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.

If "create" resource is not defined or canCreate is false, the <CreateButton> will not render and createButtonProps will be undefined.

localhost:3000/posts
import { List } from "@refinedev/mantine";
import { Button } from "@mantine/core";

const PostList: React.FC = () => {
return (
<List
headerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button variant="outline" type="primary">
Custom Button
</Button>
</>
)}
>
<p>Rest of your page here</p>
</List>
);
};

Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use createButtonProps to utilize the default values of the <CreateButton> component.

localhost:3000/posts
import { List, CreateButton } from "@refinedev/mantine";
import { Button } from "@mantine/core";

const PostList: React.FC = () => {
return (
<List
headerButtons={({ createButtonProps }) => (
<>
{createButtonProps && (
<CreateButton {...createButtonProps} meta={{ foo: "bar" }} />
)}
<Button variant="outline" type="primary">
Custom Button
</Button>
</>
)}
>
<p>Rest of your page here</p>
</List>
);
};

headerButtonProps

You can customize the wrapper element of the buttons at the header by using the headerButtonProps property.

localhost:3000/posts
import { List } from "@refinedev/mantine";
import { Button } from "@mantine/core";

const PostList: React.FC = () => {
return (
<List
headerButtonProps={{
style: {
border: "2px dashed cornflowerblue",
padding: "16px",
},
}}
headerButtons={
<Button variant="outline" type="primary">
Custom Button
</Button>
}
>
<p>Rest of your page here</p>
</List>
);
};

For more information, refer to the Group documentation from Mantine

API Reference

Props

PropertyTypeDescriptionDefault
resource

string

Resource name for API data interactions

Reads :resource from the URL

title

ReactNode

Title of the create view

<Title order={3}>{resource.name}</Title>

wrapperProps

CardProps

Props for the wrapper component of the view

headerProps

GroupProps

Props for the header component

contentProps

BoxProps

Props for the content wrapper component

breadcrumb

ReactNode

Breadcrumb to be displayed in the header

<Breadcrumb />

headerButtons

ActionButtonRenderer<{ createButtonProps: CreateButtonProps; }>

Header action buttons to be displayed in the header

If canCreate is passed <CreateButton /> otherwise null

headerButtonProps

GroupProps

Additional props to be passed to the wrapper of the header buttons

canCreate

boolean

Adds create button

If the resource is passed a create component, true else false

createButtonProps

CreateButtonProps

Adds props for create button