Skip to main content
Version: 3.xx.xx

Clone

<CloneButton> uses Ant Design'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.

Usage​

Properties​

recordItemId​

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

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.

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.

ignoreAccessControlProvider​

It is used to skip access control for the button so that it doesn't check for access control. This is relevant only when an accessControlProvider is provided to <Refine/>

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

export const MyListComponent = () => {
return <CloneButton ignoreAccessControlProvider />;
};

API Reference​

Properties​

PropertyDescriptionTypeDefault
propsAnt Design button propsButtonProps & { resourceName?: string; recordItemId?: BaseKey; hideText?: boolean; }
resourceNameOrRouteNameDetermines which resource to use for redirectionstringResource name that it reads from route
resourceName
deprecated
Determines which resource to use for redirectionstringResource name that it reads from route
recordItemIdAdds id to the end of the URLBaseKeyRecord id that it reads from route
hideTextAllows to hide button textbooleanfalse
ignoreAccessControlProviderSkip access controlbooleanfalse
childrenSets the button textReactNode"Clone"
iconSets the icon component of buttonReactNode<PlusSquareOutlined />
onClickSets the handler to handle click event(event) => voidTriggers navigation for redirection to the create page of resource