Stepper

Step indicator/wizard progress component.

python 5 params

Preview

Arguments
stepper(steps=[{'label': 'Account'}, {'label': 'Details'}, {'label': 'Review'}], active=1)

Usage

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


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

    def mount(self, request, **kwargs):
        self.component = Stepper(steps=[{'label': 'Account'}, {'label': 'Details'}, {'label': 'Review'}], active=1)

    @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
activeint0
eventstr — renames the event; identity is `name`'set_step'
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.stepperSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 5 of this component's classes at line 602, 609. Override those rules, or the custom properties they read, in a stylesheet loaded after it.