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.

Usage

import { useTable } from "@pankod/refine-core";

import {
    List,
    Table,
    CloneButton,
    TableHead,
    TableRow,
    TableCell,
    TableBody,
} from "@pankod/refine-mui";

export const PostList: React.FC = () => {
    const { tableQueryResult } = useTable<IPost>();

    const { data } = tableQueryResult;

    return (
        <List>
            <Table aria-label="simple table">
                <TableHead>
                    <TableRow>
                        <TableCell>ID</TableCell>
                        <TableCell>Title</TableCell>
                        <TableCell align="center">Action</TableCell>
                    </TableRow>
                </TableHead>
                <TableBody>
                    {data?.data.map((row) => (
                        <TableRow key={row.id}>
                            <TableCell>{row.id}</TableCell>
                            <TableCell component="th" scope="row">
                                {row.title}
                            </TableCell>
                            <TableCell align="center">
                                <CloneButton recordItemId={row.id} />
                            </TableCell>
                        </TableRow>
                    ))}
                </TableBody>
            </Table>
        </List>
    );
};

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

Will look like this:

Properties

recordItemId

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

import { CloneButton } from "@pankod/refine-mui";

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

import { CloneButton } from "@pankod/refine-mui";

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

import { CloneButton } from "@pankod/refine-mui";

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

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

API Reference

External Props

It also accepts all props of Material UI Button.