useStepsForm
http://localhost:3000useStepsForm allows you to manage a form with multiple steps. It provides features such as which step is currently active, the ability to go to a specific step and validation when changing steps etc.
useStepsForm hook is extended from useForm from the @refinedev/react-hook-form package. This means you can use all the features of useForm.
Basic Usage
We'll show two examples, one for creating and one for editing a post. Let's see how useStepsForm is used in both.
- create
- edit
Here is the final result of the form: We will explain the code in following sections.
http://localhost:3000Here is the final result of the form: We will explain the code in following sections.
http://localhost:3000In this example we're going to build a Post "create" form. We also added a relational category field to expand our example.
To split your <input/> components under a <form/> component, first import and use useStepsForm hook in your page:
import { HttpError, useSelect } from '@refinedev/core'
import { useStepsForm } from '@refinedev/react-hook-form'
const PostCreate = () => {
const {
refineCore: { onFinish, formLoading },
register,
handleSubmit,
formState: { errors },
steps: { currentStep, gotoStep },
} = useStepsForm<IPost, HttpError, IPost>()
return <div>...</div>
}
interface ICategory {
id: number
title: string
}
interface IPost {
id: number
title: string
content: string
status: 'published' | 'draft' | 'rejected'
category: {
id: ICategory['id']
}
}
useStepsForm is 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.
Here, we're going to use a switch statement to render the form items based on the currentStep.
import { HttpError, useSelect } from '@refinedev/core'
import { useStepsForm } from '@refinedev/react-hook-form'
const PostCreate = () => {
const {
refineCore: { onFinish, formLoading },
register,
handleSubmit,
formState: { errors },
steps: { currentStep, gotoStep },
} = useStepsForm<IPost, HttpError, IPost>()
const { options } = useSelect<ICategory, HttpError>({
resource: 'categories',
})
const renderFormByStep = (step: number) => {
switch (step) {
case 0:
return (
<>
<label>Title: </label>
<input
{...register('title', {
required: 'This field is required',
})}
/>
{errors.title && <span>{errors.title.message}</span>}
</>
)
case 1:
return (
<>
<label>Status: </label>
<select {...register('status')}>
<option value="published">published</option>
<option value="draft">draft</option>
<option value="rejected">rejected</option>
</select>
</>
)
case 2:
return (
<>
<label>Category: </label>
<select
{...register('category.id', {
required: 'This field is required',
})}
>
{options?.map((category) => (
<option key={category.value} value={category.value}>
{category.label}
</option>
))}
</select>
{errors.category && <span>{errors.category.message}</span>}
<br />
<br />
<label>Content: </label>
<textarea
{...register('content', {
required: 'This field is required',
})}
rows={10}
cols={50}
/>
{errors.content && <span>{errors.content.message}</span>}
</>
)
}
}
return <div>...</div>
}
interface ICategory {
id: number
title: string
}
interface IPost {
id: number
title: string
content: string
status: 'published' | 'draft' | 'rejected'
category: {
id: ICategory['id']
}
}
Since category is a relational data, we use useSelect to fetch its data.
Now, we can use renderFormByStep function to render the form items based on the currentStep and gotoStep function to navigate between steps.
import { HttpError, useSelect } from '@refinedev/core'
import { useStepsForm } from '@refinedev/react-hook-form'
const PostCreate = () => {
const {
refineCore: { onFinish, formLoading },
register,
handleSubmit,
formState: { errors },
steps: { currentStep, gotoStep },
} = useStepsForm<IPost, HttpError, IPost>()
const { options } = useSelect<ICategory, HttpError>({
resource: 'categories',
})
const renderFormByStep = (step: number) => {
switch (step) {
case 0:
return (
<>
<label>Title: </label>
<input
{...register('title', {
required: 'This field is required',
})}
/>
{errors.title && <span>{errors.title.message}</span>}
</>
)
case 1:
return (
<>
<label>Status: </label>
<select {...register('status')}>
<option value="published">published</option>
<option value="draft">draft</option>
<option value="rejected">rejected</option>
</select>
</>
)
case 2:
return (
<>
<label>Category: </label>
<select
{...register('category.id', {
required: 'This field is required',
})}
>
{options?.map((category) => (
<option key={category.value} value={category.value}>
{category.label}
</option>
))}
</select>
{errors.category && <span>{errors.category.message}</span>}
<br />
<br />
<label>Content: </label>
<textarea
{...register('content', {
required: 'This field is required',
})}
rows={10}
cols={50}
/>
{errors.content && <span>{errors.content.message}</span>}
</>
)
}
}
if (formLoading) {
return <div>Loading...</div>
}
return (
<div style={{ display: 'flex', flexDirection: 'column', gap: 16 }}>
<div style={{ display: 'flex', gap: 36 }}>
{stepTitles.map((title, index) => (
<button
key={index}
onClick={() => gotoStep(index)}
style={{
backgroundColor: currentStep === index ? 'lightgray' : 'initial',
}}
>
{index + 1} - {title}
</button>
))}
</div>
<form autoComplete="off">{renderFormByStep(currentStep)}</form>
<div style={{ display: 'flex', gap: 8 }}>
{currentStep > 0 && (
<button
onClick={() => {
gotoStep(currentStep - 1)
}}
>
Previous
</button>
)}
{currentStep < stepTitles.length - 1 && (
<button
onClick={() => {
gotoStep(currentStep + 1)
}}
>
Next
</button>
)}
{currentStep === stepTitles.length - 1 && (
<button onClick={handleSubmit(onFinish)}>Save</button>
)}
</div>
</div>
)
}
interface ICategory {
id: number
title: string
}
interface IPost {
id: number
title: string
content: string
status: 'published' | 'draft' | 'rejected'
category: {
id: ICategory['id']
}
}
Properties
refineCoreProps
All useForm properties also available in useStepsForm. You can find descriptions on useForm docs.
const stepsForm = useStepsForm({
refineCoreProps: {
action: 'edit',
resource: 'posts',
id: '1',
},
})
stepsProps
The props needed by the manage state steps.
defaultStep
Default:
0
Sets the default starting step number. Counting starts from 0.
const stepsForm = useStepsForm({
stepsProps: {
defaultStep: 0,
},
})
isBackValidate
Default:
false
When is true, validates a form fields when the user navigates to a previous step.
const stepsForm = useStepsForm({
stepsProps: {
isBackValidate: true,
},
})
Return Values
steps
The return values needed by the manage state steps.
currenStep
Current step, counting from 0.
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.
API Reference
Properties
*: These properties have default values inRefineContextand can also be set on the <Refine> component.
It also accepts all props of useForm hook available in the React Hook Form.
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 | Field Values for mutation function | {} | {} |
| TContext | Second generic type of the useForm of the React Hook Form. | {} | {} |
| 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 |
|---|---|---|
| steps | Relevant state and method to control the steps | StepsReturnValues |
| refineCore | The return values of the useForm in the core | UseFormReturnValues |
| React Hook Form Return Values | See React Hook Form documentation |
Example
npm create refine-app@latest -- --example form-react-hook-form-use-steps-form