Skip to content
This repository has been archived by the owner on May 20, 2019. It is now read-only.

Commit

Permalink
Document steps prop
Browse files Browse the repository at this point in the history
  • Loading branch information
wbobeirne authored Jan 12, 2018
1 parent a033b2c commit 3826829
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,13 @@ render() {
See full example [here](https://github.com/mu29/react-stepper/blob/master/example/example.js)

## API

### Main Component

| name | description | default | type |
|----------|----------------|--------------|--------|
|activeStep|Active step index, starts at 0|0|number|
|steps|List of steps, must be string array||array|
|steps|List of step objects (see below)||array|
|activeColor|Active circle color|#5096FF|string|
|completeColor|Completed circle color|#5096FF|string|
|defaultColor|Default circle color - not active or completed|#E0E0E0|string|
Expand Down Expand Up @@ -55,6 +58,13 @@ See full example [here](https://github.com/mu29/react-stepper/blob/master/exampl
|defaultBarColor|Default color of bar separating circles|#E0E0E0|string|
|completeBarColor|Color of bar connected to a completed step|#E0E0E0|string|

### Step Objects
| name | description | default | type |
|----------|----------------|------------|--------|
|title|Displayed text of the step below the number|undefined|string|
|href|Link to send them to on click|undefined|string|
|onClick|Event handler for when the step is clicked|undefined|function|


## Author

Expand Down

0 comments on commit 3826829

Please sign in to comment.