useModalForm

useModalForm hook allows you to manage a form within a modal. It provides some useful methods to handle the form modal.

info

useModalForm hook is extended from useForm from the @pankod/refine-react-hook-form 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.

create

http://localhost:3000/posts

Live previews only work with the latest documentation.

import React from "react";
import { HttpError, useTable } from "@pankod/refine-core";
import { useModalForm } from "@pankod/refine-react-hook-form";

import { Modal, PostsTable } from "@components";

const PostList = () => {
    const { tableQueryResult } = useTable<IPost>({
        initialSorter: [
            {
                field: "id",
                order: "desc",
            },
        ],
    });

    const {
        formState: { errors },
        refineCore: { onFinish, formLoading },
        modal: { visible, close, show },
        register,
        handleSubmit,
        saveButtonProps,
    } = useModalForm<IPost, HttpError, IPost>({
        refineCoreProps: { action: "create" },
    });

    const loading = tableQueryResult?.isLoading;

    if (loading) {
        return <div>Loading...</div>;
    }

    return (
        <div>
            <Modal isOpen={visible} onClose={close}>
                <form className="form" onSubmit={handleSubmit(onFinish)}>
                    <div className="form-group">
                        <label>Title: </label>
                        <input
                            {...register("title", {
                                required: "This field is required",
                            })}
                        />
                        {errors.title && <span>{errors.title.message}</span>}
                    </div>
                    <div className="form-group">
                        <label>Status: </label>
                        <select {...register("status")}>
                            <option value="published">published</option>
                            <option value="draft">draft</option>
                            <option value="rejected">rejected</option>
                        </select>
                    </div>
                    <button type="submit" {...saveButtonProps}>
                        {formLoading ? "Loading" : "Save"}
                    </button>
                </form>
            </Modal>
            <button onClick={() => show()}>Create Post</button>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                    </tr>
                </thead>
                <tbody>
                    {tableQueryResult.data?.data.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                        </tr>
                    ))}
                </tbody>
            </table>
        </div>
    );
};

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

edit

http://localhost:3000/posts

Live previews only work with the latest documentation.

import React from "react";
import { HttpError, useTable } from "@pankod/refine-core";
import { useModalForm } from "@pankod/refine-react-hook-form";

import { Modal, PostsTable } from "@components";

const PostList = () => {
    const { tableQueryResult } = useTable<IPost>({
        initialSorter: [
            {
                field: "id",
                order: "desc",
            },
        ],
    });

    const {
        formState: { errors },
        refineCore: { onFinish, formLoading },
        modal: { visible, close, show },
        register,
        handleSubmit,
        saveButtonProps,
    } = useModalForm<IPost, HttpError, IPost>({
        refineCoreProps: { action: "edit" },
    });

    const loading = tableQueryResult?.isLoading;

    if (loading) {
        return <div>Loading...</div>;
    }

    return (
        <div>
            <Modal isOpen={visible} onClose={close}>
                <form className="form" onSubmit={handleSubmit(onFinish)}>
                    <div className="form-group">
                        <label>Title: </label>
                        <input
                            {...register("title", {
                                required: "This field is required",
                            })}
                        />
                        {errors.title && <span>{errors.title.message}</span>}
                    </div>
                    <div className="form-group">
                        <label>Status: </label>
                        <select {...register("status")}>
                            <option value="published">published</option>
                            <option value="draft">draft</option>
                            <option value="rejected">rejected</option>
                        </select>
                    </div>
                    <button type="submit" {...saveButtonProps}>
                        {formLoading ? "Loading" : "Save"}
                    </button>
                </form>
            </Modal>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                        <th>Actions</th>
                    </tr>
                </thead>
                <tbody>
                    {tableQueryResult.data?.data.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                            <td>
                                <button onClick={() => show(post.id)}>
                                    Edit
                                </button>
                            </td>
                        </tr>
                    ))}
                </tbody>
            </table>
        </div>
    );
};

export 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 <Modal> when clicked.

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

<td>
    <button onClick={() => show(post.id)}>Edit</button>
</td>

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.

clone

http://localhost:3000/posts

Live previews only work with the latest documentation.

import React from "react";
import { HttpError, useTable } from "@pankod/refine-core";
import { useModalForm } from "@pankod/refine-react-hook-form";

import { Modal, PostsTable } from "@components";

const PostList = () => {
    const { tableQueryResult } = useTable<IPost>({
        initialSorter: [
            {
                field: "id",
                order: "desc",
            },
        ],
    });

    const {
        formState: { errors },
        refineCore: { onFinish, formLoading },
        modal: { visible, close, show },
        register,
        handleSubmit,
        saveButtonProps,
    } = useModalForm<IPost, HttpError, IPost>({
        refineCoreProps: { action: "clone" },
    });

    const loading = tableQueryResult?.isLoading;

    if (loading) {
        return <div>Loading...</div>;
    }

    return (
        <div>
            <Modal isOpen={visible} onClose={close}>
                <form className="form" onSubmit={handleSubmit(onFinish)}>
                    <div className="form-group">
                        <label>Title: </label>
                        <input
                            {...register("title", {
                                required: "This field is required",
                            })}
                        />
                        {errors.title && <span>{errors.title.message}</span>}
                    </div>
                    <div className="form-group">
                        <label>Status: </label>
                        <select {...register("status")}>
                            <option value="published">published</option>
                            <option value="draft">draft</option>
                            <option value="rejected">rejected</option>
                        </select>
                    </div>
                    <button type="submit" {...saveButtonProps}>
                        {formLoading ? "Loading" : "Save"}
                    </button>
                </form>
            </Modal>
            <table>
                <thead>
                    <tr>
                        <th>ID</th>
                        <th>Title</th>
                        <th>Status</th>
                        <th>Actions</th>
                    </tr>
                </thead>
                <tbody>
                    {tableQueryResult.data?.data.map((post) => (
                        <tr key={post.id}>
                            <td>{post.id}</td>
                            <td>{post.title}</td>
                            <td>{post.status}</td>
                            <td>
                                <button onClick={() => show(post.id)}>
                                    Clone
                                </button>
                            </td>
                        </tr>
                    ))}
                </tbody>
            </table>
        </div>
    );
};

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

caution

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

So, we have to put the <CloneButton/> on our list. In that way, <Clone> form in <Modal> can fetch data by the record id.

<td>
    <button onClick={() => show(post.id)}>clone</button>
</td>

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.

See Modal component

src/components/Modal/index.tsx

type ModalPropsType = {
    isOpen: boolean;
    onClose: () => void;
    children: React.ReactNode;
};

const Modal: React.FC<ModalPropsType> = ({ isOpen, onClose, children }) => {
    if (!isOpen) return null;
    return (
        <>
            <div className="overlay" onClick={onClose}></div>
            <div className="modal">
                <div className="modal-title">
                    <button className="close-button" onClick={onClose}>
                        &times;
                    </button>
                </div>
                <div className="modal-content">{children}</div>
            </div>
        </>
    );
};

See styles

src/styles.css

* {
    box-sizing: border-box;
}

.overlay {
    position: fixed;
    top: 0;
    left: 0;
    bottom: 0;
    right: 0;
    background-color: rgba(0, 0, 0, 0.7);
    z-index: 1000;
}

.modal {
    position: fixed;
    top: 50%;
    left: 50%;
    transform: translate(-50%, -50%);
    background-color: #fff;
    z-index: 1000;
    width: 500px;
    overflow-y: auto;
}

.modal .modal-title {
    display: flex;
    justify-content: flex-end;
    padding: 4px;
}

.modal .modal-content {
    padding: 0px 16px 16px 16px;
}

.form {
    display: flex;
    flex-direction: column;
    gap: 8px;
}

.form .form-group {
    display: flex;
    flex-direction: column;
    gap: 4px;
}

.form input,
select,
textarea {
    width: 100%;
    padding: 8px;
    border: 1px solid #ccc;
    border-radius: 4px;
}

Properties

tip

All useForm props also available in useModalForm. You can find descriptions on useForm docs.

All React Hook Form useForm props also available in useModalForm. You can find descriptions on React Hook Form docs.

defaultValues

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({
    defaultValues: {
        title: "Hello World",
    },
});

defaultVisible

Default: false

When true, modal will be visible by default.

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

autoSubmitClose

Default: true

When true, modal will be closed after successful submit.

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

autoResetForm

Default: true

When true, form will be reset after successful submit.

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

warnWhenUnsavedChanges

Default: false

When you have unsaved changes and try to leave the current page, refine shows a confirmation modal box. To activate this feature.

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

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

Return Values

tip

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

All React Hook Form useForm return values also available in useModalForm. You can find descriptions on useForm docs.

visible

Current visibility state of the modal.

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

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

title

Title of the modal. Based on resource and action values

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

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

close

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

const {
    getInputProps,
    handleSubmit,
    register,
    modal,
    refineCore: { onFinish },
} = useModalForm();

return (
    <>
        <button onClick={show}>Show Modal</button>
        <Modal {...modal}>
            <form onSubmit={handleSubmit(onFinish)}>
                <div>
                    <label>Title: </label>
                    <input {...register("title")} />
                </div>
                <div>
                    <button type="submit" onClick={modal.close}>
                        Cancel
                    </button>
                    <button type="submit" onClick={modal.submit}>
                        Save
                    </button>
                </div>
            </form>
        </Modal>
    </>
);

submit

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

const {
    getInputProps,
    handleSubmit,
    register,
    modal,
    refineCore: { onFinish },
} = useModalForm();

// ---

return (
    <>
        <button onClick={show}>Show Modal</button>
        <Modal {...modal}>
            <form onSubmit={handleSubmit(onFinish)}>
                <div>
                    <label>Title: </label>
                    <input {...register("title")} />
                </div>
                <div>
                    <button type="submit" onClick={modal.submit}>
                        Save
                    </button>
                </div>
            </form>
        </Modal>
    </>
);

show

A function that can show the modal.

const {
    saveButtonProps,
    handleSubmit,
    register,
    modal,
    refineCore: { onFinish, formLoading },
} = useModalForm();

return (
    <>
        <button onClick={show}>Show Modal</button>
        <Modal {...modal}>
            <form onSubmit={handleSubmit(onFinish)}>
                <div>
                    <label>Title: </label>
                    <input {...register("title")} />
                </div>
                <div>
                    <button type="submit" {...saveButtonProps}>
                        Save
                    </button>
                </div>
            </form>
        </Modal>
    </>
);

saveButtonProps

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

const {
    saveButtonProps,
    handleSubmit,
    register,
    modal,
    refineCore: { onFinish, formLoading },
} = useModalForm();

return (
    <>
        <button onClick={show}>Show Modal</button>
        <Modal {...modal}>
            <form onSubmit={handleSubmit(onFinish)}>
                <div>
                    <label>Title: </label>
                    <input {...register("title")} />
                </div>
                <div>
                    <button
                        type="submit"
                        disabled={saveButtonProps.disabled}
                        onClick={(e) => {
                            // -- your custom logic
                            saveButtonProps.onClick(e);
                        }}
                    >
                        Save
                    </button>
                </div>
            </form>
        </Modal>
    </>
);

API Reference

Properties

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

External Props

It also accepts all props of useForm hook available in the React Hook Form.

Return values

Property	Description	Type
modal	Relevant states and methods to control the modal	ModalReturnValues
refineCore	The return values of the useForm in the core	UseFormReturnValues
React Hook Form Return Values	See React Hook Form 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.BaseSyntheticEvent) => void; }

Example

VIEW SOURCE CODE →

RUN IN YOUR LOCAL

npm create refine-app@latest -- --example form-react-hook-form-use-modal-form