https://github.com/react-component/m-steps

React Steps for mobile
https://github.com/react-component/m-steps

Last synced: 7 months ago
JSON representation

React Steps for mobile

• Host: GitHub
• URL: https://github.com/react-component/m-steps
• Owner: react-component
• License: mit
• Created: 2017-09-22T02:41:36.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T22:45:39.000Z (about 3 years ago)
• Last Synced: 2025-08-09T15:31:11.712Z (8 months ago)
• Language: CSS
• Size: 1.77 MB
• Stars: 4
• Watchers: 4
• Forks: 3
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# rmc-steps

---

React steps component.

[![NPM version][npm-image]][npm-url]

[![build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

[![npm download][download-image]][download-url]

[npm-image]: http://img.shields.io/npm/v/rmc-steps.svg?style=flat-square

[npm-url]: http://npmjs.org/package/rmc-steps

[download-image]: https://img.shields.io/npm/dm/rmc-steps.svg?style=flat-square

[download-url]: https://npmjs.org/package/rmc-steps

[travis-image]: https://img.shields.io/travis/react-component/m-steps.svg?style=flat-square

[travis-url]: https://travis-ci.org/react-component/m-steps

[coveralls-image]: https://img.shields.io/coveralls/react-component/m-steps.svg?style=flat-square

[coveralls-url]: https://coveralls.io/r/react-component/m-steps?branch=master

## Usage

```bash

npm install rmc-steps

```

```jsx

  

  

  

```

## 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.