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.
You can swizzle this component with the refine CLI to customize it.
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 the clone
action path of the resource, filling the necessary parameters in the route.
<CloneButton>
component reads the id information from the route by default.
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.
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.
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
resourceNameOrRouteName
resourceNameOrRouteName
prop is deprecated. Useresource
prop instead.
resourceNameOrRouteName
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
.
API Reference
It also accepts all props of Material UI Button.