Skip to main content
👀 Interested in the latest enterprise backend features of refine? 👉 Join now and get early access!
Documentation
Version: 4.xx.xx

useModalForm

The useModalForm hook allows you to manage a form within a <Modal>. It returns Ant Design <Form> and Modal components props.

INFORMATION

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

Basic Usage​

We'll show three examples, "create", "edit" and "clone". Let's see how useModalForm is used in all.

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

localhost:3000/posts
import React from "react";

import { List, EditButton, useTable, useModalForm } from "@refinedev/antd";
import { Table, Form, Select, Input, Modal, Space } from "antd";

const PostList: React.FC = () => {
    const { tableProps } = useTable<IPost>();

    const {
        modalProps: createModalProps,
        formProps: createFormProps,
        show: createModalShow,
    } = useModalForm<IPost>({
        action: "create",
    });

    return (
        <>
            <List
                // createButtonProps allows us to create and manage a button above the table.
                // This code block makes <Modal> appear when you click the button.
                createButtonProps={{
                    onClick: () => {
                        createModalShow();
                    },
                }}
            >
                <Table {...tableProps} rowKey="id">
                    <Table.Column dataIndex="id" title="ID" />
                    <Table.Column dataIndex="title" title="Title" />
                    <Table.Column dataIndex="status" title="Status" />
                </Table>
            </List>
            <Modal {...createModalProps}>
                <Form {...createFormProps} layout="vertical">
                    <Form.Item
                        label="Title"
                        name="title"
                        rules={[
                            {
                                required: true,
                            },
                        ]}
                    >
                        <Input />
                    </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>
            </Modal>
        </>
    );
};

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

Properties​

TIP

All useForm props are also available in useModalForm. You can find descriptions on the useForm documentation.

syncWithLocation​

When syncWithLocation is true, the drawers visibility state and the id of the record will be synced with the URL. It is false by default.

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 modalForm = useModalForm({
    syncWithLocation: { key: "my-modal", syncId: true },
});

defaultFormValues​

CAUTION

defaultFormValues is 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 modalForm = useModalForm({
    defaultFormValues: {
        title: "Hello World",
    },
});

defaultVisible​

When defaultVisible is true, the modal will be visible by default. It is false by default.

const modalForm = useModalForm({
    defaultVisible: true,
});

autoSubmitClose​

autoSubmitClose will make the modal close after a successful submit. It is true by default.

const modalForm = useModalForm({
    autoSubmitClose: false,
});

autoResetForm​

autoResetForm will reset the form after a successful submit. It is true by default.

const modalForm = useModalForm({
    autoResetForm: false,
});

warnWhenUnsavedChanges​

When set to true, warnWhenUnsavedChanges shows a warning when the user tries to leave the page with unsaved changes. It is used to prevent the user from accidentally leaving the page. It is false by default

You can also set this value in <Refine> component.

const modalForm = useModalForm({
    warnWhenUnsavedChanges: true,
});

overtimeOptions​

If you want loading overtime for the request, you can pass the overtimeOptions prop to the this hook. It is useful when you want to show a loading indicator when the request takes too long. interval is the time interval in milliseconds. onInterval is the function that will be called on each interval.

Return overtime object from this hook. elapsedTime is the elapsed time in milliseconds. It becomes undefined when the request is completed.

const { overtime } = useModalForm({
    //...
    overtimeOptions: {
        interval: 1000,
        onInterval(elapsedInterval) {
            console.log(elapsedInterval);
        },
    },
});

console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...

// You can use it like this:
{elapsedTime >= 4000 && <div>this takes a bit longer than expected</div>}

autoSave​

If you want to save the form automatically after some delay when user edits the form, you can pass true to autoSave.enabled prop.

It also supports onMutationSuccess and onMutationError callback functions. You can use isAutoSave parameter to determine whether the mutation is triggered by autoSave or not.

CAUTION

Works only in action: "edit" mode.

onMutationSuccess and onMutationError callbacks will be called after the mutation is successful or failed.

enabled​

To enable the autoSave feature, set the enabled parameter to true.

useModalForm({
    autoSave: {
        enabled: true,
    },
})

debounce​

Set the debounce time for the autoSave prop. Default value is 1000.

useModalForm({
    autoSave: {
        enabled: true,
        debounce: 2000,  
    },
})

onFinish​

If you want to modify the data before sending it to the server, you can use onFinish callback function.

useModalForm({
    autoSave: {
        enabled: true,
        onFinish: (values) => {
            return {
                foo: "bar",
                ...values,
            };
        },
    },
})

Return Values​

formProps​

It's required to manage <Form> state and actions. Under the hood the formProps came from useForm.

It contains the props to manage the Antd <Form> components such as onValuesChange, initialValues, onFieldsChange, onFinish etc.

modalProps​

The props needed by the <Modal> component.

title​

Default when url is "/posts/create": "Create Post"

Title of the modal. Value is based on resource and action values.

okText​

okText is the text of the "submit" button within the modal. It is "Save" by default.

cancelText​

cancelText is the text of the "cancel" button within the modal. It is "Cancel" by default.

width​

Width of the <Modal>. It is 1000px by default.

forceRender​

forceRender renders the <Modal> instead of lazy rendering it. It is true by default.

okButtonProps​

okButtonProps contains all the props needed by the "submit" button within the modal (disabled,loading etc.). When okButtonProps.onClick is called, it triggers form.submit(). You can manually pass these props to your custom button.

onOk​

A function that can submit the <Form> inside <Modal>. It's useful when you want to submit the form manually.

onCancel​

Same as close

A function that can close the <Modal>. It's useful when you want to close the modal manually.

visible
deprecated
​

This prop is deprecated. Please use open instead.

Current visible state of <Modal>. Default value depends on defaultVisible prop.

open​

Current visible state of <Modal>. Default value depends on defaultVisible prop.

close​

Same as onCancel

A function that can close the <Modal>. It's useful when you want to close the modal manually.

const { close, modalProps, formProps, onFinish } = useModalForm();

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

// ---

return (
    <Modal {...modalProps}>
        <Form {...formProps} onFinish={onFinishHandler} layout="vertical">
            <Form.Item label="Title" name="title">
                <Input />
            </Form.Item>
        </Form>
    </Modal>
);

submit​

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

const { modalProps, formProps, submit } = useModalForm();

// ---

return (
    <Modal
        {...modalProps}
        footer={[
            <Button key="submit" type="primary" onClick={submit}>
                Submit
            </Button>,
        ]}
    >
        <Form {...formProps} layout="vertical">
            <Form.Item label="Title" name="title">
                <Input />
            </Form.Item>
        </Form>
    </Modal>
);

show​

show is a function that can show the modal.

const { modalProps, formProps, show } = useModalForm();

return (
    <>
        <Button type="primary" onClick={() => show()}>
            Show Modal
        </Button>
        <Modal
            {...modalProps}
            footer={[
                <Button key="submit" type="primary" onClick={submit}>
                    Submit
                </Button>,
            ]}
        >
            <Form {...formProps} onFinish={onFinishHandler} layout="vertical">
                <Form.Item label="Title" name="title">
                    <Input />
                </Form.Item>
            </Form>
        </Modal>
    </>
);
const { modalProps, formProps } = useModalForm();

// ---

return (
    <Modal
        {...modalProps}
        footer={
            <Button
                onClick={(
                    e: React.MouseEvent<HTMLAnchorElement, MouseEvent> &
                        React.MouseEvent<HTMLButtonElement, MouseEvent>,
                ) => modalProps.onCancel(e)}
            >
                Cancel
            </Button>
        }
    >
        <Form {...formProps} layout="vertical">
            <Form.Item label="Title" name="title">
                <Input />
            </Form.Item>
        </Form>
    </Modal>
);

overtime​

overtime object is returned from this hook. elapsedTime is the elapsed time in milliseconds. It becomes undefined when the request is completed.

const { overtime } = useModalForm();

console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...

autoSaveProps​

If autoSave is enabled, this hook returns autoSaveProps object with data, error, and status properties from mutation.

FAQ​

How can I change the form data before submitting it to the API?​

Here is an example where we modify the form data before submit:

We need to send the values we received from the user in two separate inputs, name and surname, to the API as fullName.

pages/user/create.tsx
import React from "react";
import { Modal, useModalForm } from "@refinedev/antd";
import { Form, Input } from "antd";

export const UserCreate: React.FC = () => {
    const { formProps, modalProps } = useModalForm({
        action: "create",
    });

    const handleOnFinish = (values) => {
        formProps.onFinish?.({
            fullName: `${values.name} ${values.surname}`,
        });
    };

    return (
        <Modal {...modalProps}>
            <Form {...formProps} onFinish={handleOnFinish} layout="vertical">
                <Form.Item label="Name" name="name">
                    <Input />
                </Form.Item>
                <Form.Item label="Surname" name="surname">
                    <Input />
                </Form.Item>
            </Form>
        </Modal>
    );
};

API Reference​

Properties​

*: These props have default values in RefineContext and can also be set on <Refine> component. useModalForm will use what is passed to <Refine> as default but a local value will override it.

**: If not explicitly configured, default value of redirect depends on which action used. If action is create, redirects default value is edit (created resources edit page). If action is edit instead, redirects default value is list.

Type Parameters​

PropertyDesriptionTypeDefault
TQueryFnDataResult data returned by the query function. Extends BaseRecordBaseRecordBaseRecord
TErrorCustom error object that extends HttpErrorHttpErrorHttpError
TVariablesValues for params.{}
TDataResult data returned by the select function. Extends BaseRecord. If not specified, the value of TQueryFnData will be used as the default value.BaseRecordTQueryFnData
TResponseResult data returned by the mutation function. Extends BaseRecord. If not specified, the value of TData will be used as the default value.BaseRecordTData
TResponseErrorCustom error object that extends HttpError. If not specified, the value of TError will be used as the default value.HttpErrorTError

Return Value​

KeyDescriptionType
showA function that can open the modal(id?: BaseKey) => void
formPropsProps needed to manage form componentFormProps
modalPropsProps for needed to manage modal componentModalProps
formLoadingLoading status of formboolean
submitSubmit method, the parameter is the value of the form fields() => void
openWhether the modal dialog is open or notboolean
closeSpecify a function that can close the modal() => void
defaultFormValuesLoadingDefaultFormValues loading status of formboolean
formAnt Design form instanceFormInstance<TVariables>
idRecord id for edit actionBaseKey | undefined
setIdid setterDispatch<SetStateAction< BaseKey | undefined>>
queryResultResult of the query of a recordQueryObserverResult<{ data: TData }>
mutationResultResult of the mutation triggered by submitting the formUseMutationResult<{ data: TData }, TError, { resource: string; values: TVariables; }, unknown>
overtimeOvertime loading props{ elapsedTime?: number }
autoSavePropsAuto save props{ data: UpdateResponse<TData> | undefined, error: HttpError | null, status: "loading" | "error" | "idle" | "success" }

Example​

View Source Code
Run on your local
npm create refine-app@latest -- --example form-antd-use-modal-form
Previous
useForm
Next
useStepsForm