@felte/multi-step

@felte/multi-step

A package to help you handle multi step forms. This is a simple helper whose API might change a lot and might end up being part of the core package eventually. I would not consider it as a best practice yet.

Installation

npm install --save @felte/multi-step

# Or, if you use yarn

yarn add @felte/multi-step

Usage

Instead of importing createForm from Felte, import createForms from @felte/multi-step (you still need Felte as part of your dependencies). This function accepts an object with two properties, an initialStep value if you wish to initialize the form in a different step than 0 (the default), and a pages property which is an array of objects. Each of them being an individual form's configuration.

import { createForms } from '@felte/multi-step';

const { step, pages, increaseStep, decreaseStep, totalSteps } = createForms({
  initialStep: 1,
  pages: [
    {
      onSubmit: ({ increaseStep }) => increaseStep(),
    },
    {
      onSubmit: ({ allValues }) => console.log(allValues),
    },
  ],
});

As you may have noticed, the signature for the onSubmit function differs to the one used in Felte. It passes an object to you with the following properties:

• values: The values submitted on the current step.
• allValues: The current value of all the forms on submission.
• increaseStep: A helper function to go to the next step.
• decreaseStep: A helper function to go to the previous step.
• step: A writable store that contains the current step.
• currentStep: The current step the form is in.

The object returned by createForms contains the following properties:

• totalSteps: A number that represents the total steps of the form.
• increaseStep: A helper function to go to the next step.
• decreaseStep: A helper function to go to the previous step.
• step: A writable store that contains the current step.
• pages: An array of objects, the same object returned by Felte's createForm for each form.

Typescript

createForms accepts a generic argument, it should be a tuple that contains the Data shape for each form. Typescript support is still spotty, though. And there's no way to add an "extended" signature as you can do with Felte's createForm.

import { createForms } from '@felte/multi-step';

type Page1 = {
  name: string;
}

type Page2 = {
  address: string;
}

const { pages } = createForms<[Page1, Page2]>({
  initialStep: 1,
  pages: [
    {
      onSubmit: ({ increaseStep }) => increaseStep(),
    },
    {
      onSubmit: ({ allValues }) => console.log(allValues),
    },
  ],
});