Filter Bar
Filter bar component with filter controls.
Preview
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 = 0my_template.html
django
{{ component }}Events this component sends to the view: clear_filters.
Parameters
| Name | Type | Default |
|---|---|---|
| content | str | '' |
| clear_event | str — renames the event; identity is `name` | 'clear_filters' |
| active_count | int | 0 |
| custom_class | str | '' |
| **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.filter_bar | 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 1564, 1565, 1577, 2432. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |