useDrawerForm

useModalForm hook allows you to manage a form within a <Modal> as well as a <Drawer>. It provides some useful methods to handle the form <Modal> or form <Drawer>.

We will use useModalForm hook as a useDrawerForm to manage a form within a <Drawer>.

info

useDrawerForm hook is extended from useForm hook from the @refinedev/mantine package. This means that you can use all the features of useForm hook.

Basic Usage

We'll show two examples, one for creating and one for editing a post. Let's see how useDrawerForm is used in both.

create

In this example, we will show you how to "create" a record with useDrawerForm.

http://localhost:3000

import React from "react";
import { useTable } from "@refinedev/react-table";
import { ColumnDef, flexRender } from "@tanstack/react-table";
import { GetManyResponse, useMany } from "@refinedev/core";
import {
    List,
    useModalForm as useDrawerForm,
    SaveButton,
} from "@refinedev/mantine";
import {
    Box,
    Group,
    ScrollArea,
    Table,
    Pagination,
    Drawer,
    Select,
    TextInput,
} from "@mantine/core";

const PostList: React.FC = () => {
    const {
        getInputProps,
        saveButtonProps,
        modal: { show, close, title, visible },
    } = useDrawerForm({
        refineCoreProps: { action: "create" },
        initialValues: {
            title: "",
            status: "",
            content: "",
        },
        validate: {
            title: (value) => (value.length < 2 ? "Too short title" : null),
            status: (value) =>
                value.length <= 0 ? "Status is required" : null,
        },
    });

    const columns = React.useMemo<ColumnDef<IPost>[]>(
        () => [
            {
                id: "id",
                header: "ID",
                accessorKey: "id",
            },
            {
                id: "title",
                header: "Title",
                accessorKey: "title",
                meta: {
                    filterOperator: "contains",
                },
            },
            {
                id: "status",
                header: "Status",
                accessorKey: "status",
                meta: {
                    filterElement: function render(props: FilterElementProps) {
                        return (
                            <Select
                                defaultValue="published"
                                data={[
                                    { label: "Published", value: "published" },
                                    { label: "Draft", value: "draft" },
                                    { label: "Rejected", value: "rejected" },
                                ]}
                                {...props}
                            />
                        );
                    },
                    filterOperator: "eq",
                },
            },
        ],
        [],
    );

    const {
        getHeaderGroups,
        getRowModel,
        setOptions,
        refineCore: {
            setCurrent,
            pageCount,
            current,
            tableQueryResult: { data: tableData },
        },
    } = useTable({
        columns,
    });

    return (
        <>
            <Drawer
                opened={visible}
                onClose={close}
                title={title}
                padding="xl"
                size="xl"
                position="right"
            >
                <TextInput
                    mt={8}
                    label="Title"
                    placeholder="Title"
                    {...getInputProps("title")}
                />
                <Select
                    mt={8}
                    label="Status"
                    placeholder="Pick one"
                    data={[
                        { label: "Published", value: "published" },
                        { label: "Draft", value: "draft" },
                        { label: "Rejected", value: "rejected" },
                    ]}
                    {...getInputProps("status")}
                />
                <Box
                    mt={8}
                    sx={{ display: "flex", justifyContent: "flex-end" }}
                >
                    <SaveButton {...saveButtonProps} />
                </Box>
            </Drawer>
            <ScrollArea>
                <List createButtonProps={{ onClick: () => show() }}>
                    <Table highlightOnHover>
                        <thead>
                            {getHeaderGroups().map((headerGroup) => (
                                <tr key={headerGroup.id}>
                                    {headerGroup.headers.map((header) => {
                                        return (
                                            <th key={header.id}>
                                                {!header.isPlaceholder && (
                                                    <Group spacing="xs" noWrap>
                                                        <Box>
                                                            {flexRender(
                                                                header.column
                                                                    .columnDef
                                                                    .header,
                                                                header.getContext(),
                                                            )}
                                                        </Box>
                                                    </Group>
                                                )}
                                            </th>
                                        );
                                    })}
                                </tr>
                            ))}
                        </thead>
                        <tbody>
                            {getRowModel().rows.map((row) => {
                                return (
                                    <tr key={row.id}>
                                        {row.getVisibleCells().map((cell) => {
                                            return (
                                                <td key={cell.id}>
                                                    {flexRender(
                                                        cell.column.columnDef
                                                            .cell,
                                                        cell.getContext(),
                                                    )}
                                                </td>
                                            );
                                        })}
                                    </tr>
                                );
                            })}
                        </tbody>
                    </Table>
                    <br />
                    <Pagination
                        position="right"
                        total={pageCount}
                        page={current}
                        onChange={setCurrent}
                    />
                </List>
            </ScrollArea>
        </>
    );
};

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

edit

In this example, we will show you how to "edit" a record with useDrawerForm.

http://localhost:3000

import React from "react";
import { useTable } from "@refinedev/react-table";
import { ColumnDef, flexRender } from "@tanstack/react-table";
import { GetManyResponse, useMany } from "@refinedev/core";
import {
    List,
    useModalForm as useDrawerForm,
    EditButton,
    SaveButton,
} from "@refinedev/mantine";
import {
    Box,
    Group,
    ScrollArea,
    Table,
    Pagination,
    Drawer,
    Select,
    TextInput,
} from "@mantine/core";

const PostList: React.FC = () => {
    const {
        getInputProps,
        saveButtonProps,
        modal: { show, close, title, visible },
    } = useDrawerForm({
        refineCoreProps: { action: "edit" },
        initialValues: {
            title: "",
            status: "",
            content: "",
        },
        validate: {
            title: (value) => (value.length < 2 ? "Too short title" : null),
            status: (value) =>
                value.length <= 0 ? "Status is required" : null,
        },
    });

    const columns = React.useMemo<ColumnDef<IPost>[]>(
        () => [
            {
                id: "id",
                header: "ID",
                accessorKey: "id",
            },
            {
                id: "title",
                header: "Title",
                accessorKey: "title",
                meta: {
                    filterOperator: "contains",
                },
            },
            {
                id: "status",
                header: "Status",
                accessorKey: "status",
                meta: {
                    filterElement: function render(props: FilterElementProps) {
                        return (
                            <Select
                                defaultValue="published"
                                data={[
                                    { label: "Published", value: "published" },
                                    { label: "Draft", value: "draft" },
                                    { label: "Rejected", value: "rejected" },
                                ]}
                                {...props}
                            />
                        );
                    },
                    filterOperator: "eq",
                },
            },
            {
                id: "actions",
                header: "Actions",
                accessorKey: "id",
                enableColumnFilter: false,
                enableSorting: false,
                cell: function render({ getValue }) {
                    return (
                        <Group spacing="xs" noWrap>
                            <EditButton
                                hideText
                                onClick={() => show(getValue() as number)}
                            />
                        </Group>
                    );
                },
            },
        ],
        [],
    );

    const {
        getHeaderGroups,
        getRowModel,
        setOptions,
        refineCore: {
            setCurrent,
            pageCount,
            current,
            tableQueryResult: { data: tableData },
        },
    } = useTable({
        columns,
    });

    return (
        <>
            <Drawer
                opened={visible}
                onClose={close}
                title={title}
                padding="xl"
                size="xl"
                position="right"
            >
                <TextInput
                    mt={8}
                    label="Title"
                    placeholder="Title"
                    {...getInputProps("title")}
                />
                <Select
                    mt={8}
                    label="Status"
                    placeholder="Pick one"
                    data={[
                        { label: "Published", value: "published" },
                        { label: "Draft", value: "draft" },
                        { label: "Rejected", value: "rejected" },
                    ]}
                    {...getInputProps("status")}
                />
                <Box
                    mt={8}
                    sx={{ display: "flex", justifyContent: "flex-end" }}
                >
                    <SaveButton {...saveButtonProps} />
                </Box>
            </Drawer>
            <ScrollArea>
                <List>
                    <Table highlightOnHover>
                        <thead>
                            {getHeaderGroups().map((headerGroup) => (
                                <tr key={headerGroup.id}>
                                    {headerGroup.headers.map((header) => {
                                        return (
                                            <th key={header.id}>
                                                {!header.isPlaceholder && (
                                                    <Group spacing="xs" noWrap>
                                                        <Box>
                                                            {flexRender(
                                                                header.column
                                                                    .columnDef
                                                                    .header,
                                                                header.getContext(),
                                                            )}
                                                        </Box>
                                                    </Group>
                                                )}
                                            </th>
                                        );
                                    })}
                                </tr>
                            ))}
                        </thead>
                        <tbody>
                            {getRowModel().rows.map((row) => {
                                return (
                                    <tr key={row.id}>
                                        {row.getVisibleCells().map((cell) => {
                                            return (
                                                <td key={cell.id}>
                                                    {flexRender(
                                                        cell.column.columnDef
                                                            .cell,
                                                        cell.getContext(),
                                                    )}
                                                </td>
                                            );
                                        })}
                                    </tr>
                                );
                            })}
                        </tbody>
                    </Table>
                    <br />
                    <Pagination
                        position="right"
                        total={pageCount}
                        page={current}
                        onChange={setCurrent}
                    />
                </List>
            </ScrollArea>
        </>
    );
};

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

caution

refine doesn't automatically add a <EditButton/> to the each record in <PostList> which opens "edit" form in <Drawer> when clicked.

So, we have to put the <EditButton/> on our list. In that way, "edit" form in <Drawer> can fetch data by the record id.

const columns = React.useMemo<ColumnDef<IPost>[]>(
    () => [
        // --
        {
            id: "actions",
            header: "Actions",
            accessorKey: "id",
            enableColumnFilter: false,
            enableSorting: false,
            cell: function render({ getValue }) {
                return (
                    <Group spacing="xs" noWrap>
                        <EditButton
                            hideText
                            onClick={() => show(getValue() as number)}
                        />
                    </Group>
                );
            },
        },
    ],
    [],
);

const table = useTable({
    columns,
});

caution

Don't forget to pass the record "id" to show to fetch the record data. This is necessary for both "edit" and "clone" forms.

Properties

refineCoreProps

All useForm properties also available in useStepsForm. You can find descriptions on useForm docs.

const drawerForm = useDrawerForm({
    refineCoreProps: {
        action: "edit",
        resource: "posts",
        id: "1",
    },
});

initialValues

Only available in "create" form.

Default values for the form. Use this to pre-populate the form with data that needs to be displayed.

const drawerForm = useDrawerForm({
    initialValues: {
        title: "Hello World",
    },
});

defaultVisible

Default: false

When true, drawer will be visible by default.

const drawerForm = useDrawerForm({
    modalProps: {
        defaultVisible: true,
    },
});

autoSubmitClose

Default: true

When true, drawer will be closed after successful submit.

const drawerForm = useDrawerForm({
    modalProps: {
        autoSubmitClose: false,
    },
});

autoResetForm

Default: true

When true, form will be reset after successful submit.

const drawerForm = useDrawerForm({
    modalProps: {
        autoResetForm: false,
    },
});

syncWithLocation

Default: false

When true, the drawers visibility state and the id of the record will be synced with the URL.

This property can also be set as an object { key: string; syncId?: boolean } to customize the key of the URL query parameter. id will be synced with the URL only if syncId is true.

const drawerForm = useDrawerForm({
    syncWithLocation: { key: "my-modal", syncId: true },
});

Return Values

tip

All useForm return values also available in useDrawerForm. You can find descriptions on useForm docs.

All mantine useForm return values also available in useDrawerForm. You can find descriptions on mantine docs.

visible

Current visibility state of the drawer.

const drawerForm = useDrawerForm({
    defaultVisible: true,
});

console.log(drawerForm.modal.visible); // true

title

Title of the drawer. Based on resource and action values

const {
    modal: { title },
} = useDrawerForm({
    refineCoreProps: {
        resource: "posts",
        action: "create",
    },
});

console.log(title); // "Create Post"

close

A function that can close the drawer. It's useful when you want to close the drawer manually.

const {
    getInputProps,
    modal: { close, visible, title },
} = useDrawerForm();

return (
    <Drawer opened={visible} onClose={close} title={title}>
        <TextInput
            mt={8}
            label="Title"
            placeholder="Title"
            {...getInputProps("title")}
        />
        <Box mt={8} sx={{ display: "flex", justifyContent: "flex-end" }}>
            <SaveButton {...saveButtonProps} />
            <Button onClick={close}>Cancel</Button>
        </Box>
    </Drawer>
);

submit

A function that can submit the form. It's useful when you want to submit the form manually.

const {
    modal: { submit },
} = useDrawerForm();

// ---

return (
    <Drawer opened={visible} onClose={close} title={title}>
        <TextInput
            mt={8}
            label="Title"
            placeholder="Title"
            {...getInputProps("title")}
        />
        <Box mt={8} sx={{ display: "flex", justifyContent: "flex-end" }}>
            <Button onClick={submit}>Save</Button>
        </Box>
    </Drawer>
);

show

A function that can show the drawer.

const {
    getInputProps,
    modal: { close, visible, title, show },
} = useDrawerForm();

const onFinishHandler = (values) => {
    onFinish(values);
    show();
};

return (
    <>
        <Button onClick={}>Show Modal</Button>
        <Drawer opened={visible} onClose={close} title={title}>
            <TextInput
                mt={8}
                label="Title"
                placeholder="Title"
                {...getInputProps("title")}
            />
            <Box mt={8} sx={{ display: "flex", justifyContent: "flex-end" }}>
                <SaveButton {...saveButtonProps} />
            </Box>
        </Drawer>
    </>
);

saveButtonProps

It contains all the props needed by the "submit" button within the drawer (disabled,loading etc.). You can manually pass these props to your custom button.

const { getInputProps, modal, saveButtonProps } = useDrawerForm();

return (
    <Drawer {...modal}>
        <TextInput
            mt={8}
            label="Title"
            placeholder="Title"
            {...getInputProps("title")}
        />
        <Box mt={8} sx={{ display: "flex", justifyContent: "flex-end" }}>
            <Button
                {...saveButtonProps}
                onClick={(e) => {
                    // -- your custom logic
                    saveButtonProps.onClick(e);
                }}
            />
        </Box>
    </Drawer>
);

API Reference

Properties

Property	Description	Type
modalProps	Configuration object for the modal or drawer	ModalPropsType
refineCoreProps	Configuration object for the core of the useForm	UseFormProps
@mantine/form's useForm properties	See useForm documentation

• ModalPropsType

Property	Description	Type	Default
defaultVisible	Initial visibility state of the modal	boolean	false
autoSubmitClose	Whether the form should be submitted when the modal is closed	boolean	true
autoResetForm	Whether the form should be reset when the form is submitted	boolean	true

Type Parameters

Property	Desription	Type	Default
TData	Result data returned by the query function. Extends BaseRecord	BaseRecord	BaseRecord
TError	Custom error object that extends HttpError	HttpError	HttpError
TVariables	Form values for mutation function	{}	Record<string, unknown>
TTransformed	Form values after transformation for mutation function	{}	TVariables
TSelectData	Result data returned by the select function. Extends BaseRecord. If not specified, the value of TData will be used as the default value.	BaseRecord	TData

Return values

Property	Description	Type
modal	Relevant states and methods to control the modal or drawer	ModalReturnValues
refineCore	The return values of the useForm in the core	UseFormReturnValues
@mantine/form's useForm return values	See useForm documentation

• ModalReturnValues

Property	Description	Type
visible	State of modal visibility	boolean
show	Sets the visible state to true	(id?: BaseKey) => void
close	Sets the visible state to false	() => void
submit	Submits the form	(values: TVariables) => void
title	Modal title based on resource and action value	string
saveButtonProps	Props for a submit button	{ disabled: boolean, onClick: (e: React.FormEvent<HTMLFormElement>) => void; }

Example

VIEW SOURCE CODE →

RUN IN YOUR LOCAL

npm create refine-app@latest -- --example form-mantine-use-drawer-form