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

Edit

http://localhost:3000
const { default: simpleRest } = RefineSimpleRest;
setRefineProps({
    dataProvider: simpleRest("https://api.fake-rest.refine.dev"),
    Layout: RefineChakra.Layout,
    Sider: () => null,
});

const Wrapper = ({ children }) => {
    return (
        <ChakraUI.ChakraProvider theme={RefineChakra.refineTheme}>
            {children}
        </ChakraUI.ChakraProvider>
    );
};

const DummyListPage = () => (
    <ChakraUI.VStack alignItems="flex-start">
        <ChakraUI.Text>This page is empty.</ChakraUI.Text>
        <EditButton colorScheme="black" recordItemId="123">
            Edit Item 123
        </EditButton>
    </ChakraUI.VStack>
);

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

interface IPost {
    id: number;
    title: string;
    content: string;
    status: "published" | "draft" | "rejected";
    category: { id: number };
}

<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
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>
    );
};
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
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​

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
import { Edit } from "@refinedev/chakra-ui";

const PostEdit: React.FC = () => {
    return (
        <Edit saveButtonProps={{ colorScheme: "red" }}>
            <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
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>
    );
};

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

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.

http://localhost:3000
import { Edit } from "@refinedev/chakra-ui";

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

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

http://localhost:3000
import { Edit } from "@refinedev/chakra-ui";
import { IconMoodSmile } from "@tabler/icons";

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.

http://localhost:3000
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.

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
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>
    );
};

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.

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
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>
    );
};

headerProps​

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

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
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>
    );
};

contentProps​

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

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
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>
    );
};

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
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>
    );
};

headerButtonProps​

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

Refer to the Box documentation from Chakra UI for detailed usage. &#8594

http://localhost:3000
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>
    );
};

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
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>
    );
};

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
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>
    );
};

API Reference​

Props​