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

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

localhost:3000/posts
import { List, DateField } from "@refinedev/chakra-ui";
import {
    TableContainer,
    Table,
    Thead,
    Tr,
    Th,
    Tbody,
    Td,
} from "@chakra-ui/react";
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>
            <TableContainer>
                <Table variant="simple" whiteSpace="pre-line">
                    <Thead>
                        {getHeaderGroups().map((headerGroup) => (
                            <Tr key={headerGroup.id}>
                                {headerGroup.headers.map((header) => {
                                    return (
                                        <Th key={header.id}>
                                            {!header.isPlaceholder &&
                                                flexRender(
                                                    header.column.columnDef
                                                        .header,
                                                    header.getContext(),
                                                )}
                                        </Th>
                                    );
                                })}
                            </Tr>
                        ))}
                    </Thead>
                    <Tbody>
                        {getRowModel().rows.map((row) => {
                            return (
                                <Tr key={row.id}>
                                    {row.getVisibleCells().map((cell) => {
                                        return (
                                            <Td key={cell.id}>
                                                {flexRender(
                                                    cell.column.columnDef.cell,
                                                    cell.getContext(),
                                                )}
                                            </Td>
                                        );
                                    })}
                                </Tr>
                            );
                        })}
                    </Tbody>
                </Table>
            </TableContainer>
        </List>
    );
};
Swizzle

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.

localhost:3000/posts
import { List } from "@refinedev/chakra-ui";
import { Heading } from "@chakra-ui/react";

const PostList: React.FC = () => {
    return (
        <List title={<Heading size="lg">Custom Title</Heading>}>
            <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/chakra-ui";

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 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/chakra-ui";
import { usePermissions } from "@refinedev/core";

const PostList: React.FC = () => {
    const { data: permissionsData } = usePermissions();
    return (
        <List
            canCreate={permissionsData?.includes("admin")}
            createButtonProps={{ colorScheme: "red", variant: "solid" }}
        >
            <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/chakra-ui 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/chakra-ui";
import { Box } from "@chakra-ui/react";

const CustomBreadcrumb: React.FC = () => {
    return (
        <Box borderColor="blue" borderStyle="dashed" borderWidth="2px" p="2">
            My Custom Breadcrumb
        </Box>
    );
};

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 @refinedev/chakra-ui wrapper element is <Box>s and wrapperProps can get every attribute that <Box> can get.

Refer to the Box documentation from Chakra UI for detailed usage. →

localhost:3000/posts
import { List } from "@refinedev/chakra-ui";

const PostList: React.FC = () => {
    return (
        <List
            wrapperProps={{
                borderColor: "blue",
                borderStyle: "dashed",
                borderWidth: "2px",
                p: "2",
            }}
        >
            <p>Rest of your page here</p>
        </List>
    );
};

headerProps​

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

Refer to the Box documentation from Chakra UI for detailed usage. →

localhost:3000/posts
import { List } from "@refinedev/chakra-ui";

const PostList: React.FC = () => {
    return (
        <List
            headerProps={{
                borderColor: "blue",
                borderStyle: "dashed",
                borderWidth: "2px",
                p: "2",
            }}
        >
            <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.

Refer to the Box documentation from Chakra UI for detailed usage. →

localhost:3000/posts
import { List } from "@refinedev/chakra-ui";

const PostList: React.FC = () => {
    return (
        <List
            contentProps={{
                borderColor: "blue",
                borderStyle: "dashed",
                borderWidth: "2px",
                padding: 2,
            }}
        >
            <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 "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/chakra-ui";
import { Button } from "@chakra-ui/react";

const PostList: React.FC = () => {
    return (
        <List
            headerButtons={({ defaultButtons }) => (
                <>
                    {defaultButtons}
                    <Button colorScheme="red" variant="solid">
                        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 } from "@refinedev/chakra-ui";
import { Button, CreateButton } from "@chakra-ui/react";

const PostList: React.FC = () => {
    return (
        <List
            headerButtons={({ createButtonProps }) => (
                <>
                    {createButtonProps && (
                        <CreateButton
                            {...createButtonProps}
                            meta={{ foo: "bar" }}
                        />
                    )}
                    <Button colorScheme="red" variant="solid">
                        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.

Refer to the Box documentation from Chakra UI for detailed usage. →

localhost:3000/posts
import { List } from "@refinedev/chakra-ui";
import { Button } from "@chakra-ui/react";

const PostList: React.FC = () => {
    return (
        <List
            headerButtonProps={{
                borderColor: "blue",
                borderStyle: "dashed",
                borderWidth: "2px",
                p: "2",
            }}
            headerButtons={
                <Button colorScheme="red" variant="solid">
                    Custom Button
                </Button>
            }
        >
            <p>Rest of your page here</p>
        </List>
    );
};

API Reference​

Props​

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