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

useStepsForm

The useStepsForm hook allows you to split your form under an Ant Design based Steps component and provides you with a few useful functionalities that will help you manage your form.

INFORMATION

The useStepsForm hook is extended from useForm under the hood. This means that you can use all the functionalities of useForm in your useStepsForm.

Basic Usage​

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

Here is the final result of the form: We will explain the code in following sections.

localhost:3000/posts/create
import React from "react";
import { HttpError } from "@refinedev/core";

import { Create, SaveButton, useSelect, useStepsForm } from "@refinedev/antd";
import { Form, Input, Select, Button, Steps } from "antd";

const { Step } = Steps;

const PostCreatePage: React.FC = () => {
    const { current, gotoStep, stepsProps, formProps, saveButtonProps } =
        useStepsForm<IPost, HttpError, IPost>();

    const { selectProps: categorySelectProps } = useSelect<
        ICategory,
        HttpError
    >({
        resource: "categories",
    });

    const formList = [
        <>
            <Form.Item
                label="Title"
                name="title"
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Input />
            </Form.Item>
            <Form.Item
                label="Category"
                name={["category", "id"]}
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Select {...categorySelectProps} />
            </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.Item
                label="Content"
                name="content"
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Input.TextArea />
            </Form.Item>
        </>,
    ];

    return (
        <Create
            footerButtons={
                <>
                    {current > 0 && (
                        <Button
                            onClick={() => {
                                gotoStep(current - 1);
                            }}
                        >
                            Previous
                        </Button>
                    )}
                    {current < formList.length - 1 && (
                        <Button
                            onClick={() => {
                                gotoStep(current + 1);
                            }}
                        >
                            Next
                        </Button>
                    )}
                    {current === formList.length - 1 && (
                        <SaveButton {...saveButtonProps} />
                    )}
                </>
            }
        >
            <Steps {...stepsProps}>
                <Step title="About Post" />
                <Step title="Content" />
            </Steps>

            <Form {...formProps} layout="vertical" style={{ marginTop: 30 }}>
                {formList[current]}
            </Form>
        </Create>
    );
};

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

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

For the sake of simplicity, in this example we're going to build a Post "create" form that consists of only a title and a relational category field.

To split your form items under a <Steps> component, first import and use useStepsForm hook in your page:

pages/posts/create.tsx
import React from "react";
import { HttpError } from "@refinedev/core";
import { useStepsForm } from "@refinedev/antd";

export const PostCreate: React.FC = () => {
    const {
        current,
        gotoStep,
        stepsProps,
        formProps,
        saveButtonProps,
        queryResult,
    } = useStepsForm<IPost, HttpError, IPost>();

    return null;
};

interface ICategory {
    id: number;
}

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

useStepsForm is a generic over the type form data to help you type check your code.

This hook returns a set of useful values to render steps form. Given current value, you should have a way to render your form items conditionally with this index value. You can use an array to achieve this.

Here, each item of formList corresponds to one step in form:

pages/posts/create.tsx
import React from "react";
import { HttpError } from "@refinedev/core";
import { useStepsForm, useSelect } from "@refinedev/antd";
import { Form, Input, Select } from "antd";

export const PostCreate: React.FC = () => {
    const { current, gotoStep, stepsProps, formProps, saveButtonProps } =
        useStepsForm<IPost, HttpError, IPost>();

    const { selectProps: categorySelectProps } = useSelect<
        ICategory,
        HttpError
    >({
        resource: "categories",
    });

    const formList = [
        <>
            <Form.Item
                label="Title"
                name="title"
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Input />
            </Form.Item>
        </>,
        <>
            <Form.Item
                label="Category"
                name={["category", "id"]}
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Select {...categorySelectProps} />
            </Form.Item>
        </>,
    ];

    return null;
};

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

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

Since category is a relational data, we use useSelect to fetch its data.

Refer to useSelect documentation for detailed usage. →


You should use stepsProps on <Steps> component, formProps on the <Form> component. And as the last step, you should render the <Steps> component besides the form like this:

pages/posts/create.tsx
import React from "react";
import { HttpError } from "@refinedev/core";
import {
    useStepsForm,
    useSelect,
    Create,
} from "@refinedev/antd";
import {
    Form,
    Input,
    Select,
    Steps,
} from "antd";

export const PostCreate: React.FC = () => {
    const {
        current,
        gotoStep,
        stepsProps,
        formProps,
        saveButtonProps,
        queryResult,
    } = useStepsForm<IPost, HttpError, IPost>();

    const { selectProps: categorySelectProps } = useSelect<
        ICategory,
        HttpError
    >({
        resource: "categories",
    });

    const formList = [
        <>
            <Form.Item
                label="Title"
                name="title"
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Input />
            </Form.Item>
        </>,
        <>
            <Form.Item
                label="Category"
                name={["category", "id"]}
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Select {...categorySelectProps} />
            </Form.Item>
        </>,
    ];

    return (
        <Create saveButtonProps={saveButtonProps}>
            <Steps {...stepsProps}>
                <Step title="About Post" />
                <Step title="Content" />
            </Steps>
            <Form {...formProps} layout="vertical">
                {formList[current]}
            </Form>
        </Create>
    );
};

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

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

Make sure to add as much <Steps.Step> components as the number of steps in the formList array.


To help users navigate between steps in the form, you can use the action buttons. Your navigation buttons should use the gotoStep function that was previously returned from the the useStepsForm hook.

pages/posts/create.tsx
import React from "react";
import { HttpError } from "@refinedev/core";
import {
    useStepsForm,
    useSelect,
    Create,
    SaveButton,
} from "@refinedev/antd";
import { Button, Form, Input, Select, Steps } from "antd";

export const PostCreate: React.FC = () => {
    const {
        current,
        gotoStep,
        stepsProps,
        formProps,
        saveButtonProps,
        queryResult,
        submit,
    } = useStepsForm<IPost, HttpError, IPost>();

    const { selectProps: categorySelectProps } = useSelect<
        ICategory,
        HttpError
    >({
        resource: "categories",
    });

    const formList = [
        <>
            <Form.Item
                label="Title"
                name="title"
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Input />
            </Form.Item>
        </>,
        <>
            <Form.Item
                label="Category"
                name={["category", "id"]}
                rules={[
                    {
                        required: true,
                    },
                ]}
            >
                <Select {...categorySelectProps} />
            </Form.Item>
        </>,
    ];

    return (
        <Create
            footerButtons={
                <>
                    {current > 0 && (
                        <Button
                            onClick={() => {
                                gotoStep(current - 1);
                            }}
                        >
                            Previous
                        </Button>
                    )}
                    {current < formList.length - 1 && (
                        <Button
                            onClick={() => {
                                gotoStep(current + 1);
                            }}
                        >
                            Next
                        </Button>
                    )}
                    {current === formList.length - 1 && (
                        <SaveButton
                            {...saveButtonProps}
                            style={{ marginRight: 10 }}
                            onClick={() => submit()}
                        />
                    )}
                </>
            }
        >
            <Steps {...stepsProps}>
                <Step title="About Post" />
                <Step title="Content" />
            </Steps>
            <Form {...formProps} layout="vertical">
                {formList[current]}
            </Form>
        </Create>
    );
};

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

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

Properties​

TIP

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

defaultCurrent​

defaultCurrent sets the default starting step number. Counting starts from 0.

const stepsForm = useStepsForm({
    defaultCurrent: 2,
});

total​

total is the maximum number of steps. <Steps> cannot go beyond this number.

const stepsForm = useStepsForm({
    total: 3,
});

isBackValidate​

When isBackValidate is true, it validates a form fields when the user navigates to a previous step. It is false by default.

const stepsForm = useStepsForm({
    isBackValidate: 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 the overtime object from this hook. elapsedTime is the elapsed time in milliseconds. It becomes undefined when the request is completed.

const { overtime } = useStepsForm({
    //...
    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.

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

debounce​

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

useStepsForm({
    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.

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

Return Values​

TIP

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

stepsProps​

stepsProps is the props needed by the <Steps> component.

current​

current is the current step, counting from 0.

onChange​

Callback function that is triggered when the current step of the form changes. The function takes in one argument, currentStep, which is a number representing the index of the current step.

current​

The Current step, counting from 0.

gotoStep​

gotoStep is a function that allows you to programmatically change the current step of a form. It takes in one argument, step, which is a number representing the index of the step you want to navigate to.

submit​

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

defaultFormValuesLoading​

When action is "edit" or "clone", useStepsForm will fetch the data from the API and set it as default values. This prop is true when the data is being fetched.

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 } = useStepsForm();

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. We can do this by overriding the submit function.

pages/user/create.tsx
import { useStepsForm } from "@refinedev/antd";
// ...
const {
    current,
    gotoStep,
    stepsProps,
    formProps,
    saveButtonProps,
    onFinish,
} = useStepsForm<IPost>({
    submit: (values) => {
        const data = {
            fullName: `${formValues.name} ${formValues.surname}`,
            age: formValues.age,
            city: formValues.city,
        };
        onFinish(data as any);
    },
});
// ...

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 Values​

KeyDescriptionType
stepsPropsAnt Design steps propsStepsProps
currentCurrent step, counting from 0.number
gotoStepGo to the target step(step: number) => void
formPropsAnt Design form propsFormProps
formAnt Design form instanceFormInstance<TVariables>
defaultFormValuesLoadingDefaultFormValues loading status of formboolean
submitSubmit method, the parameter is the value of the form fields() => void
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-steps-form
Previous
useModalForm
Next
useImport