Truncated List

Style-agnostic truncated list component.

python 7 params

Preview

First itemSecond itemThird item
Arguments
truncated_list(items=['First item', 'Second item', 'Third item', 'Fourth item', 'Fifth item'], max=3)

Usage

views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import TruncatedList


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

    def mount(self, request, **kwargs):
        self.component = TruncatedList(items=['First item', 'Second item', 'Third item', 'Fourth item', 'Fifth item'], max=3)

    @event_handler()
    def toggle_list(self, **kwargs):
        self.component.expanded = not self.component.expanded
my_template.html
django
{{ component }}

Events this component sends to the view: toggle_list.

Parameters

NameTypeDefaultDescription
itemsList | NoneNoneList of items (strings or dicts with 'label' key)
maxint3Maximum items to show before overflow (default: 3)
expandedboolFalseWhether list is currently expanded (default: False)
toggle_eventstr — renames the event; identity is `name`'toggle_list'djust event to toggle expanded state
overflow_labelstr'+{count} more'Custom overflow label; {count} is replaced with hidden count
custom_classstr''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
FilePathNotes
moduledjust.components.components.truncated_listSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 3 of this component's classes at line 1765, 1766, 1767. Override those rules, or the custom properties they read, in a stylesheet loaded after it.