Edit - Refine — ContextQMD

<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.

:::info-tip Swizzle You can swizzle this component to customize it with the refine CLI :::

Usage

tsx

// visible-block-start
import {
  Table,
  List,
  useTable,
  // highlight-next-line
  EditButton,
} from "@pankod/refine-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

render(
  <RefineAntdDemo
    resources={[
      {
        name: "posts",
        list: PostList,
      },
    ]}
  />,
);

Properties

`recordItemId`

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

tsx

const { useRouterContext } = RefineCore;
// visible-block-start
import { EditButton } from "@pankod/refine-antd";

const MyEditComponent = () => {
  return (
    <EditButton
      resourceNameOrRouteName="posts"
      // highlight-next-line
      recordItemId="123"
    />
  );
};

// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
        list: () => {
          return <RefineAntd.List>List page here...</RefineAntd.List>;
        },
        edit: () => {
          return <RefineAntd.Edit>Edit page here...</RefineAntd.Edit>;
        },
      },
    ]}
    DashboardPage={MyEditComponent}
  />,
);

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

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

`resourceNameOrRouteName`

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.

tsx

const { useRouterContext } = RefineCore;

// visible-block-start
import { EditButton } from "@pankod/refine-antd";

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

// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
        list: () => {
          return <RefineAntd.List>List page here...</RefineAntd.List>;
        },
        edit: () => {
          return <RefineAntd.Edit>Edit page here...</RefineAntd.Edit>;
        },
      },
      {
        name: "categories",
        list: () => {
          return <RefineAntd.List>List page here...</RefineAntd.List>;
        },
        edit: () => {
          return <RefineAntd.Edit>Edit page here...</RefineAntd.Edit>;
        },
      },
    ]}
    DashboardPage={MyEditComponent}
  />,
);

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

`hideText`

It is used to show and not show the text of the button. When true, only the button icon is visible.

tsx

const { useRouterContext } = RefineCore;

// visible-block-start
import { EditButton } from "@pankod/refine-antd";

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

// visible-block-end

render(
  <RefineAntdDemo
    initialRoutes={["/"]}
    resources={[
      {
        name: "posts",
        list: MyEditComponent,
        edit: () => {
          return <RefineAntd.Edit>Edit page here...</RefineAntd.Edit>;
        },
      },
    ]}
  />,
);

`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/>

tsx

import { EditButton } from "@pankod/refine-antd";

export const MyListComponent = () => {
  return (
    <EditButton
      // highlight-start
      accessControl={{
        enabled: true,
        hideIfUnauthorized: true,
      }}
      // highlight-end
    />
  );
};

API Reference

Properties

:::tip External Props It also accepts all props of Ant Design Button. :::