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):
pass # your app acts on 'reorder'; no component state movesmy_template.html
django
{{ component }}Events this component sends to the view: reorder.
Needs its script on the page: <script src="{% static 'djust_components/sortable-list.js' %}"></script>. djust ships it; without it the markup renders but does not update in the browser.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| items | list | None | None | list of dicts with ``id`` and ``label`` keys |
| move_event | str — renames the event; identity is `name` | 'reorder' | djust event fired on reorder (receives ``order`` list) |
| handle | bool | True | show drag handle (default True) |
| disabled | bool | False | disable drag (default False) |
| custom_class | str | '' | 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
| 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 1963, 1964, 1968, 1969. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |