rc-steps@3.4.1

EXAMPLES

README.md

rc-steps


React steps component.

NPM version build status Test coverage npm download

Usage

npm install rc-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/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
showNumber boolean display step number, It will be ignored if icons is provided
onChange (current: number) => void Trigger when Step changed

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
showNumber boolean display step number, It will be ignored if icon/icons is provided
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.

Fork me on GitHub