Package Exports

react-promenade
react-promenade/dist/index.js
react-promenade/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-promenade) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React Promenade

React components for crafting multi-step user flows

Start Here · Documentation · Author

Introduction

Boost completion rates by breaking big forms into multi-step user flows!

View full documentation and examples under ./docs.

Quick Start

import { PromenadeProvider, PromenadeStep, usePromenade } from 'react-promenade';

function Signup() {
  return (
    <PromenadeProvider
      isNextDisabled={(currentStep) => false}
      isBackDisabled={(currentStep) => false}
      onBack={(currentStep, totalNumberOfSteps) => { console.log('back clicked') }}
      onNext={(currentStep, totalNumberOfSteps) => { console.log('next clicked') }}
    >
      <PromenadeStep index={0}><EmailStep /></PromenadeStep>
      <PromenadeStep index={1}><AvatarStep /></PromenadeStep>
      <PromenadeStep index={2}><FollowStep /></PromenadeStep>
    </PromenadeProvider>
  )
}

function EmailStep() {
  const { isNextDisabled, isBackDisabled, goForward, goBackward } = usePromenade()

  return (
    <div>
      <h1>Step 1</h1>
      <button onClick={goForward} disabled={isNextDisabled}>Next</button>
      <button onClick={goBackward} disabled={isBackDisabled}>Back</button>
    </div>
  )
}

Author

Gus @gdbroman (reach out for questions or feedback)