Live Counter

Animated counter updating in real-time via WebSocket push.

python 6 params

Preview

42online
Arguments
live_counter(value=42, label='online')

Usage

views.py
python
from djust import LiveView
from djust.components import LiveCounter


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

    def mount(self, request, **kwargs):
        self.component = LiveCounter(value=42, label='online')
my_template.html
django
{{ component }}

Needs its script on the page: <script src="{% static 'djust_components/live-counter.js' %}"></script>. djust ships it; without it the markup renders but does not update in the browser.

Parameters

NameTypeDefaultDescription
valueint0Current counter value
labelstr''Text label shown after the number
stream_eventstr — the event your server pushes to it'counter_update'WebSocket event name for counter updates
sizestr'md'Size variant (sm, md, lg)
custom_classstr''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
FilePathNotes
moduledjust.components.components.live_counterSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 4 of this component's classes at line 1246, 1247, 1249, 1251. Override those rules, or the custom properties they read, in a stylesheet loaded after it.