Skip to main content
RefineDocumentation
Version: 5.xx.xx
Source Code

Clone

<CloneButton> uses shadcn/ui's <Button> component and 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.

Installation​

npx shadcn@latest add https://ui.refine.dev/r/buttons.json

This will add all button components including CloneButton.

Usage​

import { CloneButton } from "@/components/refine-ui/buttons/clone";
import { Table, TableBody, TableCell, TableRow } from "@/components/ui/table";

const PostList = () => {
  const posts = [
    { id: 1, title: "First Post" },
    { id: 2, title: "Second Post" },
  ];

  return (
    <Table>
      <TableBody>
        {posts.map((post) => (
          <TableRow key={post.id}>
            <TableCell>{post.title}</TableCell>
            <TableCell>
              <CloneButton resource="posts" recordItemId={post.id} />
            </TableCell>
          </TableRow>
        ))}
      </TableBody>
    </Table>
  );
};

Properties​

recordItemId​

recordItemId is used to append the record id to the end of the route path. By default, the recordItemId is inferred from the route params.

import { CloneButton } from "@/components/refine-ui/buttons/clone";

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

resource​

resource 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.

import { CloneButton } from "@/components/refine-ui/buttons/clone";

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

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.

import { CloneButton } from "@/components/refine-ui/buttons/clone";

const MyComponent = () => {
  return <CloneButton recordItemId="123" hideText={true} />;
};

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 "@/components/refine-ui/buttons/clone";

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

children​

It is used to change the text of the button. By default, the text is "Clone".

import { CloneButton } from "@/components/refine-ui/buttons/clone";

const MyComponent = () => {
  return <CloneButton recordItemId="123">Duplicate</CloneButton>;
};

API Reference​

Properties​

PropertyTypeDefaultDescription
recordItemIdBaseKey (string or number)Inferred from route paramsThe ID of the record to clone
resourcestringInferred from routeThe resource name or identifier
metaRecord<string, unknown>-Additional metadata to pass to the clone method
hideTextbooleanfalseIf true, only the icon will be shown
accessControl{ enabled?: boolean; hideIfUnauthorized?: boolean }{ enabled: true, hideIfUnauthorized: false }Configures access control behavior
childrenReactNodeDefault text & iconCustom content for the button
...restReact.ComponentProps<typeof Button>-Other props are passed to the underlying shadcn/ui Button component (e.g., variant, size, className, onClick)
External Props

It also accepts all props of shadcn/ui Button.

Previous
<ForgotPasswordForm />
Next
Create