Svelte-wizard

Interactive Demo

Playground

⚡️ Features

• Custom Styles
• Step Navigation
• State Management
• Progress Bar
• Event Dispatching
• Dynamic Content

Installation

$ npm i svelte-wizard

Basic Usage

<script>
    import { WizardComponent } from 'svelte-wizard';
    import StepOne from './StepOne.svelte';

    let stepsList = [
        {
            step: StepOne,
            title: 'Step one'
        },
        {
            step: StepTwo,
            title: 'Step two'
        },
        {
            step: StepThree,
            title: 'Step three'
        }
    ];
</script>

<WizardComponent {stepsList} />

With Options

<script>
    import {WizardComponent} from 'svelte-wizard'

    let stepsList = [...];

    let options = {
        showTitles: true,
        showCheckIcon: false,
    };
</script>

<WizardComponent stepsList={stepsList} options={options}  />

With ClassNames

<script>
    import {WizardComponent} from 'svelte-wizard'

    let stepsList = [...];

    let customClassnames = {
        activeTitleClass: 'activeTitleClass'
    };

</script>

   <WizardComponent stepsList={stepsList} customClassnames={customClassnames}  />

Props

Svelte Wizard features a primary component that offers several props for customization, allowing for extensive flexibility and tailored configurations to suit various use cases.

StepsList

Options

customClassnames

Events

Svelte wizard provides custom events to the parent and child components giving control over navigation and form state management.

Examples

Parent Component

<!-- FormContainer.svelte -->

<WizardComponent
    on:stepChange={(e) => console.log(e)} // Returns the current step index
    on:stepsInitialized={(e) => console.log(e)} //Returns an object
/>

Child Component

<!-- StepOne.svelte -->

<script>
    import { createEventDispatcher } from 'svelte';

    const dispatch = createEventDispatcher();

    const handleNext = () => {
        dispatch('handleNext');
    };
    const handleBack = () => {
        dispatch('handleBack');
    };
    const handleSkipTo = () => {
        dispatch('handleSkipTo', 1);
    };
    const handleSkipToEnd = () => {
        dispatch('handleSkipToEnd');
    };
    const handleSkipToStart = () => {
        dispatch('handleSkipToStart');
    };
    const handleReset = () => {
        dispatch('handleReset');
    };
</script>

<div>
    <p>STEP ONE</p>

    <button on:click={handleNext}> Next</button>
    <button on:click={handleSkipToEnd}> Skip</button>
</div>

State Management

Svelte Wizard offers streamlined state management through wizardFormState, which is readily accessible to all child components. State updates are handled efficiently using the handleStateUpdate function, enabling seamless data flow and synchronization across steps

handleStateUpdate

The handleStateUpdate function accepts two arguments, with behavior determined by the type of the first argument. This setup allows for fine-grained control over wizardFormState, whether updating individual fields or replacing the entire state object.

• String When the first argument is a string, it represents a key in wizardFormState. The second argument then becomes the value assigned to this key.

• Object When the first argument is an object, the function merges it into wizardFormState by default. The second argument is optional and also an object.

Object props

Example

<!-- StepOne.svelte -->

<script>
    export let handleStateUpdate;
    export let wizardFormState;

    let firstName = '';
    let lastName = wizardFormState?.lastName; //Persists during navigation

    const handleSubmit = () => {
        handleStateUpdate('firstName', firstName); // String
        handleStateUpdate({ lastName }); // Object
        handleStateUpdate({ firstName, lastName }, { replaceAll: true }); // Object with options
        console.log(wizardFormState); // Contains the updated state
    };
</script>

<div>
    <input bind:value={firstName} />
    <input bind:value={lastName} />
    <buttonon:click={handleSubmit}>Submit</button>
</div>

defaultFormState

Svelte wizard also accepts the defaultFormState props used to define default data for wizardFormState

<WizardComponent defaultFormState={{ firstName: '' }} />

Using Custom Classes

Here’s how to apply custom CSS classes within a Svelte component, as opposed to using a global stylesheet.

:global(.activeTitleClass) {
    <!-- CSS Properties -->
}
:global(.inactiveTitleClass) {
    <!-- CSS Properties -->
}
:global(.activeBarItemClass) {
    <!-- CSS Properties -->
}
:global(.inactiveBarItemClass) {
    <!-- CSS Properties -->
}
:global(.activeStepNumberClass) {
    <!-- CSS Properties -->
}
:global(.inactiveStepNumberClass) {
    <!-- CSS Properties -->
}

Contribution

Svelte-wizard is an open-source project and contributions are welcome.

⚖️ Licence

MIT (c) Sonia Uduma