<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 { useMany } from "@pankod/refine-core";
import {
List,
Table,
TextField,
TagField,
useTable,
} from "@pankod/refine-antd";
const PostList: React.FC = () => {
const { tableProps } = useTable<IPost>({
syncWithLocation: true,
});
const categoryIds =
tableProps?.dataSource?.map((item) => item.category.id) ?? [];
const { data, isLoading } = useMany<ICategory>({
resource: "categories",
ids: categoryIds,
queryOptions: {
enabled: categoryIds.length > 0,
},
});
return (
<List>
<Table {...tableProps} rowKey="id">
<Table.Column dataIndex="id" title="ID" />
<Table.Column dataIndex="title" title="Title" />
<Table.Column
dataIndex={["category", "id"]}
title="Category"
render={(value) => {
if (isLoading) {
return <TextField value="Loading..." />;
}
return (
<TextField
value={
data?.data.find((item) => item.id === value)
?.title
}
/>
);
}}
/>
<Table.Column
dataIndex="status"
title="Status"
render={(value: string) => <TagField value={value} />}
/>
</Table>
</List>
);
};
You can swizzle this component to customize it with the refine CLI
Properties
title
It allows adding a title for the <List> component. if you don't pass title props, it uses plural form of resource name by default.
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-antd";
const PostList: React.FC = () => {
return (
<List title="Custom Title">
<p>Rest of your page here</p>
</List>
);
};
resource
<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 } from "@pankod/refine-antd";
import routerProvider from "@pankod/refine-react-router-v6";
import dataProvider from "@pankod/refine-simple-rest";
const CustomPage: React.FC = () => {
return (
<List resource="posts">
<p>Rest of your page here</p>
</List>
);
};
const App: React.FC = () => {
return (
<Refine
routerProvider={{
...routerProvider,
routes: [
{
element: <CustomPage />,
path: "/custom",
},
],
}}
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-antd";
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-antd 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 } from "@pankod/refine-antd";
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>
);
};
wrapperProps
If you want to customize the wrapper of the <List/> component, you can use the wrapperProps property. For @pankod/refine-antd wrapper elements are simple <div/>s and wrapperProps can get every attribute that <div/> can get.
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-antd";
const PostList: React.FC = () => {
return (
<List
wrapperProps={{
style: {
backgroundColor: "cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</List>
);
};
If you want to customize the header of the <List/> component, you can use the headerProps property.
Refer to the PageHeader documentation from Ant Design for detailed usage. →
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-antd";
const PostList: React.FC = () => {
return (
<List
headerProps={{
subTitle: "This is a subtitle",
style: {
backgroundColor: "cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</List>
);
};
contentProps
If you want to customize the content of the <List/> component, you can use the contentProps property. <List/> components content is wrapped with a <div/> and contentProps can get every attribute that <div/> can get.
Live previews only work with the latest documentation.
import { List } from "@pankod/refine-antd";
const PostList: React.FC = () => {
return (
<List
contentProps={{
style: {
backgroundColor: "cornflowerblue",
padding: "16px",
},
}}
>
<p>Rest of your page here</p>
</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-antd";
const PostList: React.FC = () => {
return (
<List
headerButtons={({ defaultButtons }) => (
<>
{defaultButtons}
<Button type="primary">Custom Button</Button>
</>
)}
>
<p>Rest of your page here</p>
</List>
);
};
You can customize the wrapper element of the buttons at the header by using the headerButtonProps property.
Refer to the Space documentation from Ant Design for detailed usage. →
Live previews only work with the latest documentation.
import { List, Button } from "@pankod/refine-antd";
const PostList: React.FC = () => {
return (
<List
headerButtonProps={{
style: {
backgroundColor: "cornflowerblue",
padding: "16px",
},
}}
headerButtons={<Button type="primary">Custom Button</Button>}
>
<p>Rest of your page here</p>
</List>
);
};
API Reference
Properties
http://localhost:3000/posts