Skip to main content
Refine AI
RefineDocumentation
Version: 3.xx.xx
Swizzle Ready

Clone

<CloneButton> uses Chakra UI's <Button> component. It uses the clone method from useNavigation under the hood. It can be useful when redirecting the app to the create page with the record id route of resource.

Swizzle

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

Usage​

localhost:3000
Live previews only work with the latest documentation.
import {
  List,
  TableContainer,
  Table,
  Thead,
  Tr,
  Th,
  Tbody,
  Td,
  CloneButton,
} from "@pankod/refine-chakra-ui";
import { useTable, ColumnDef, flexRender } from "@pankod/refine-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.

localhost:3000
Live previews only work with the latest documentation.
import { CloneButton } from "@pankod/refine-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 /posts/clone/123.

NOTE

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

resourceNameOrRouteName​

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.

localhost:3000
Live previews only work with the latest documentation.
import { CloneButton } from "@pankod/refine-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.

hideText​

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

localhost:3000
Live previews only work with the latest documentation.
import { CloneButton } from "@pankod/refine-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 "@pankod/refine-chakra-ui";

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

API Reference​

Properties​

Previous
Breadcrumb
Next
Create