Skip to content

juicycleff/steps

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

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.

Packages

No packages published

Languages

  • CSS 52.2%
  • JavaScript 47.8%