Cursors Overlay
Overlay showing other users' cursor positions in real-time.
Preview
Usage
views.py
python
from djust import LiveView
from djust.components import CursorsOverlay
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = CursorsOverlay()my_template.html
django
{{ component }}Needs a client hook djust does not ship: dj-hook="CursorsOverlay". The markup renders, but the interaction described above is yours to add — register window.djust.hooks.CursorsOverlay = { mounted() { … } } before client.js loads (see the hooks guide).
Parameters
| Name | Type | Default |
|---|---|---|
| users | List[Union[dict, object]] | None | None |
| custom_class | str | '' |
| **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.cursors_overlay | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 1 of this component's classes at line 2231. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |