Sortable List
Drag-and-drop reorderable list.
Preview
- First item
- Second item
- Third item
Arguments
sortable_list(items=[{'id': '1', 'label': 'First item'}, {'id': '2', 'label': 'Second item'}, {'id': '3', 'label': 'Third item'}])Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import SortableList
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = SortableList(items=[{'id': '1', 'label': 'First item'}, {'id': '2', 'label': 'Second item'}, {'id': '3', 'label': 'Third item'}])
@event_handler()
def reorder(self, value=None, **kwargs):
... # write to self.component; the re-render carries itmy_template.html
django
{{ component }}Events this component sends to the view: reorder.
Needs a client hook djust does not ship: dj-hook="SortableList". The markup renders, but the interaction described above is yours to add — register window.djust.hooks.SortableList = { mounted() { … } } before client.js loads (see the hooks guide).
Parameters
| Name | Type | Default |
|---|---|---|
| items | list | None | None |
| move_event | str — renames the event; identity is `name` | 'reorder' |
| handle | bool | True |
| disabled | bool | False |
| 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.sortable_list | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 4 of this component's classes at line 1936, 1937, 1941, 1942. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |