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

Clone

<CloneButton> Material 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.

Good to know:

You can swizzle this component with the Refine CLI to customize it.

Usage​

localhost:3000/posts
import {
  useDataGrid,
  List,
  CloneButton,
} from "@refinedev/mui";
import { DataGrid, GridColDef } from "@mui/x-data-grid";

const columns: GridColDef[] = [
  { field: "id", headerName: "ID", type: "number" },
  { field: "title", headerName: "Title", minWidth: 400, flex: 1 },
  {
    field: "actions",
    headerName: "Actions",
    display: "flex",
    renderCell: function render({ row }) {
      return <CloneButton size="small" recordItemId={row.id} />;
    },
    align: "center",
    headerAlign: "center",
    minWidth: 80,
  },
];

const PostsList: React.FC = () => {
  const { dataGridProps } = useDataGrid<IPost>();

  return (
    <List>
      <DataGrid {...dataGridProps} columns={columns} />
    </List>
  );
};

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

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.

localhost:3000
import { CloneButton } from "@refinedev/mui";

const MyCloneComponent = () => {
  return <CloneButton resource="posts" recordItemId="1" />;
};

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​

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.

localhost:3000
import { CloneButton } from "@refinedev/mui";

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

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 section of the <Refine/> component documentation →

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 MyCloneComponent = () => {
  return <CloneButton meta={{ authorId: "10" }} />;
};

hideText​

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

localhost:3000
import { CloneButton } from "@refinedev/mui";

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

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

resourceNameOrRouteName
deprecated
​

Use resource prop instead.

API Reference​

PropertyTypeDescriptionDefault
hideText

boolean

Whether should hide the text and show only the icon or not.

false

resourceNameOrRouteName

Please use resource instead.

string

Resource name for API data interactions

Reads :resource from the URL

resource

string

Resource name for API data interactions. identifier of the resource can be used instead of the name of the resource.

Inferred resource name from the route

accessControl

{ enabled?: boolean; hideIfUnauthorized?: boolean; }

undefined

Access Control configuration for the button

{ enabled: true }

onClick

(PointerEventHandler<HTMLButtonElement> & MouseEventHandler<HTMLButtonElement>)

Sets the handler to handle click event

recordItemId

BaseKey

Data item identifier for the actions with the API

Reads :id from the URL

meta

Record<string, unknown>

meta property is used when creating the URL for the related action and path.

svgIconProps

SvgIconProps

External Props:

It also accepts all props of Material UI Button.

Previous
Show
Next
Create