rc-steps
React steps component.
Usage
npm install rc-steps
<Steps => <Steps.Step ="first" /> <Steps.Step ="second" /> <Steps.Step ="third" /></Steps>
Example
http://localhost:8002/examples
online example: http://react-component.github.io/steps/examples/
API
name | type | default | description |
---|---|---|---|
direction | string | horizontal | direction of Steps, enum: `horizontal` or `vertical` |
current | number | 0 | index of current step |
initial | number | 0 | index initial |
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` |
icons | { finish: ReactNode, error: ReactNode } | spicify the default finish icon and error icon |
Steps.Step
name | type | default | description |
---|---|---|---|
title | ReactNode | title of step item | |
description | ReactNode | description of step item | |
icon | ReactNode | set icon of step item | |
status | string | status of current Steps, could be `error` `process` `finish` `wait` | |
tailContent | ReactNode | content above tail |
Development
npm install
npm start
License
rc-steps is released under the MIT license.