Skip to main content
Refine AI
RefineDocumentation
Version: 3.xx.xx
Swizzle Ready

Edit

<EditButton> uses Material UI <Button> component. It uses the edit method from useNavigation under the hood. It can be useful to redirect the app to the edit page route of resource.

Swizzle

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

Usage​

localhost:3000/posts
Live previews only work with the latest documentation.
import {
  useDataGrid,
  DataGrid,
  GridColumns,
  List,
  EditButton,
} from "@pankod/refine-mui";

const columns: GridColumns = [
  { field: "id", headerName: "ID", type: "number" },
  { field: "title", headerName: "Title", minWidth: 400, flex: 1 },
  {
    field: "actions",
    headerName: "Actions",
    renderCell: function render({ row }) {
      return <EditButton size="small" recordItemId={row.id} />;
    },
    align: "center",
    headerAlign: "center",
    minWidth: 80,
  },
];

const PostsList: React.FC = () => {
  const { dataGridProps } = useDataGrid<IPost>();

  return (
    <List>
      <DataGrid {...dataGridProps} columns={columns} autoHeight />
    </List>
  );
};

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

Properties​

recordItemId​

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

localhost:3000
Live previews only work with the latest documentation.
import { EditButton } from "@pankod/refine-mui";

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

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​

It is used to redirect the app to the /edit endpoint of the given resource name. By default, the app redirects to a URL with /edit defined by the name property of resource object.

localhost:3000
Live previews only work with the latest documentation.
import { EditButton } from "@pankod/refine-mui";

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

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

hideText​

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

localhost:3000
Live previews only work with the latest documentation.
import { EditButton } from "@pankod/refine-mui";

const MyEditComponent = () => {
  return (
    <EditButton
      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 "@pankod/refine-mui";

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

API Reference​

Properties​

External Props

It also accepts all props of Material UI Button.

Previous
Delete
Next
Export