documentation/docs/ui-integrations/ant-design/components/buttons/edit-button/index.md
<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.
:::simple Good to know
You can swizzle this component to customize it with the Refine CLI
:::
setInitialRoutes(["/posts"]);
// visible-block-start
import {
List,
useTable,
// highlight-next-line
EditButton,
} from "@refinedev/antd";
import { Table } from "antd";
const PostList: React.FC = () => {
const { tableProps } = useTable<IPost>();
return (
<List>
<Table {...tableProps} rowKey="id">
<Table.Column dataIndex="id" title="ID" />
<Table.Column dataIndex="title" title="Title" width="100%" />
<Table.Column<IPost>
title="Actions"
dataIndex="actions"
key="actions"
render={(_, record) => (
// highlight-next-line
<EditButton size="small" recordItemId={record.id} />
)}
/>
</Table>
</List>
);
};
interface IPost {
id: number;
title: string;
}
// visible-block-end
const PostEdit = () => {
const parsed = RefineCore.useParsed();
return <pre>{JSON.stringify(parsed, null, 2)}</pre>;
};
render(
<ReactRouter.BrowserRouter>
<RefineAntdDemo
resources={[
{
name: "posts",
list: "/posts",
edit: "/posts/:id/edit",
},
]}
>
<ReactRouter.Routes>
<ReactRouter.Route
path="/posts"
element={
<div style={{ padding: 16 }}>
<ReactRouter.Outlet />
</div>
}
>
<ReactRouter.Route index element={<PostList />} />
<ReactRouter.Route path=":id/edit" element={<PostEdit />} />
</ReactRouter.Route>
</ReactRouter.Routes>
</RefineAntdDemo>
</ReactRouter.BrowserRouter>,
);
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.
setInitialRoutes(["/posts"]);
// visible-block-start
import { EditButton } from "@refinedev/antd";
const MyEditComponent = () => {
return (
<EditButton
resource="posts"
// highlight-next-line
recordItemId="123"
/>
);
};
// visible-block-end
const PostEdit = () => {
const parsed = RefineCore.useParsed();
return <pre>{JSON.stringify(parsed, null, 2)}</pre>;
};
render(
<ReactRouter.BrowserRouter>
<RefineAntdDemo
resources={[
{
name: "posts",
list: "/posts",
edit: "/posts/:id/edit",
},
]}
>
<ReactRouter.Routes>
<ReactRouter.Route
path="/posts"
element={
<div style={{ padding: 16 }}>
<ReactRouter.Outlet />
</div>
}
>
<ReactRouter.Route index element={<MyEditComponent />} />
<ReactRouter.Route path=":id/edit" element={<PostEdit />} />
</ReactRouter.Route>
</ReactRouter.Routes>
</RefineAntdDemo>
</ReactRouter.BrowserRouter>,
);
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.
The redirection endpoint is defined by the resource property and its edit action path. By default, <EditButton> uses the inferred resource from the route.
setInitialRoutes(["/categories"]);
// visible-block-start
import { EditButton } from "@refinedev/antd";
const MyEditComponent = () => {
return (
<EditButton
// highlight-next-line
resource="categories"
recordItemId="123"
/>
);
};
// visible-block-end
const CategoryEdit = () => {
const parsed = RefineCore.useParsed();
return <pre>{JSON.stringify(parsed, null, 2)}</pre>;
};
render(
<ReactRouter.BrowserRouter>
<RefineAntdDemo
resources={[
{
name: "posts",
list: "/posts",
edit: "/posts/:id/edit",
},
{
name: "categories",
list: "/categories",
edit: "/categories/:id/edit",
},
]}
>
<ReactRouter.Routes>
<ReactRouter.Route
path="/categories"
element={
<div style={{ padding: 16 }}>
<ReactRouter.Outlet />
</div>
}
>
<ReactRouter.Route index element={<MyEditComponent />} />
<ReactRouter.Route path=":id/edit" element={<CategoryEdit />} />
</ReactRouter.Route>
</ReactRouter.Routes>
</RefineAntdDemo>
</ReactRouter.BrowserRouter>,
);
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
identifiersection of the<Refine/>component documentation →
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" }} />;
};
It is used to show and not show the text of the button. When true, only the button icon is visible.
setInitialRoutes(["/posts"]);
// visible-block-start
import { EditButton } from "@refinedev/antd";
const MyEditComponent = () => {
return (
<EditButton
// highlight-next-line
hideText={true}
recordItemId="123"
/>
);
};
// visible-block-end
const PostEdit = () => {
const parsed = RefineCore.useParsed();
return <pre>{JSON.stringify(parsed, null, 2)}</pre>;
};
render(
<ReactRouter.BrowserRouter>
<RefineAntdDemo
resources={[
{
name: "posts",
list: "/posts",
edit: "/posts/:id/edit",
},
]}
>
<ReactRouter.Routes>
<ReactRouter.Route
path="/posts"
element={
<div style={{ padding: 16 }}>
<ReactRouter.Outlet />
</div>
}
>
<ReactRouter.Route index element={<MyEditComponent />} />
<ReactRouter.Route path=":id/edit" element={<PostEdit />} />
</ReactRouter.Route>
</ReactRouter.Routes>
</RefineAntdDemo>
</ReactRouter.BrowserRouter>,
);
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,
}}
/>
);
};
:::simple External Props
It also accepts all props of Ant Design Button.
:::