Skip to main content
Version: 3.xx.xxSwizzle Ready

Edit

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

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

http://localhost:3000
Live previews only work with the latest documentation.
interface IPost {
  id: number
  title: string
  content: string
  status: 'published' | 'draft' | 'rejected'
  category: { id: number }
}

import {
  Edit,
  Form,
  Input,
  Select,
  useForm,
  useSelect,
} from '@pankod/refine-antd'

const PostEdit: React.FC<IResourceComponentsProps> = () => {
  const { formProps, saveButtonProps, queryResult } = useForm<IPost>({
    warnWhenUnsavedChanges: true,
  })

  const postData = queryResult?.data?.data
  const { selectProps: categorySelectProps } = useSelect<ICategory>({
    resource: 'categories',
    defaultValue: postData?.category.id,
  })

  return (
    <Edit saveButtonProps={saveButtonProps}>
      <Form {...formProps} layout="vertical">
        <Form.Item
          label="Title"
          name="title"
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Input />
        </Form.Item>
        <Form.Item
          label="Category"
          name={['category', 'id']}
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Select {...categorySelectProps} />
        </Form.Item>
        <Form.Item
          label="Status"
          name="status"
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Select
            options={[
              {
                label: 'Published',
                value: 'published',
              },
              {
                label: 'Draft',
                value: 'draft',
              },
              {
                label: 'Rejected',
                value: 'rejected',
              },
            ]}
          />
        </Form.Item>
      </Form>
    </Edit>
  )
}
Swizzle

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

Properties​

title​

It allows adding 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 will be "Edit post".

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit } from '@pankod/refine-antd'

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

saveButtonProps​

The <Edit> component has a save button by default. If you want to customize this button you can use the saveButtonProps property like the code below.

Clicking on the save button will submit your form.

Refer to the <SaveButton> documentation for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit saveButtonProps={{ size: 'small' }}>
      <p>Rest of your page here</p>
    </Edit>
  )
}

canDelete and deleteButtonProps​

canDelete allows us to add the delete button inside the <Edit> component. 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.

When clicked on, the delete button executes the useDelete method provided by the dataProvider.

Refer to the <DeleteButton> documentation for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit } from '@pankod/refine-antd'
import { usePermissions } from '@pankod/refine-core'

const PostEdit: React.FC = () => {
  const { data: permissionsData } = usePermissions()
  return (
    <Edit
      canDelete={permissionsData?.includes('admin')}
      deleteButtonProps={{ size: 'small' }}
      saveButtonProps={{ size: 'small' }}
    >
      <p>Rest of your page here</p>
    </Edit>
  )
}

Refer to the usePermission documentation for detailed usage. &#8594

resource​

<Edit> component reads the resource information from the route by default. This default behavior will not work on custom pages. If you want to use the <Edit> component in a custom page, you can use the resource property.

Refer to the custom pages documentation for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Refine } from '@pankod/refine-core'
import { Edit } from '@pankod/refine-antd'
import routerProvider from '@pankod/refine-react-router-v6'
import dataProvider from '@pankod/refine-simple-rest'

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

const App: React.FC = () => {
  return (
    <Refine
      routerProvider={{
        ...routerProvider,
        routes: [
          {
            element: <CustomPage />,
            path: '/custom/:id',
          },
        ],
      }}
      dataProvider={dataProvider('https://api.fake-rest.refine.dev')}
      resources={[{ name: 'posts' }]}
    />
  )
}

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit, useModalForm, Modal, Button } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  const { modalProps, id, show } = useModalForm({
    action: 'edit',
  })

  return (
    <div>
      <Button onClick={() => show()}>Edit Button</Button>
      <Modal {...modalProps}>
        <Edit recordItemId={id}>
          <p>Rest of your page here</p>
        </Edit>
      </Modal>
    </div>
  )
}
note

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

mutationMode​

Determines which mode mutation will have while executing <DeleteButton> .

Refer to the mutation mode docs for further information. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
interface IPost {
  id: number
  title: string
  content: string
  status: 'published' | 'draft' | 'rejected'
  category: { id: number }
}

import {
  Edit,
  Form,
  Input,
  Select,
  useForm,
  useSelect,
} from '@pankod/refine-antd'

const PostEdit: React.FC<IResourceComponentsProps> = () => {
  const { formProps, saveButtonProps, queryResult } = useForm<IPost>({
    warnWhenUnsavedChanges: true,
  })

  const postData = queryResult?.data?.data
  const { selectProps: categorySelectProps } = useSelect<ICategory>({
    resource: 'categories',
    defaultValue: postData?.category.id,
  })

  return (
    <Edit
      mutationMode="undoable"
      canDelete
      saveButtonProps={saveButtonProps}
    >
      <Form {...formProps} layout="vertical">
        <Form.Item
          label="Title"
          name="title"
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Input />
        </Form.Item>
        <Form.Item
          label="Category"
          name={['category', 'id']}
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Select {...categorySelectProps} />
        </Form.Item>
        <Form.Item
          label="Status"
          name="status"
          rules={[
            {
              required: true,
            },
          ]}
        >
          <Select
            options={[
              {
                label: 'Published',
                value: 'published',
              },
              {
                label: 'Draft',
                value: 'draft',
              },
              {
                label: 'Rejected',
                value: 'rejected',
              },
            ]}
          />
        </Form.Item>
      </Form>
    </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 '@pankod/refine-core'
import { Edit } from '@pankod/refine-antd'
import routerProvider from '@pankod/refine-react-router-v6'
import dataProvider from '@pankod/refine-simple-rest'

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

export const App: React.FC = () => {
  return (
    <Refine
      routerProvider={routerProvider}
      dataProvider={{
        default: dataProvider('https://api.fake-rest.refine.dev/'),
        other: dataProvider('https://other-api.fake-rest.refine.dev/'),
      }}
      resources={[{ name: 'posts', edit: PostEdit }]}
    />
  )
}

goBack​

To customize the back button or to disable it, you can use the goBack property.

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit, Icons } from '@pankod/refine-antd'

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

isLoading​

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit } from '@pankod/refine-antd'

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 @pankod/refine-antd package.

Refer to the Breadcrumb documentation for detailed usage. &#8594

tip

This feature can be managed globally via the <Refine> component's options

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit, Breadcrumb } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      breadcrumb={
        <div
          style={{
            padding: '3px 6px',
            border: '2px dashed cornflowerblue',
          }}
        >
          <Breadcrumb />
        </div>
      }
    >
      <p>Rest of your page here</p>
    </Edit>
  )
}

wrapperProps​

If you want to customize the wrapper of the <Edit/> component, you can use the wrapperProps property. For @pankod/refine-antd wrapper elements are simple <div/>s and wrapperProps can get every attribute that <div/> can get.

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      wrapperProps={{
        style: {
          backgroundColor: 'cornflowerblue',
          padding: '16px',
        },
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  )
}

headerProps​

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

Refer to the PageHeader documentation from Ant Design for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerProps={{
        subTitle: 'This is a subtitle',
        style: {
          backgroundColor: 'cornflowerblue',
          padding: '16px',
        },
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  )
}

contentProps​

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

Refer to the Card documentation from Ant Design for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      contentProps={{
        style: {
          backgroundColor: 'cornflowerblue',
          padding: '16px',
        },
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  )
}

headerButtons​

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit, Button } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <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.

Refer to the Space documentation from Ant Design for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit, Button } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      headerButtonProps={{
        style: {
          backgroundColor: 'cornflowerblue',
          padding: '16px',
        },
      }}
      headerButtons={<Button type="primary">Custom Button</Button>}
    >
      <p>Rest of your page here</p>
    </Edit>
  )
}

footerButtons​

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

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit, Button } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      footerButtons={({ defaultButtons }) => (
        <>
          {defaultButtons}
          <Button type="primary">Custom Button</Button>
        </>
      )}
    >
      <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.

Refer to the Space documentation from Ant Design for detailed usage. &#8594

http://localhost:3000
Live previews only work with the latest documentation.
import { Edit, Button } from '@pankod/refine-antd'

const PostEdit: React.FC = () => {
  return (
    <Edit
      footerButtonProps={{
        style: {
          float: 'right',
          marginRight: 24,
          backgroundColor: 'cornflowerblue',
          padding: '16px',
        },
      }}
    >
      <p>Rest of your page here</p>
    </Edit>
  )
}

API Reference​

Properties​

*: These properties have default values in RefineContext and can also be set on the <Refine> component.