1.0.1 • Published 3 years ago

react-responsive-steppers v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

React Responsive Steppers

A Fully Responsive Horizontal and Vertical Stepper

Installation

Install react-responsive-steppers with npm

  npm install react-responsive-steppers
    import React from 'react';
import {Stepper, Step} from 'react-responsive-steppers';

function App(){
     const [activeStep, setActiveStep]=useState(0);
     return(
    <Stepper variant={"horizontal"} activeStep={activeStep} setStep={setActiveStep}>
     <Step>1</Step>
     <Step>2</Step>
     <Step>3</Step>
    </Stepper>
)} 

Props

Stepper

NameTypeDescriptionDefault
stepSizestring/objectmust be in px{ xxl: '55px', xl: '50px', lg: '45px', md: '40px', sm: '30px', xs: '25px' }
disabledStepColorstringmust be colorlightgray
disabledTextColorstringmust be colorgray
stepColorstringmust be colorblue
stepTextColorstringmust be colorwhite
activeStepnumbermust start from zeroundefined
setStepfuncmust be functionundefined
variantstringvertical / horizontalhorizontal

Step

NameTypeDescriptionDefault
onClickfuncmust be functionundefined
labelnumbermust be numberundefined
childrenstringmust be stringundefined
contentelementit is required in vertical stepperundefined

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.