1.0.1 • Published 8 years ago
react-stepform v1.0.1
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
| Prop | Default | Type | Description |
|---|---|---|---|
currentPage | 0 | Integer | Can be set initially to be the landing page. This will also modify the current page if changed. |
transitionName | step | String | Used for css transition effect with ReactCSSTransitionGroup |
transitionTiming | 500, 300 | Array | Enter timeout and leave timeout for ReactCSSTransitionGroup |
pageOrder | order of children | Array | Array of integers indicating order in which the pages should display |
pageTitles | null | Array | Array of page names to be used in the form control section |
onPageChange | null | Function | Function that is fired when the page changes via any catalyst |
onFinish | null | Function | Function that is fired when nextPage cannot fire because last page is active |
className | null | String | Appended to component class list |
Context
| Context | Type | Description |
|---|---|---|
nextPage | Function | Move to the next page |
previousPage | Function | Move to the previous page |
setPage | Function | Move to specific page |