Sidebar

Sidebar navigation component.

python 7 params

Arguments

sidebar(title='Workspace', items=[{'label': 'Dashboard', 'href': '#', 'active': True}, {'label': 'Projects', 'href': '#projects'}, {'label': 'Settings', 'href': '#settings'}])

Usage

views.py

from djust import LiveView
from djust.decorators import event_handler
from djust.components import Sidebar


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

    def mount(self, request, **kwargs):
        self.component = Sidebar(title='Workspace', items=[{'label': 'Dashboard', 'href': '#', 'active': True}, {'label': 'Projects', 'href': '#projects'}, {'label': 'Settings', 'href': '#settings'}])

    @event_handler()
    def toggle_sidebar(self, **kwargs):
        self.component.collapsed = not self.component.collapsed

my_template.html

{{ component }}

Events this component sends to the view: toggle_sidebar.

Parameters

Name	Type	Default
items	list \| None	None
title	str	''
collapsed	bool	False
content	str	''
toggle_event	str — renames the event; identity is `name`	'toggle_sidebar'
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.sidebar	Subclass it, or pass custom_class, to change how it renders.
css	djust_components/components.css	Defines 9 of this component's classes at line 1451, 1453, 1455, 1457, 1459, 1461, 1464, 1465, 1467. Override those rules, or the custom properties they read, in a stylesheet loaded after it.

Sidebar

Preview

Usage

Parameters