Skip to main content
Version: 3.xx.xxSwizzle Ready

Clone

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

http://localhost:3000/posts
import {
useDataGrid,
DataGrid,
GridColumns,
List,
CloneButton,
} from "@pankod/refine-mui";

const columns: GridColumns = [
{ field: "id", headerName: "ID", type: "number" },
{ field: "title", headerName: "Title", minWidth: 400, flex: 1 },
{
field: "actions",
headerName: "Actions",
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} autoHeight />
</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 "@pankod/refine-mui";

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

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

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.

http://localhost:3000
import { CloneButton } from "@pankod/refine-mui";

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

http://localhost:3000
import { CloneButton } from "@pankod/refine-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 "@pankod/refine-mui";

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

API Reference

External Props

It also accepts all props of Material UI Button.