rs

react-stepform

This component is used to handle the flow between pages and allows for easy, yet controlled navigation between them. The step form does not provide previous/next buttons on each page, but instead provides several context functions for manipulating the cur

Showing:

Popularity

Downloads/wk

3

Maintenance

No Maintenance Data Available

Package

Dependencies

3

Size (min+gzip)

48.8KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

React Step Form

This component is used to handle the flow between pages and allows for easy, yet controlled navigation between them. The step form does not provide previous/next buttons on each page, but instead provides several context functions for manipulating the current page.

Installation

npm install react-stepform

Usage

See example

Properties

PropDefaultTypeDescription
currentPage0IntegerCan be set initially to be the landing page. This will also modify the current page if changed.
transitionNamestepStringUsed for css transition effect with ReactCSSTransitionGroup
transitionTiming[500, 300]ArrayEnter timeout and leave timeout for ReactCSSTransitionGroup
pageOrderorder of childrenArrayArray of integers indicating order in which the pages should display
pageTitlesnullArrayArray of page names to be used in the form control section
onPageChangenullFunctionFunction that is fired when the page changes via any catalyst
onFinishnullFunctionFunction that is fired when nextPage cannot fire because last page is active
classNamenullStringAppended to component class list

Context

ContextTypeDescription
nextPageFunctionMove to the next page
previousPageFunctionMove to the previous page
setPageFunctionMove to specific page

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100