Skip to main content
brickwork
GitHub Log in Get started
Display
Theme
Density
Direction
Brand

Documentation

Components / Shells

App shell

Application workspace with responsive desktop navigation, topbar and optional two-tier regions.

Full-page preview

Open full-page preview

The preview is a registered, same-origin template for this shell. It does not run visitor supplied source.

Use it

Read the pinned package source

{% extends "brickwork/shell/app.html" %}
{% load brickwork_nav %}
{% block sidebar %}{% bw_nav items=nav_items active=nav_active %}{% endblock %}
{% block mobile_nav %}{% bw_nav items=nav_items active=nav_active %}{% endblock %}
{% block content %}<p>Workspace content.</p>{% endblock %}

Public blocks

BlockUse
rail / rail_regionCapability rail for layout='regions'.
sidebar / sidebar_mobile / mobile_navUse the same reachable tree in both.
sidebar_switcher / mobile_nav_switcherConsumer-owned workspace switcher above navigation.
topbar / topbar_search / topbar_notifications / topbar_account_menuTopbar composition seams.
subnav / breadcrumbsOptional navigation regions.
page_header / page_actions / content / footerPage-local workspace seams.

Accessibility and no-JavaScript behaviour

The mobile drawer is native details. The sidebar collapse control is an optional enhancement, and its expanded state remains fully usable.

Desktop and mobile navigation are server-rendered. Do not make a destination available only in a JavaScript flyout.

Troubleshooting

The regions layout has an empty gap.
Fill rail and sidebar only when needed. Empty region tracks collapse by contract.
Documentation