1.4.2 • Published 3 years ago

@orcden/od-wizard v1.4.2

Weekly downloads
4
License
MIT
Repository
bitbucket
Last release
3 years ago

A component to quickly create a step-by-step wizard

<od-wizard> is a simple component that allows the user to define a set of pages to be displayed in an orderly fashion. The wizard allows users to progress to the first incomplete step and backtrack to any previous step. It provides a callback hook when the user has completed the wizard.

<od-wizard-page> is a simple component that allows the user to define a page name for od-wizard steps. It provides callback hooks for when the user loads the page andd when the user advances the page.

Installation

  • Install with npm
npm i @orcden/od-wizard

Usage

import '@orcden/od-wizard';
<od-wizard>
    <label slot='title'>Example Wizard</label>
    <od-wizard-page title='Step 1'>
        <p>Step 1</p>    
    </od-wizard-page>
    <od-wizard-page title='Step 2'>
        <p>Step 2</p>
    </od-wizard-page>
</od-wizard>

Attributes

OD-Wizard-Page

AttributeTypeDefaultDescription
titleStringundefinedRequired This is the title that the wizard will use to generate the navigation item

Properties

OD-Wizard

AttributeTypeDefaultDescription
doneCallbackfunctionundefinedParams: od-wizard - this function will be called once the final step of the wizard returns true for its callback

OD-Wizard-Page

AttributeTypeDefaultDescription
loadCallbackfunctionundefinedParams: od-wizard-page - this function will be called when the page is loaded
doneCallbackfunctionundefinedParams: od-wizard-page - this function will be called when the user hits the next button. It must return true or false to indicate to the wizard if it is allowed to progress to the next step.

Functions

OD-Wizard-Page

NameParametersDescription
executeLoadNoneManually call the load function of the page with its scope pased through
executeDoneNoneManually call the done function of the page with its scope pased through

Styling

  • CSS variables are available to alter the default styling provided

OD-Wizard

Shadow PartsDescription
title-slotThe slot used to hold the Title item
nav-containerThe div used to hold the nav and the pages container
navThe actual navigation list
nav-itemThe individual "links" in the navigation
nav-item-enabledThe enabled links in the navigation
nav-item-currentThe current link/step in the navigation
pages-containerThe div the holds the individual pages and gthe buttons container
buttons-containerThe div that holds the control buttons
prev-buttonThe Back Button
next-buttonThe Next Button
finish-buttonThe Finish Button

Development

Run development server and show demo

npm run demo

Run linter

npm run lint

Fix linter errors

npm run fix

Run tests

npm run test

Build for production

npm run build
1.4.2

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.2.0

3 years ago

1.1.1

3 years ago

1.1.2

3 years ago

1.1.0

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago