Clone

<CloneButton> uses Chakra UI's <Button> component. It uses the clone method from useNavigation under the hood.

Swizzle

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

Usage

http://localhost:3000

import {
    List,
    CloneButton,
} 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: "actions",
                header: "Actions",
                accessorKey: "id",
                cell: function render({ getValue }) {
                    return (
                        <CloneButton recordItemId={getValue() as number} />
                    );
                },
            },
        ],
        [],
    );

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

    List.defaultProps = {
        headerButtons: <></>,
    };

    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>
    );
};

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

Properties

recordItemId

recordItemId is used to append the record id to the end of the route path.

http://localhost:3000

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

const MyCloneComponent = () => {
    return <CloneButton colorScheme="black" recordItemId="123" />;
};

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

note

<CloneButton> component reads the id information from the route by default.

resource

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

http://localhost:3000

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

const MyCloneComponent = () => {
    return (
        <CloneButton
            colorScheme="black"
            resource="categories"
            recordItemId="2"
        />
    );
};

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

meta

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

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

const MyComponent = () => {
    return (
        <CloneButton 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.

http://localhost:3000

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

const MyCloneComponent = () => {
    return <CloneButton 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 { CloneButton } from "@refinedev/chakra-ui";

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

resourceNameOrRouteName

deprecated

resourceNameOrRouteName prop is deprecated. Use resource prop instead.

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

http://localhost:3000

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

const MyCloneComponent = () => {
    return (
        <CloneButton
            colorScheme="black"
            resourceNameOrRouteName="categories"
            recordItemId="2"
        />
    );
};

Clicking the button will trigger the clone method of useNavigation and then redirect the app to /categories/clone/2.

API Reference

Properties