Segmented Progress
Style-agnostic segmented progress bar with labeled steps.
Preview
Arguments
segmented_progress(steps=['Cart', 'Address', 'Payment', 'Done'], current=3, size='md')
Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import SegmentedProgress
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = SegmentedProgress(steps=['Cart', 'Address', 'Payment', 'Done'], current=3, size='md')
@event_handler()
def set_segment(self, value, **kwargs):
self.component.current = valuemy_template.html
django
{{ component }}Events this component sends to the view: set_segment.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| steps | List[Union[str, Dict]] | None | None | List of step labels (strings) or dicts with "label" key |
| current | int | 0 | Current step number (1-indexed) |
| size | str | 'md' | Size variant (sm, md, lg) |
| event | str — renames the event; identity is `name` | 'set_segment' | djust event dispatched when a step is clicked. Each step sends its 1-based number as `value`, so a host sets `current` to it. Pass an empty string to render the steps as static indicators instead. |
| custom_class | str | '' | Additional CSS classes |
| **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
| File | Path | Notes |
|---|---|---|
| module | djust.components.components.segmented_progress | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components-classes.css | Defines 10 of this component's classes at line 420, 426, 434, 459, 473, 479, 485, 496, 505, 509. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |
| css | djust_components/components.css | Defines 9 of this component's classes at line 2551, 2594, 2598, 2601, 2602, 2603, 2605, 2606. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |