Edit

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

Swizzle

You can swizzle this component to customize it with the refine CLI

Usage

http://localhost:3000

import {
    List,
    useTable,
    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) => (
                        <EditButton size="small" recordItemId={record.id} />
                    )}
                />
            </Table>
        </List>
    );
};

interface IPost {
    id: number;
    title: string;
}

Properties

recordItemId

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

http://localhost:3000

import { EditButton } from "@refinedev/antd";

const MyEditComponent = () => {
    return (
        <EditButton
            resource="posts"
            recordItemId="123"
        />
    );
};

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.

note

<EditButton> component reads the id information from the route by default.

resource

Redirection endpoint is defined by the resource property and its edit action path. By default, <EditButton> uses the inferred resource from the route.

http://localhost:3000

import { EditButton } from "@refinedev/antd";

const MyEditComponent = () => {
    return (
        <EditButton
            resource="categories"
            recordItemId="123"
        />
    );
};

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.

http://localhost:3000

import { EditButton } from "@refinedev/antd";

const MyEditComponent = () => {
    return (
        <EditButton
            recordItemId="123"
            hideText={true}
        />
    );
};

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

resourceNameOrRouteName prop is deprecated. Use resource prop 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.

http://localhost:3000

import { EditButton } from "@refinedev/antd";

const MyEditComponent = () => {
    return (
        <EditButton
            resourceNameOrRouteName="categories"
            recordItemId="123"
        />
    );
};

Clicking the button will trigger the edit method of useNavigation and then redirect the app to /categories/edit/2.

API Reference

Properties

External Props

It also accepts all props of Ant Design Button.