README.md

material-ui-status-stepper

Material UI-inspired vertical status stepper that shows statuses as colorful cards, along with other visual changes

(NPM package: https://www.npmjs.com/package/material-ui-status-stepper)

How to use this

• Clone the repo: git clone https://github.com/virgil9306/material-ui-status-stepper
• Install the dependencies: cd material-ui-status-stepper && npm install
• Pack it (if you make any changes): npm run pack
• Import it (import StatusStepper from 'material-ui-status-stepper';)
• Use it!

NOTE: Since this is a Material-UI component, the dependency is material-ui. You must have an MuiThemeProvider to use it. Please see the MaterialUI documentation for an example of how to get an MuiThemeProvider in your app.

Configuration

Prop name	Sample value	Effect
currentStatus	'INACTIVE'	Current status to show as active
statuses	(See Example Statuses below)	Statuses to display
titleStyle	{fontSize: 24}	Override style for dialog title

Example Statuses

const steps = [
    {
        title: 'Inactive', // Title to display
        status: 'INACTIVE', // Status identifier (same as what you pass into currentStatus)
        completed: false, // All statuses preceding currentStatus will be marked as completed = true
        actions: [ // Will be displayed as material-ui button(s). (Ideally keep to ~3 items.)
            {
                name: 'NEXT',
                callback: this.handleClickNext,
                style: {width: 88},
            }
        ],
        colors: {
            background: 'blue', // Background color of card-style header
            text: 'black' // text color of card-style header
        },
        hideIfNotActive: true // If this status is not the current status, don't display it
    }
];

Roadmap

• Expandable support (with React component props expandToggleOpen, expandToggleClose, and expandBody)
• Add full testing
• Example page
• Code coverage to 100%
• More customizable styles

Screenshot