<List> provides us a layout to display the page. It does not contain any logic but adds extra functionalities like a create button or giving the page titles.
We will show what <List> does using properties with examples.
Live previews only work with the latest documentation.
import React from "react";
import { useMany } from "@pankod/refine-core";
import {
List,
DataGrid,
DateField,
useDataGrid,
GridColumns,
} from "@pankod/refine-mui";
const SampleList = () => {
const { dataGridProps } = useDataGrid();
const { data: categoryData, isLoading: categoryIsLoading } = useMany({
resource: "categories",
ids: dataGridProps?.rows?.map((item: any) => item?.category?.id) ?? [],
queryOptions: {
enabled: !!dataGridProps?.rows,
},
});
const columns = React.useMemo<GridColumns<any>>(
() => [
{
field: "id",
headerName: "Id",
type: "number",
minWidth: 50,
},
{
field: "title",
headerName: "Title",
minWidth: 200,
},
{
field: "category",
headerName: "Category",
valueGetter: ({ row }) => {
const value = row?.category?.id;
return value;
},
minWidth: 300,
renderCell: function render({ value }) {
return categoryIsLoading ? (
<>Loading...</>
) : (
categoryData?.data?.find((item) => item.id === value)
?.title
);
},
},
{
field: "createdAt",
headerName: "Created At",
minWidth: 250,
renderCell: function render({ value }) {
return <DateField value={value} />;
},
}
],
[categoryData?.data],
);
return (
<List>
<DataGrid {...dataGridProps} columns={columns} autoHeight />
</List>
);
};
You can swizzle this component to customize it with the refine CLI
Properties
title
It allows adding title inside the <List> component. if you don't pass title props it uses the plural resource name by default. For example, for the /posts resource, it will be "Posts".
Live previews only work with the latest documentation.
import { List, Typography } from "@pankod/refine-mui";
const ListPage: React.FC = () => {
return (
<List
title={<Typography variant="h5">Custom Title</Typography>}
>
<span>Rest of your page here</span>
</List>
);
};
resource
The <List> component reads the resource information from the route by default. This default behavior will not work on custom pages. If you want to use the <List> component in a custom page, you can use the resource prop.
Refer to the custom pages documentation for detailed usage. →
Live previews only work with the latest documentation.
import { Refine } from "@pankod/refine-core";
import { List, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
const CustomPage: React.FC = () => {
return (
<List resource="posts">
<span>Rest of your page here</span>
</List>
);
};
const App: React.FC = () => {
return (
<Refine
routerProvider={{
...routerProvider,
routes: [
{
element: <CustomPage />,
path: "/custom",
},
],
}}
Layout={Layout}
dataProvider={dataProvider("https://api.fake-rest.refine.dev")}
resources={[{ name: "posts" }]}
/>
);
};
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.
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-mui";
import { usePermissions } from "@pankod/refine-core";
const PostList: React.FC = () => {
const { data: permissionsData } = usePermissions();
return (
<List
canCreate={permissionsData?.includes("admin")}
createButtonProps={{ size: "small" }}
>
<p>Rest of your page here</p>
</List>
);
};
Refer to the usePermission documentation for detailed usage. →
breadcrumb
To customize or disable the breadcrumb, you can use the breadcrumb property. By default it uses the Breadcrumb component from @pankod/refine-mui package.
Refer to the Breadcrumb documentation for detailed usage. →
This feature can be managed globally via the <Refine> component's options
Live previews only work with the latest documentation.
import { List, Breadcrumb } from "@pankod/refine-mui";
const PostList: React.FC = () => {
return (
<List
breadcrumb={
<div
style={{
padding: "3px 6px",
border: "2px dashed cornflowerblue",
}}
>
<Breadcrumb />
</div>
}
>
<span>Rest of your page here</span>
</List>
);
};
wrapperProps
If you want to customize the wrapper of the <List/> component, you can use the wrapperProps property.
Refer to the Card documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-mui";
const PostList: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<List
wrapperProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
>
<span>Rest of your page here</span>
</List>
);
};
If you want to customize the header of the <List/> component, you can use the headerProps property.
Refer to the CardHeader documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-mui";
const PostList: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<List
headerProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
>
<span>Rest of your page here</span>
</List>
);
};
contentProps
If you want to customize the content of the <List/> component, you can use the contentProps property.
Refer to the CardContent documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-mui";
const PostList: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<List
contentProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
>
<span>Rest of your page here</span>
</List>
);
};
You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons }) => React.ReactNode which you can use to keep the existing buttons and add your own.
Live previews only work with the latest documentation.
import { List, Button } from "@pankod/refine-mui";
const PostList: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<List
headerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<span>Rest of your page here</span>
</List>
);
};
You can customize the wrapper element of the buttons at the header by using the headerButtonProps property.
Refer to the Box documentation from Material UI for detailed usage. →
Live previews only work with the latest documentation.
import { List, Button } from "@pankod/refine-mui";
const PostList: React.FC = () => {
const [loading, setLoading] = React.useState(true);
return (
<List
headerButtonProps={{
sx: {
backgroundColor: "lightsteelblue",
},
}}
headerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<span>Rest of your page here</span>
</List>
);
};
cardProps
Use wrapperProps instead.
<List> uses the Material UI <Card> components so you can customize with the props of cardProps.
<List> uses the Material UI <CardHeader> components so you can customize with the props of cardHeaderProps.
src/pages/posts/create.tsx
import { List, Typography } from "@pankod/refine-mui";
export const CreatePage: React.FC = () => {
return (
<List
cardHeaderProps={{
title: <Typography variant="h5">Custom Title</Typography>,
}}
>
...
</List>
);
};
cardContentProps
Use contentProps instead.
<List> uses the Material UI <CardContent> components so you can customize with the props of cardContentProps.
API Reference
Properties
http://localhost:3000/posts