Switch
Style-agnostic toggle switch component using CSS custom properties.
Preview
python
switch(name='notifications', label='Enable notifications', checked=True, action='toggle_switch')Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import Switch
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = Switch(name='notifications', label='Enable notifications', checked=True, action='toggle_switch')
@event_handler()
def toggle_switch(self, **kwargs):
self.component.checked = not self.component.checkedmy_template.html
django
{{ component }}Events this component sends to the view: toggle_switch.
Parameters
| Name | Type | Default |
|---|---|---|
| name | str | '' |
| checked | bool | False |
| label | str | None | None |
| disabled | bool | False |
| action | str | None | None |
| custom_class | str | '' |
| **kwargs | — passed to `Component.__init__`: `id=` sets `component.id`, and any other keyword is kept as state | — |
Source & styles
| File | Path | Notes |
|---|---|---|
| module | djust.components.components.switch | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 5 of this component's classes at line 2543, 2544, 2545, 2551. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |