Sortable Grid
2D drag-and-drop grid layout.
Preview
Alpha
Beta
Gamma
Arguments
sortable_grid(items=[{'id': 'a', 'label': 'Alpha'}, {'id': 'b', 'label': 'Beta'}, {'id': 'c', 'label': 'Gamma'}])Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import SortableGrid
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = SortableGrid(items=[{'id': 'a', 'label': 'Alpha'}, {'id': 'b', 'label': 'Beta'}, {'id': 'c', 'label': 'Gamma'}])
@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-grid.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``, ``label``, optional ``thumbnail`` |
| columns | int | 3 | number of grid columns (default 3) |
| move_event | str — renames the event; identity is `name` | 'reorder' | djust event fired on reorder |
| gap | str | '0.75rem' | CSS gap value (default "0.75rem") |
| 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_grid | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 3 of this component's classes at line 1974, 1975, 1980. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |