Contents

Chapter 1

Features

This chapter covers the core features and capabilities of Multi-Step Wizard.

Features

  • Multi-step form engine: define wizard flows as JSON, render to HTML or run interactively
  • State management: persist wizard state across steps with JSON session files
  • Progress tracking: visual progress bar and step numbering
  • Conditional step skipping: skip steps based on previous answers
  • HTML rendering: generate complete, styled HTML wizard forms
  • Interactive CLI mode: step-through wizard in the terminal
  • Customizable labels: back, next, submit button text, form action/method
  • Python 3.10+ stdlib only — no pip installs required

Quick Start

bash
# Run the built-in demo wizard
python src/multi_step_wizard.py --demo

# Run interactively from a JSON definition
python src/multi_step_wizard.py --input examples/onboarding_wizard.json --interactive

# Render to HTML
python src/multi_step_wizard.py --input examples/onboarding_wizard.json --render

# Render to an HTML file
python src/multi_step_wizard.py --input examples/onboarding_wizard.json --render --output wizard.html
Chapter 2

CLI Reference

Follow this guide to get Multi-Step Wizard up and running in your environment.

CLI Reference

FlagDescription
--input FILELoad wizard definition from JSON file
--renderRender the wizard as HTML to stdout
--interactiveRun the wizard interactively in the terminal
--demoRun a built-in demo wizard
--output FILEWrite rendered HTML to a file instead of stdout

Wizard JSON Format

json
{
  "id": "user-onboarding",
  "title": "Account Setup Wizard",
  "showProgressBar": true,
  "showStepNumbers": true,
  "allowBack": true,
  "nextLabel": "Continue",
  "backLabel": "Go Back",
  "submitLabel": "Complete Setup",
  "action": "/api/onboarding",
  "method": "POST",
  "steps": [
    {
      "id": "personal",
      "title": "Personal Info",
      "description": "Tell us about yourself",
      "icon": "👤",
      "fields": [
        {
          "name": "full_name",
          "type": "text",
          "label": "Full Name",
          "required": true,
          "placeholder": "Jane Smith"
        },
        {
          "name": "email",
          "type": "email",
          "label": "Email Address",
          "required": true,
          "help": "We'll send your confirmation here"
        }
      ]
    },
    {
      "id": "company",
      "title": "Company Details",
      "skipCondition": "personal.role == 'individual'",
      "fields": [
        {
          "name": "company_name",
          "type": "text",
          "label": "Company Name",
          "required": true
        }
      ]
    }
  ]
}

Step Fields

FieldTypeRequiredDescription
idstringyesUnique step identifier
titlestringyesStep title
descriptionstringnoStep description shown below title
iconstringnoEmoji icon for the step
fieldsarrayyesForm fields in this step
skipConditionstringnoExpression to skip this step

Form Field Options

FieldTypeRequiredDescription
namestringyesInput name attribute
typestringyestext, email, password, number, tel, url, textarea, select, checkbox, radio, date, file
labelstringyesDisplay label
requiredboolnoWhether the field is required
placeholderstringnoPlaceholder text
optionsarraynoOptions for select/radio fields
helpstringnoHelp text shown below the input
patternstringnoRegex pattern for validation
minLengthintnoMinimum character length
maxLengthintnoMaximum character length
Chapter 3
🔒 Available in full product

Programmatic Usage

Chapter 4
🔒 Available in full product

File Structure

You’ve reached the end of the free preview

Get the full Multi-Step Wizard and unlock everything.

All Chapters

Get the complete guide with every chapter unlocked, including code samples, diagrams, and best practices.

Full Tool Suite

Access all interactive tools with complete data, all workload profiles, and the full scenario library.

Source Files

Downloadable source code, configuration files, and working examples from every chapter.

Lifetime Updates

Free updates for life. Every new chapter, tool, and improvement included.

Buy Now — $29 →
📦 Free sample included — download another copy for the full product.
Multi-Step Wizard v1.0.0 — Free Preview