Sortable Grid

2D drag-and-drop grid layout.

python 7 params

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):
        ...  # write to self.component; the re-render carries it
my_template.html
django
{{ component }}

Events this component sends to the view: reorder.

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

Parameters

NameTypeDefault
itemslist | NoneNone
columnsint3
move_eventstr — renames the event; identity is `name`'reorder'
gapstr'0.75rem'
disabledboolFalse
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.sortable_gridSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 3 of this component's classes at line 1947, 1948, 1953. Override those rules, or the custom properties they read, in a stylesheet loaded after it.