Announcement Bar

Announcement/banner bar component.

python 6 params

Preview

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

Events this component sends to the view: dismiss_announcement.

Parameters

NameTypeDefault
contentstr''
variantstr'info'
dismissibleboolFalse
dismiss_eventstr — renames the event; identity is `name`'dismiss_announcement'
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.announcement_barSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 4 of this component's classes at line 1108, 1109, 1110, 1114. Override those rules, or the custom properties they read, in a stylesheet loaded after it.