Socket
Socket
Sign inDemoInstall

react-stepper-component-with-svg

Package Overview
Dependencies
8
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-stepper-component-with-svg

simple react stepper component with svg


Version published
Weekly downloads
12
decreased by-45.45%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

React Stepper Component

React Stepper Component is a simple yet customizable component using SVG that will help you to make you application more intutive and appealing. This will help you make you stepper more responsive.

Screenshot

screenshot

Features!

  • Highly customizable
  • Easy to manage
  • Can set color for outer circle, inner circle & counter
  • Can set custom label
  • Can set color for label
  • Can set custom color for completed steps, Connector, Completed Label and active Step
  • Have a callback function for click
  • Works completely based on an Object

Installation

npm install --save react-stepper-component-with-svg

Usage

import  Stepper  from 'react-stepper-component-with-svg';

<Stepper onClickCallback={callbackFunctionName} stepperData={stepperData}/>

Props for Stepper

PropsOptionDefaultDescription
onClickCallbackfunctionnoneCallback function for click on step item
stepperDataStepperDTOnoneObject that manages the stepper

Sample Data Object

  const stepperData = {
    currentStep: 2,
    outerCircleBorderColor: "#ccc",
    innerCircleBorderColor: "#ccc",
    counterTextColor: "#ccc", 
    labelTextColor: "#ccc",
    completedIndicatorColor: "green",
    completedTextColor: "#fff", 
    connectorColor: "#ccc", 
    completedLabelColor: "green",
    activeIndicator: "#006400", 
    steps: [
        {
            title: 'Step1'
        },
        {
            title: 'Step2'
        },
        {
            title: 'Step3'
        },
        {
            title: 'Step4'
        },
        {
          title: 'Step5'
        }
    ]
};

stepperDTO

PropsOptionDefaultDescription
currentStepnumbernoneValue for active step
outerCircleBorderColorstringColor code for the outer circle
innerCircleBorderColorstringColor code for the inner circle
counterTextColorstringColor code for counter text
labelTextColorstringColor code for label
completedIndicatorColorstringColor code for completion indicator
completedTextColorstringColor code for completed text
connectorColorstringColor code for connector line
completedLabelColorstringColor code for completed label
activeIndicatorstringColor code for active step indicator
steps[StepsDTO]noneArray of objects with label for step

StepsDTO

PropsOptionDefaultDescription
titlestringnoneLabel for the stepper

Keywords

FAQs

Last updated on 08 May 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc