dj-layouts

A Django layout composition library. Views return their own content as partials; a Layout class assembles the full page by calling other views as named panels, concurrently under ASGI.

Read the docs →

Quick start

pip install dj-layouts

# myapp/layouts.py
from dj_layouts import Layout, Panel

class DefaultLayout(Layout):
    template = "layouts/default.html"
    navigation = Panel("core:navigation")
    footer = Panel("<p>© Acme</p>")

# myapp/views.py
from dj_layouts import layout

@layout(DefaultLayout)
def homepage(request):
    return render(request, "home/index.html", {"items": get_items()})

HTMX Smart Routing (SPA)

With HTMX Smart Routing, you can turn your standard multi-page Django application into a smooth single-page application (SPA) with zero client-side routing logic.

Opt-in by enabling the setting in your settings.py:

DJ_LAYOUTS = {
    "PARTIAL_DETECTORS": ["dj_layouts.detection.htmx_detector"],
    "HTMX_SMART_ROUTING": True,
}

Add hx-boost="true" to your <body>. When a user navigates between views:

• If the next view uses the same layout, dj-layouts returns only the partial view response and tells HTMX to retarget and swap just the #panel-content panel (extremely fast).
• If the next view uses a different layout, dj-layouts dynamically assembles the new full layout, updates the layout tracker cookie, and tells HTMX to smoothly swap the entire <body>.

Supported versions

Documentation

Full documentation at fukalite.github.io/dj-layouts/.

Contributing

See CONTRIBUTING.md.

Security

See SECURITY.md.

Licence

MIT