Filter Bar

Filter bar component with filter controls.

python 5 params

Preview

Status: Active
Arguments
filter_bar(content='<span>Status: Active</span>', active_count=1)

Usage

views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import FilterBar
from django.utils.safestring import mark_safe


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

    def mount(self, request, **kwargs):
        self.component = FilterBar(content=mark_safe('<span>Status: Active</span>'), active_count=1)

    @event_handler()
    def clear_filters(self, **kwargs):
        self.component.active_count = 0
my_template.html
django
{{ component }}

Events this component sends to the view: clear_filters.

Parameters

NameTypeDefaultDescription
contentstr''filter controls (pre-rendered HTML)
clear_eventstr — renames the event; identity is `name`'clear_filters'dj-click event for clearing filters
active_countint0number of active filters
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.filter_barSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 4 of this component's classes at line 1590, 1591, 1603, 2535. Override those rules, or the custom properties they read, in a stylesheet loaded after it.