Announcement Bar
Announcement/banner bar component.
Preview
python
announcement_bar(content='Scheduled maintenance on Sunday.', variant='warning', dismissible=True)Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import AnnouncementBar
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = AnnouncementBar(content='Scheduled maintenance on Sunday.', variant='warning', dismissible=True)
@event_handler()
def dismiss_announcement(self, value=None, **kwargs):
pass # your app acts on 'dismiss_announcement'; no component state movesmy_template.html
django
{{ component }}Events this component sends to the view: dismiss_announcement.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| content | str | '' | bar content (pre-rendered HTML) |
| variant | str | 'info' | info, warning, danger, success |
| dismissible | bool | False | whether bar can be dismissed |
| dismiss_event | str — renames the event; identity is `name` | 'dismiss_announcement' | dj-click event name |
| 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.announcement_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 1134, 1135, 1136, 1140. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |