Collab Selection

Highlights text or cell ranges selected by other users.

python 3 params

Preview

Draws other users' selections over your content through a client hook djust does not ship — see below.

Usage

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


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

    def mount(self, request, **kwargs):
        self.component = CollabSelection()
my_template.html
django
{{ component }}

Needs a client hook djust does not ship: dj-hook="CollabSelection". The markup renders, but the interaction described above is yours to add — register window.djust.hooks.CollabSelection = { mounted() { … } } before client.js loads (see the hooks guide).

Parameters

NameTypeDefault
usersList[Union[dict, object]] | NoneNone
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.collab_selectionSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 1 of this component's classes at line 2248. Override those rules, or the custom properties they read, in a stylesheet loaded after it.