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

Create

<CreateButton> uses UI's <Button> component. It uses the create method from useNavigation under the hood. It can be useful to redirect the app to the create page route of resource.

Swizzle

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

Usage​

localhost:3000
import {
    List,
    CreateButton,
} 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",
            },
        ],
        [],
    );

    const { getHeaderGroups, getRowModel } = useTable({
        columns,
    });

    return (
        <List headerButtons={<CreateButton />}>
            <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>
    );
};

interface IPost {
    id: number;
    title: string;
}

Properties​

resource​

It is used to redirect the app to the create action path of the given resource name. By default, the app redirects to the inferred resource's create action path.

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

const MyCreateComponent = () => {
    return (
        <CreateButton
            colorScheme="black"
            resource="categories"
        />
    );
};

Clicking the button will trigger the create method of useNavigation and then redirect the app to the create action path of the resource, filling the necessary parameters in the route.

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 →

meta​

It is used to pass additional parameters to the create method of useNavigation. By default, existing parameters in the route are used by the create method. You can pass additional parameters or override the existing ones using the meta prop.

If the create action route is defined by the pattern: /posts/:authorId/create, the meta prop can be used as follows:

const MyComponent = () => {
    return (
        <CreateButton meta={{ authorId: "10" }} />
    );
};

hideText​

It is used to show and not show the text of the button. When true, only the button icon is visible.

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

const MyCreateComponent = () => {
    return <CreateButton colorScheme="black" hideText />;
};

accessControl​

This prop can be used to skip access control check with its enabled property or to hide the button when the user does not have the permission to access the resource with hideIfUnauthorized property. This is relevant only when an accessControlProvider is provided to <Refine/>

import { CreateButton } from "@refinedev/chakra-ui";

export const MyListComponent = () => {
    return (
        <CreateButton
            accessControl={{ enabled: true, hideIfUnauthorized: true }}
        />
    );
};

resourceNameOrRouteName
deprecated
​

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

It is used to redirect the app to the /create endpoint of the given resource name. By default, the app redirects to a URL with /create defined by the name property of resource object.

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

const MyCreateComponent = () => {
    return (
        <CreateButton
            colorScheme="black"
            resourceNameOrRouteName="categories"
        />
    );
};

Clicking the button will trigger the create method of useNavigation and then redirect to /posts/create.

API Reference​

Properties​

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