Edit
<EditButton>
uses Ant Design's <Button>
component and 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. By default, the recordItemId
is inferred from the route params.
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.
resource
The 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.
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 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/antd";
export const MyListComponent = () => {
return (
<EditButton
accessControl={{
enabled: true,
hideIfUnauthorized: true,
}}
/>
);
};
resourceNameOrRouteName deprecated
Use resource
prop instead.
API Reference
Properties
Property | Type | Description | Default |
---|---|---|---|
hideText |
| Whether should hide the text and show only the icon or not. |
|
resourceNameOrRouteName Please use |
| Resource name for API data interactions | Reads |
resource |
| Resource name for API data interactions. | Inferred resource name from the route |
accessControl |
| Access Control configuration for the button |
|
onClick |
| Sets the handler to handle click event | |
recordItemId | Data item identifier for the actions with the API | Reads | |
meta |
|
|
It also accepts all props of Ant Design Button.