Skip to main content
👀 Interested in the latest enterprise backend features of refine? 👉 Join now and get early access!
Documentation
Version: 4.xx.xx
Swizzle Ready

List

<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 titles to the page.

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

localhost:3000/posts
import { useMany } from "@refinedev/core";

import { List, TextField, TagField, useTable } from "@refinedev/antd";
import { Table } from "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>
    );
};
Swizzle

You can swizzle this component to customize it with the refine CLI

Properties​

title​

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

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

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

resource​

The <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/antd";

const CustomPage: React.FC = () => {
    return (
        <List resource="posts">
            <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 of the <Refine/> component documentation →

canCreate and createButtonProps​

canCreate allows us to add the create button inside the <List> component. If you want to customize this button you can use createButtonProps property like the code below:

localhost:3000/posts
import { List } from "@refinedev/antd";
import { usePermissions } from "@refinedev/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>
    );
};
NOTE

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

For more information, refer to the usePermission documentation →

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

Refer to the Breadcrumb documentation for detailed usage. →

TIP

This feature can be managed globally via the <Refine> component's options

localhost:3000/posts
import { List } from "@refinedev/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​

You can use the wrapperProps property if you want to customize the wrapper of the <List/> component. The @refinedev/antd wrapper elements are simply <div/>s and wrapperProps and can get every attribute that <div/> can get.

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

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

headerProps​

You can use the headerProps property to customize the header of the <List/> component:

localhost:3000/posts
import { List } from "@refinedev/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>
    );
};

For more information, refer to the PageHeader documentation →

contentProps​

You can use the contentProps property to customize the content of the <Create/> component. The <List/> components content is wrapped with a <div/> and contentProps can get every attribute that <div/> can get.

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

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

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.

CAUTION

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

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

const PostList: React.FC = () => {
    return (
        <List
            headerButtons={({ defaultButtons }) => (
                <>
                    {defaultButtons}
                    <Button 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/antd";
import { Button } from "antd";

const PostList: React.FC = () => {
    return (
        <List
            headerButtons={({ createButtonProps }) => (
                <>
                    {createButtonProps && (
                        <CreateButton
                            {...createButtonProps}
                            meta={{ foo: "bar" }}
                        />
                    )}
                    <Button 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/antd";
import { Button } from "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>
    );
};

For more information, refer to the Space documentation →

API Reference​

Properties​

Last updated on Jul 25, 2023 by Yıldıray Ünlü
Previous
Edit
Next
Show