Edit

<Edit> provides us a layout for displaying the page. It does not contain any logic and just adds extra functionalities like a refresh button.

We will show what <Edit> does using properties with examples.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import {
  FormControl,
  FormErrorMessage,
  FormLabel,
  Input,
  Select,
} from "@chakra-ui/react";
import { useSelect } from "@refinedev/core";
import { useForm } from "@refinedev/react-hook-form";

const PostEdit: React.FC = () => {
  const {
    refineCore: { formLoading, queryResult },
    saveButtonProps,
    register,
    formState: { errors },
    resetField,
  } = useForm<IPost>();

  const { options } = useSelect({
    resource: "categories",

    defaultValue: queryResult?.data?.data.category.id,
    queryOptions: { enabled: !!queryResult?.data?.data.category.id },
  });

  useEffect(() => {
    resetField("category.id");
  }, [options]);

  return (
    <Edit isLoading={formLoading} saveButtonProps={saveButtonProps}>
      <FormControl mb="3" isInvalid={!!errors?.title}>
        <FormLabel>Title</FormLabel>
        <Input
          id="title"
          type="text"
          {...register("title", { required: "Title is required" })}
        />
        <FormErrorMessage>{`${errors.title?.message}`}</FormErrorMessage>
      </FormControl>
      <FormControl mb="3" isInvalid={!!errors?.status}>
        <FormLabel>Status</FormLabel>
        <Select
          id="content"
          placeholder="Select Post Status"
          {...register("status", {
            required: "Status is required",
          })}
        >
          <option>published</option>
          <option>draft</option>
          <option>rejected</option>
        </Select>
        <FormErrorMessage>{`${errors.status?.message}`}</FormErrorMessage>
      </FormControl>
      <FormControl mb="3" isInvalid={!!errors?.categoryId}>
        <FormLabel>Category</FormLabel>
        <Select
          id="ca"
          placeholder="Select Category"
          {...register("category.id", {
            required: true,
          })}
        >
          {options?.map((option) => (
            <option value={option.value} key={option.value}>
              {option.label}
            </option>
          ))}
        </Select>
        <FormErrorMessage>{`${errors.categoryId?.message}`}</FormErrorMessage>
      </FormControl>
    </Edit>
  );
};

Good to know:

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

Properties

title

title allows the addition of titles inside the <Edit> component. if you don't pass title props it uses the "Edit" prefix and singular resource name by default. For example, for the "posts" resource, it would be "Edit post".

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { Heading } from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  return (
    <Edit title={<Heading size="lg">Custom Title</Heading>}>
      <p>Rest of your page here</p>
    </Edit>
  );
};

saveButtonProps

saveButtonProps can be used to customize the default button of the <Edit> component that submits the form:

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";

const PostEdit: React.FC = () => {
  return (
    <Edit saveButtonProps={{ colorScheme: "red" }}>
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the <SaveButton> documentation →

canDelete and deleteButtonProps

canDelete allows us to add the delete button inside the <Edit> component that executes the useDelete method provided by the dataProvider when clicked on.

If the resource has the canDelete property, Refine adds the delete button by default. If you want to customize this button, you can use the deleteButtonProps property like the code below.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { usePermissions } from "@refinedev/core";

const PostEdit: React.FC = () => {
  const { data: permissionsData } = usePermissions();
  return (
    <Edit
      canDelete={permissionsData?.includes("admin")}
      deleteButtonProps={{ colorScheme: "orange" }}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the <DeleteButton> → and usePermission → documentations

resource

<Edit> component reads the resource information from the route by default. If you want to use a custom resource for the <Edit> component, you can use the resource prop.

localhost:3000/custom/23

import { Edit } from "@refinedev/chakra-ui";

const CustomPage: React.FC = () => {
  return (
    <Edit resource="categories">
      <p>Rest of your page here</p>
    </Edit>
  );
};

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 →

recordItemId

The <Edit> component reads the id information from the route by default. recordItemId is used when it cannot read from the URL(when used on a custom page, modal or drawer).

localhost:3000/posts/edit/123

import { useModalForm } from "@refinedev/react-hook-form";
import { Edit } from "@refinedev/chakra-ui";
import {
  Modal,
  Button,
  ModalOverlay,
  ModalContent,
  ModalCloseButton,
  ModalHeader,
  ModalBody,
} from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  const {
    modal: { visible, close, show },
    id,
  } = useModalForm({
    refineCoreProps: { action: "edit" },
  });

  return (
    <div>
      <Button onClick={() => show()}>Edit Button</Button>
      <Modal isOpen={visible} onClose={close} size="xl">
        <ModalOverlay />
        <ModalContent>
          <ModalCloseButton />
          <ModalHeader>Edit</ModalHeader>

          <ModalBody>
            <Edit recordItemId={id}>
              <p>Rest of your page here</p>
            </Edit>
          </ModalBody>
        </ModalContent>
      </Modal>
    </div>
  );
};

Implementation Tips:

The <Edit> component needs the id information for the <RefreshButton> to work properly.

mutationMode

mutationMode determines which mode the mutation will have while executing <DeleteButton>.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import {
  Input,
  FormControl,
  FormLabel,
  FormErrorMessage,
} from "@chakra-ui/react";
import { useForm } from "@refinedev/react-hook-form";

const PostEdit: React.FC = () => {
  const {
    saveButtonProps,
    register,
    formState: { errors },
  } = useForm<IPost>();

  return (
    <Edit
      mutationMode="undoable"
      canDelete
      saveButtonProps={saveButtonProps}
    >
      <FormControl mb="3" isInvalid={!!errors?.title}>
        <FormLabel>Title</FormLabel>
        <Input
          id="title"
          type="text"
          {...register("title", { required: "Title is required" })}
        />
        <FormErrorMessage>{`${errors.title?.message}`}</FormErrorMessage>
      </FormControl>
    </Edit>
  );
};

dataProviderName

If not specified, Refine will use the default data provider. If you have multiple data providers and want to use a different one, you can use the dataProviderName property.

import { Refine } from "@refinedev/core";
import { Edit } from "@refinedev/chakra-ui";
import dataProvider from "@refinedev/simple-rest";

const PostEdit = () => {
  return <Edit dataProviderName="other">...</Edit>;
};

export const App: React.FC = () => {
  return (
    <Refine
      dataProvider={{
        default: dataProvider("https://api.fake-rest.refine.dev/"),
        other: dataProvider("https://other-api.fake-rest.refine.dev/"),
      }}
    >
      {/* ... */}
    </Refine>
  );
};

goBack

To customize the back button or to disable it, you can use the goBack property. You can pass false or null to hide the back button.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { IconMoodSmile } from "@tabler/icons-react";

const PostEdit: React.FC = () => {
  return (
    <Edit goBack={<IconMoodSmile />}>
      <p>Rest of your page here 2</p>
    </Edit>
  );
};

isLoading

To toggle the loading state of the <Edit/> component, you can use the isLoading property.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";

const PostEdit: React.FC = () => {
  return (
    <Edit isLoading={true}>
      <p>Rest of your page here</p>
    </Edit>
  );
};

To customize or disable the breadcrumb, you can use the breadcrumb property. By default it uses the Breadcrumb component from @refinedev/chakra-ui package.

localhost:3000/posts/edit/123

import { Edit, Breadcrumb } from "@refinedev/chakra-ui";
import { Box } from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  return (
    <Edit
      breadcrumb={
        <Box borderColor="blue" borderStyle="dashed" borderWidth="2px">
          <Breadcrumb />
        </Box>
      }
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the Breadcrumb documentation →

wrapperProps

If you want to customize the wrapper of the <Edit/> component, you can use the wrapperProps property. For @refinedev/chakra-ui wrapper element is <Card>s and wrapperProps can get every attribute that <Card> can get.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";

const PostEdit: React.FC = () => {
  return (
    <Edit
      wrapperProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
        p: "2",
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the Box documentation from Chakra UI →

headerProps

If you want to customize the header of the <Edit/> component, you can use the headerProps property.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the Box documentation from Chakra UI →

contentProps

If you want to customize the content of the <Edit/> component, you can use the contentProps property.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";

const PostEdit: React.FC = () => {
  return (
    <Edit
      contentProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
        p: "2",
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the Box documentation from Chakra UI →

headerButtons

By default, the <Edit/> component has a <ListButton> and a <RefreshButton> at the header.

You can customize the buttons at the header by using the headerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons, refreshButtonProps, listButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.

Implementation Tips:

If the "list" resource is not defined, the <ListButton> will not render and listButtonProps will be undefined.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { Button, HStack, Box } from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerButtons={({ defaultButtons }) => (
        <HStack>
          {defaultButtons}
          <Button colorScheme="red">Custom Button</Button>
        </HStack>
      )}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use refreshButtonProps and listButtonProps to utilize the default values of the <ListButton> and <RefreshButton> components.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { Button, HStack, Box } from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerButtons={({ refreshButtonProps, listButtonProps }) => (
        <HStack>
          <RefreshButton {...refreshButtonProps} meta={{ foo: "bar" }} />
          {listButtonProps && (
            <ListButton {...listButtonProps} meta={{ foo: "bar" }} />
          )}
          <Button colorScheme="red">Custom Button</Button>
        </HStack>
      )}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

headerButtonProps

You can customize the wrapper element of the buttons at the header by using the headerButtonProps property.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { Button } from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerButtonProps={{
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
        p: "2",
      }}
      headerButtons={
        <Button variant="outline" colorScheme="green">
          Custom Button
        </Button>
      }
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the Box documentation from Chakra UI →

footerButtons

By default, the <Edit/> component has a <SaveButton> and a <DeleteButton> at the footer.

You can customize the buttons at the footer by using the footerButtons property. It accepts React.ReactNode or a render function ({ defaultButtons, saveButtonProps, deleteButtonProps }) => React.ReactNode which you can use to keep the existing buttons and add your own.

Implementation Tips:

If canDelete is false, the <DeleteButton> will not render and deleteButtonProps will be undefined.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { Button, HStack } from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  return (
    <Edit
      footerButtons={({ defaultButtons }) => (
        <HStack borderColor="blue" borderStyle="dashed" borderWidth="2px" p="2">
          {defaultButtons}
          <Button colorScheme="red" variant="solid">
            Custom Button
          </Button>
        </HStack>
      )}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

Or, instead of using the defaultButtons, you can create your own buttons. If you want, you can use saveButtonProps and deleteButtonProps to utilize the default values of the <SaveButton> and <DeleteButton> components.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";
import { Button, HStack } from "@chakra-ui/react";

const PostEdit: React.FC = () => {
  return (
    <Edit
      footerButtons={({ saveButtonProps, deleteButtonProps }) => (
        <HStack borderColor="blue" borderStyle="dashed" borderWidth="2px" p="2">
          <SaveButton {...saveButtonProps} hideText />
          {deleteButtonProps && (
            <DeleteButton {...deleteButtonProps} hideText />
          )}
          <Button colorScheme="red" variant="solid">
            Custom Button
          </Button>
        </HStack>
      )}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

footerButtonProps

You can customize the wrapper element of the buttons at the footer by using the footerButtonProps property.

localhost:3000/posts/edit/123

import { Edit } from "@refinedev/chakra-ui";

const PostEdit: React.FC = () => {
  return (
    <Edit
      footerButtonProps={{
        float: "right",
        borderColor: "blue",
        borderStyle: "dashed",
        borderWidth: "2px",
        p: "2",
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  );
};

For more information, refer to the Box documentation from Chakra UI →

autoSaveProps

You can use the auto save feature of the <Edit/> component by using the autoSaveProps property.

localhost:3000/posts/edit/123

const PostEdit: React.FC = () => {
  const {
    refineCore: {
      formLoading,
      queryResult,
      autoSaveProps,
    },
    saveButtonProps,
    register,
    formState: { errors },
    resetField,
  } = useForm<IPost>({
    refineCoreProps: {
      autoSave: {
        enabled: true,
      },
    },
  });

  const { options } = useSelect({
    resource: "categories",

    defaultValue: queryResult?.data?.data.category.id,
    queryOptions: { enabled: !!queryResult?.data?.data.category.id },
  });

  useEffect(() => {
    resetField("category.id");
  }, [options]);

  return (
    <Edit
      isLoading={formLoading}
      saveButtonProps={saveButtonProps}
      autoSaveProps={autoSaveProps}
    >
      <FormControl mb="3" isInvalid={!!errors?.title}>
        <FormLabel>Title</FormLabel>
        <Input
          id="title"
          type="text"
          {...register("title", { required: "Title is required" })}
        />
        <FormErrorMessage>{`${errors.title?.message}`}</FormErrorMessage>
      </FormControl>
      <FormControl mb="3" isInvalid={!!errors?.status}>
        <FormLabel>Status</FormLabel>
        <Select
          id="content"
          placeholder="Select Post Status"
          {...register("status", {
            required: "Status is required",
          })}
        >
          <option>published</option>
          <option>draft</option>
          <option>rejected</option>
        </Select>
        <FormErrorMessage>{`${errors.status?.message}`}</FormErrorMessage>
      </FormControl>
      <FormControl mb="3" isInvalid={!!errors?.categoryId}>
        <FormLabel>Category</FormLabel>
        <Select
          id="ca"
          placeholder="Select Category"
          {...register("category.id", {
            required: true,
          })}
        >
          {options?.map((option) => (
            <option value={option.value} key={option.value}>
              {option.label}
            </option>
          ))}
        </Select>
        <FormErrorMessage>{`${errors.categoryId?.message}`}</FormErrorMessage>
      </FormControl>
    </Edit>
  );
};

API Reference

Props

Property	Type	Description	Default
resource	`string`	Resource name for API data interactions	Reads `:resource` from the URL
title	`ReactNode`	Title of the edit view	`<Title order={3}>Edit {resource.name}</Title>`
wrapperProps	`BoxProps`	Props for the wrapper component of the view
headerProps	`BoxProps`	Props for the header component
contentProps	`BoxProps`	Props for the content wrapper component
breadcrumb	`ReactNode`	Breadcrumb to be displayed in the header	`<Breadcrumb />`
goBack	`ReactNode`	Back button element at the top left of the page	`<IconArrowLeft />`
headerButtons	`ActionButtonRenderer<{ refreshButtonProps: RefreshButtonProps; listButtonProps: ListButtonProps; }>`	Header action buttons to be displayed in the header	If `recordItemId` is passed `<RefreshButton />` otherwise `<RefreshButton /> <ListButton />`
headerButtonProps	`BoxProps`	Additional props to be passed to the wrapper of the header buttons
footerButtons	`ActionButtonRenderer<{ deleteButtonProps: DeleteButtonProps; saveButtonProps: SaveButtonProps; }>`	Footer action buttons to be displayed in the footer	If `canDelete` is passed `<SaveButton /> <DeleteButton />` otherwise `<SaveButton />`
footerButtonProps	`BoxProps`	Additional props to be passed to the wrapper of the footer buttons
dataProviderName	`string`	To specify a data provider other than default use this property
isLoading	`boolean`	Loading state of the component	`false`
canDelete	`boolean`	Adds a `<DeleteButton />`	If the resource has `canDelete` prop it is `true` else `false`
saveButtonProps	`SaveButtonProps`	Additional props for the `<SaveButton />` component
deleteButtonProps	`DeleteButtonProps`	Adds properties for `<DeleteButton />`
mutationMode	`"pessimistic" \| "optimistic" \| "undoable"`	Determines when mutations are executed	`"pessimistic"`*
recordItemId	`BaseKey`	The record id for `<RefreshButton>`
autoSaveProps	`AutoSaveIndicatorProps`	Show <AutoSaveIndicator /> component on header buttons

Properties​

title​

saveButtonProps​

canDelete and deleteButtonProps​

resource​

recordItemId​

mutationMode​

dataProviderName​

goBack​

isLoading​

breadcrumb Globally ConfigurableThis value can be configured globally. Click to see the guide for more information.​

wrapperProps​

headerProps​

contentProps​

headerButtons​

headerButtonProps​

footerButtons​

footerButtonProps​

autoSaveProps​

API Reference​

Props​

Properties

title

saveButtonProps

canDelete and deleteButtonProps

resource

recordItemId

mutationMode

dataProviderName

goBack

isLoading

breadcrumb
Globally Configurable
This value can be configured globally. Click to see the guide for more information.

wrapperProps

headerProps

contentProps

headerButtons

headerButtonProps

footerButtons

footerButtonProps

autoSaveProps

API Reference

Props