1.0.0 • Published 2 years ago

@tkwant/react-steps v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

React Stepper

React Stepper which can also be used on mobile devices

Npm Package: https://www.npmjs.com/package/@tkwant/react-steps

Demo: https://stepper.tkwant.de

image

Installation

yarn add @tkwant/react-steps
npm i @tkwant/react-steps

Usage

import React, { useState } from "react";
import { Stepper, Step } from "@tkwant/react-steps";
interface Props {}
const App: React.FC<Props> = () => {
  const [curStep, setCurStep] = useState(0);
  const [step2Data, setStep2Data] = useState("");
  const renderContent = () => {
    switch (curStep) {
      case 0:
        return (
          <div style={{ display: "flex", justifyContent: "center" }}>
            First Step
          </div>
        );
      case 1:
        return (
          <div style={{ display: "flex", justifyContent: "center" }}>
            <p style={{ marginRight: 2 }}>My Validation: </p>
            <input
              style={{ border: "2px solid red" }}
              onChange={(e) => setStep2Data(e.currentTarget.value)}
              value={step2Data}
            />
          </div>
        );
      default:
        return null;
    }
  };

  return (
    <>
      <Stepper
        style={{ padding: 10 }}
        curStep={curStep}
        setCurStep={setCurStep}
      >
        <Step label="Step 0 " />
        <Step label="Step 1" />
        <Step locked={step2Data === ""}>??</Step>
        <Step locked={curStep < 2} />
        <Step locked={curStep < 3} />
        <Step locked={curStep < 4} />
        <Step locked={curStep < 5} />
      </Stepper>
      {renderContent()}
    </>
  );
};

export default App;

Stepper Props

PropDescriptionDefault
children
curStep
setCurStep
classNameoptional""
activeColoroptional"#0b294b"
inActiveColoroptional"#D1D5DB"
borderColoroptional"#8fb3db"
stepSizeoptional60
progressBarActiveColoroptional"green"
progressBarBackgroundColoroptional"lightgray"
smallScreenShowProgressbaroptionaltrue
styleoptional{}

Step Props

PropDescriptionDefault
childrenoptionalcurrent Index
labeloptional""
lockedoptionalfalse
1.0.0

2 years ago

0.0.5

2 years ago

0.0.4

3 years ago

0.0.6

2 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago

0.0.0

3 years ago