Wizard

Style-agnostic multi-step form wizard using CSS custom properties.

python 6 params

Preview

Arguments
wizard(steps=[{'id': 'account', 'label': 'Account'}, {'id': 'profile', 'label': 'Profile'}, {'id': 'review', 'label': 'Review'}], active='profile')

Usage

views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import Wizard


class MyView(LiveView):
    template_name = "my_template.html"

    def mount(self, request, **kwargs):
        self.component = Wizard(steps=[{'id': 'account', 'label': 'Account'}, {'id': 'profile', 'label': 'Profile'}, {'id': 'review', 'label': 'Review'}], active='profile')

    @event_handler()
    def set_step(self, value, **kwargs):
        self.component.active = value
my_template.html
django
{{ component }}

Events this component sends to the view: set_step.

Parameters

NameTypeDefault
stepslist | NoneNone
activestr''
eventstr — renames the event; identity is `name`'set_step'
show_numbersboolTrue
custom_classstr''
**kwargs— passed to `Component.__init__`: `name=` identifies the instance in the events it sends, `id=` sets `component.id`, and any other keyword is kept as state
Source & styles
FilePathNotes
moduledjust.components.components.wizardSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 8 of this component's classes at line 1786, 1787, 1788, 1789, 1790, 1791, 1794, 1795. Override those rules, or the custom properties they read, in a stylesheet loaded after it.