Live Indicator

Shows 'Alice is typing...' style indicator per field.

python 6 params

Preview

Ada is typing
Arguments
live_indicator(user={'name': 'Ada'}, field='Title', action='typing')

Usage

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


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

    def mount(self, request, **kwargs):
        self.component = LiveIndicator(user={'name': 'Ada'}, field='Title', action='typing')
my_template.html
django
{{ component }}

Parameters

NameTypeDefaultDescription
userobject | NoneNoneDict with name (and optional avatar) or string name.
fieldstr''Field name being edited.
actionstr'typing'Action label (default: "typing").
activeboolTrueWhether the indicator is visible (default: True).
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_indicatorSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 4 of this component's classes at line 2303, 2306, 2307, 2308. Override those rules, or the custom properties they read, in a stylesheet loaded after it.