JoaoCnh/react-loki

A React Wizard...... pun intented

react-loki is a Wizard Component made with React.... and yes.... the pun is intended.

Overview

The goal of this component is to simplify the implementation of a Wizard like experience on a react application.

Loki is an uncommited React component. It doesn't force anything on you and you hold the control over everything on each and every single step component.

You can use it for presentational content and forms. Loki only handles the back and forth mechanic of wizards.

Installation

Add react-loki to your project

yarn add react-loki

Table of Contents

• Usage
• Demo
• Importing Styles
• API
  • <Loki />
    • Loki props
      • steps: array
      • onFinish: function
      • backLabel: string|element
      • nextLabel: string|element
      • finishlabel: string|element
      • noActions: boolean
  • <LokiStepContainer />
  • <LokiStep />
    • LokiStep props
      • currentStep: integer
      • totalSteps: integer
      • step: object
      • isLokiComplete: boolean
• Customizing
  • renderSteps: function
  • renderComponents: function
  • renderActions: function

Usage

First define your steps

const mySteps = [
    {
        label: 'Step 1',
        icon: <AnyComponentYouWant /> //optional,
        component: <Step1Component />,
    },
    ...
];

Then pass them into Loki

import React from 'react';
import Loki from 'react-loki';

class Demo extends React.Component {
    _onFinish() {
        alert('Loki finished!');
    }

    render() {
        return (
            <div className="myWizard">
                <Loki steps={mySteps} onFinish={this._onFinish.bind(this)} />
            </div>
        );
    }
}

Demo

You can also try out the demo

Importing styles

@import "node_modules/react-loki/umd/main.css";

These will import the default loki styles.

API

<Loki />

<Loki /> is the component that controls the wizard like behaviour

Loki props

steps: array [required]

The required steps array. A step is an object composed of:

• label - string
• icon - element optional
• component - element

onFinish: function [required]

The required handler function for when the wizard hits the last step. Whenever you click that final button of the whole wizard this function will be called.

backLabel: string|element

By default the backLabel is 'Back'. This prop will allow you to replace it with a new string value or even a React Component.

nextLabel: string|element

By default the nextLabel is 'Next'. This prop will allow you to replace it with a new string value or even a React Component.

finishLabel: string|element

By default the finishLabel is 'Finish'. This prop will allow you to replace it with a new string value or even a React Component.

noActions: boolean

By default this is false but you can turn it to true if you don't want the actions to be rendered. Let's say in a case where you have the actions inside the custom componentRenderer (renderComponents).

<LokiStepContainer />

<LokiStepContainer /> is the component that renders the wizard progress steps <ol> container

react-loki exposes it to give the option of using it whenever you want. It only needs children passed in. any doubts? check the customizing section`

<LokiStep />

<LokiStep /> is the default component for rendering a progress step.

react-loki exposes it to give the option of using it whenever you want. any doubts? check the customizing section`

LokiStep props

currentStep: integer [required]

totalSteps: integer [required]

step: object [required]

isLokiComplete: boolean [required]

All these props are required and are responsible for rendering out the proper classNames for the correct progress steps. If a step is currently being rendered it will have the class LokiStep-Active. If a step has been complete then it will have the class LokiStep-Complete. By default a step already has the class LokiStep.

Customizing

If you don't want the default progress step look of <LokiStep /> you can always render your own components. The API for this is simple. You can pass any rendering function for steps, inner components and even the buttons.

renderSteps: function

renderComponents: function

renderActions: function

These functions receive as params { currentStep, stepIndex, cantBack, isInFinalStep, backHandler, nextHandler }

With these functions you can override the total rendering logic behind <Loki />. We expose the all that info about <Loki /> so that you can have freedom in what you do.