You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
5 years ago | |
|---|---|---|
| .. | ||
| assets | 5 years ago | |
| lib | 5 years ago | |
| HISTORY.md | 5 years ago | |
| LICENSE.md | 5 years ago | |
| README.md | 5 years ago | |
| package.json | 5 years ago | |
README.md
rmc-steps
React steps component.
Usage
npm install rmc-steps
<Steps current={1}>
<Steps.Step title="first" />
<Steps.Step title="second" />
<Steps.Step title="third" />
</Steps>
Example
http://localhost:8002/examples
online example: http://react-component.github.io/m-steps/examples/
API
| name | type | default | description |
|---|---|---|---|
| direction | string | horizontal | direction of Steps, enum: `horizontal` or `vertical` |
| current | number | 0 | index of current step |
| size | string | size of Steps, could be `small` | |
| labelPlacement | string | placement of step title, could be `vertical` | |
| status | string | wait | status of current Steps, could be `error` `process` `finish` `wait` |
Steps.Step
| name | type | default | description |
|---|---|---|---|
| title | ReactNode | title of step item | |
| description | ReactNode | description of step item | |
| icon | ReactNode or string | set icon of step item | |
| status | string | status of current Steps, could be `error` `process` `finish` `wait` |
Development
npm install
npm start
License
rmc-steps is released under the MIT license.