Edit
<EditButton> uses Mantine <Button> component. It uses the edit method from useNavigation under the hood. It can be useful when redirecting the app to the edit page with the record id route of resource.
You can swizzle this component to customize it with the refine CLI
Usage
Properties
recordItemId
recordItemId is used to append the record id to the end of the route path.
resource
Redirection endpoint is defined by the resource property and its edit action path. By default, <EditButton> uses the inferred resource from the route.
Clicking the button will trigger the edit method of useNavigation and then redirect the app to the edit action path of the resource, filling the necessary parameters in the route.
meta
It is used to pass additional parameters to the edit method of useNavigation. By default, existing parameters in the route are used by the edit method. You can pass additional parameters or override the existing ones using the meta prop.
If the edit action route is defined by the pattern: /posts/:authorId/edit/:id, the meta prop can be used as follows:
const MyComponent = () => {
return (
<EditButton meta={{ authorId: "10" }} />
);
};
hideText
It 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 { EditButton } from "@refinedev/mantine";
export const MyListComponent = () => {
return (
<EditButton
accessControl={{ enabled: true, hideIfUnauthorized: true }}
/>
);
};
resourceNameOrRouteName deprecated
resourceNameOrRouteName
resourceNameOrRouteNameprop is deprecated. Useresourceprop instead.
Redirection endpoint(resourceNameOrRouteName/edit) is defined by resourceNameOrRouteName property. By default, <EditButton> uses name property of the resource object as an endpoint to redirect after clicking.
Clicking the button will trigger the edit method of useNavigation and then redirect the app to /categories/edit/2.