mjangir / formik-wizard-form

Build multi step forms using Formik with ease.
http://formikwizard.manishjangir.com
MIT License
74 stars 18 forks source link
form-wizard formik-form-wizard formik-multi-step-form formik-wizard stepper-form wizard-steps

Formik Wizard Form

npm type definitions npm compressed size build e2e tests GitHub

Getting Started

Formik wizard form is a library which lets you build multistep form wizards in React with ease. It has been written over the famous form library formik and provides the enhanced versions of formik's <Formik /> and useFormik hook. Formik wizard form requires few additional props along with <Formik /> original props as well as adds some properties to the render props object.

Apart from that, the library is style or css framework agnostic and leaves the rendering part completely up to you. It just provides render props and you build your UI out of them.

For more information on usage, please refer to the How To Use and Examples section.

How To Install

Install the package from npm or yarn registry.

Install From Yarn

yarn add formik-wizard-form

Install From NPM

npm install formik-wizard-form --save

How To Use?

Formik wizard form exports two components <FormWizard /> and useFormikWizard similar to Formik's <Formik /> and useFormik hook and their original props have been left untouched. Rather they require you to provide few additional props to create a form wizard.

import { FormikWizard, useFormikWizard } from 'formik-wizard-form';

Visit formikwizard.manishjangir.com for docs and examples!

Based On

Formik

Maintainers

Manish Jangir