Skip to main content
Unlock powerful debugging and effortless query monitoring with Refine DevtoolsLearn More
RefineDocumentation
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.

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

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, useModalForm, useTable } from "@refinedev/antd";
import { Form, Input, Modal, Select, Table } 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​

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​

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

useForm({
  defaultFormValues: {
    title: "Hello World",
  },
});

Also, it can be provided as an async function to fetch the default values. The loading state can be tracked using the defaultFormValuesLoading state returned from the hook.

🚨 When action is "edit" or "clone" a race condition with async defaultFormValues may occur. In this case, the form values will be the result of the last completed operation.

const { defaultFormValuesLoading } = useForm({
  defaultFormValues: async () => {
    const response = await fetch("https://my-api.com/posts/1");
    const data = await response.json();
    return data;
  },
});

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.

By default the autoSave feature does not invalidate queries. However, you can use the invalidateOnUnmount and invalidateOnClose props to invalidate queries upon unmount or close.

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

autoSave feature operates exclusively in edit mode. Users can take advantage of this feature while editing data, as changes are automatically saved in editing mode. However, when creating new data, manual saving is still required.

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. By default, it is false.

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

debounce​

Set the debounce time for the autoSave prop. By default, it is 1000 milliseconds.

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

invalidateOnUnmount​

This prop is useful when you want to invalidate the list, many and detail queries from the current resource when the hook is unmounted. By default, it invalidates the list, many and detail queries associated with the current resource. Also, You can use the invalidates prop to select which queries to invalidate. By default, it is false.

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

invalidateOnClose​

This prop is useful when you want to invalidate the list, many and detail queries from the current resource when the modal is closed. By default, it invalidates the list, many and detail queries associated with the current resource. Also, You can use the invalidates prop to select which queries to invalidate. By default, it is false.

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

Return Values​

useModalForm returns the same values from useForm and additional values to work with <Modal> components.

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.

Difference between onFinish and formProps.onFinish

onFinish method returned directly from useModalForm is same with the useForm's onFinish. When working with modals, closing the modal after submission and resetting the fields are necessary and to handle these, formProps.onFinish extends the onFinish method and handles the closing of the modal and clearing the fields under the hood.

If you're customizing the data before submitting it to your data provider, it's recommended to use formProps.onFinish and let it handle the operations after the submission.

modalProps​

The props needed by the <Modal> component.

title​

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
​

Please use open instead.

open​

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

close​

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 = async (values) => {
  // Awaiting `onFinish` is important for features like unsaved changes notifier, invalidation, redirection etc.
  // If you're using the `onFinish` from `formProps`, it will call the `close` internally.
  await 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.

defaultFormValuesLoading​

If defaultFormValues is an async function, defaultFormValuesLoading will be true until the function is resolved.

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 { Modal, useModalForm } from "@refinedev/antd";
import { Form, Input } from "antd";
import React from "react";

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​

PropertyTypeDescriptionDefault
resource

string

Resource name for API data interactions

Resource name that it reads from route

id

BaseKey

Record id for fetching

Id that it reads from the URL

redirect

"show" | "edit" | "list" | "create" | false

Page to redirect after a succesfull mutation

"list"

meta

MetaQuery

Metadata query for dataProvider

metaData

metaData is deprecated with refine@4, refine will pass meta instead, however, we still support metaData for backward compatibility.

MetaQuery

Metadata query for dataProvider

queryMeta

MetaQuery

Metadata to pass for the useOne query

mutationMeta

MetaQuery

Metadata to pass for the mutation (useCreate for create and clone actions, useUpdate for edit action)

mutationMode

"pessimistic" | "optimistic" | "undoable"

Determines when mutations are executed

"pessimistic"*

onMutationSuccess

((data: UpdateResponse<TResponse>

CreateResponse<TResponse>, variables: TVariables, context: any, isAutoSave?: boolean) => void)

Called when a mutation is successful

onMutationError

((error: TResponseError, variables: TVariables, context: any, isAutoSave?: boolean) => void)

Called when a mutation encounters an error

undoableTimeout

number

Duration to wait before executing mutations when mutationMode = "undoable"

5000*

dataProviderName

string

If there is more than one dataProvider, you should use the dataProviderName that you will use.

invalidates

all, resourceAll, list, many, detail, false

You can use it to manage the invalidations that will occur at the end of the mutation.

["list", "many", "detail"]

queryOptions

UseQueryOptions<GetOneResponse<TQueryFnData>, TError, GetOneResponse<TData>, QueryKey>

react-query's useQuery options of useOne hook used while in edit mode.

createMutationOptions

Omit<UseMutationOptions<CreateResponse<TResponse>, TResponseError, UseCreateParams<TResponse, TResponseError, TVariables>, unknown>, "mutationFn"

... 1 more ...

"onSuccess">

react-query's useMutation options of useCreate hook used while submitting in create and clone modes.

updateMutationOptions

Omit<UseMutationOptions<UpdateResponse<TResponse>, TResponseError, UpdateParams<TResponse, TResponseError, TVariables>, PrevContext<...>>, "mutationFn"

... 3 more ...

"onSettled">

react-query's useMutation options of useUpdate hook used while submitting in edit mode.

optimisticUpdateMap

OptimisticUpdateMapType<TResponse, TVariables>

If you customize the optimisticUpdateMap option, you can use it to manage the invalidations that will occur at the end of the mutation.

{ list: true, many: true, detail: true, }

successNotification

false

OpenNotificationParams

((data?: UpdateResponse<TResponse>

CreateResponse<TResponse>, values?: TVariables

... 1 more ..., resource?: string

undefined) => false

OpenNotificationParams)

undefined

Success notification configuration to be displayed when the mutation is successful.

'"There was an error creating resource (status code: statusCode)" or "Error when updating resource (status code: statusCode)"'

errorNotification

false

OpenNotificationParams

((error?: TResponseError, values?: TVariables

{ id: BaseKey; values: TVariables; }, resource?: string

undefined) => false

OpenNotificationParams)

undefined

Error notification configuration to be displayed when the mutation fails.

'"There was an error creating resource (status code: statusCode)" or "Error when updating resource (status code: statusCode)"'

action

"create" | "edit" | "clone"

Type of the form mode

Action that it reads from route otherwise "create" is used

liveMode

"auto" | "manual" | "off"

Whether to update data automatically ("auto") or not ("manual") if a related live event is received. The "off" value is used to avoid creating a subscription.

"off"

onLiveEvent

(event: LiveEvent) => void

Callback to handle all related live events of this hook.

undefined

liveParams

{ ids?: BaseKey[]; [key: string]: any; }

Params to pass to liveProvider's subscribe method if liveMode is enabled.

undefined

overtimeOptions

UseLoadingOvertimeCoreOptions

autoSave

{ enabled: boolean; debounce?: number; onFinish?: ((values: TVariables) => TVariables); invalidateOnUnmount?: boolean

undefined; invalidateOnClose?: boolean

undefined; }

undefined

submitOnEnter

boolean

warnWhenUnsavedChanges

boolean

Shows notification when unsaved changes exist

disableServerSideValidation

boolean

Disables server-side validation

false

syncWithLocation

boolean

{ key?: string; syncId?: boolean; }

undefined

If true, the form will be synced with the location. If an object is passed, the key property will be used as the key for the query params. By default, query params are placed under the key, ${resource.name}-${action}.

defaultVisible

boolean

false

autoSubmitClose

boolean

true

autoResetForm

boolean

true

*: 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​

PropertyDescriptionTypeDefault
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" }
defaultFormValuesLoadingDefaultFormValues loading status of formboolean

Example​

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