Bootstrap¶

Swappable design system using Bootstrap 5 and htmx. Provides static assets, a base HTML layout, and a dark mode theme switcher for all pages. For icons, see bsicons. For htmx helpers, see htmx.

Package: github.com/oliverandrich/burrow/contrib/bootstrap

Depends on: staticfiles, htmx

Setup¶

srv := burrow.NewServer(
    session.New(),
    csrf.New(),
    auth.New(),
    bootstrap.New(),                    // provides base layout + Bootstrap assets
    htmx.New(),                         // serves htmx.min.js
    healthcheck.New(),
    admin.New(),
    staticApp, // staticfiles.New(myStaticFS) — returns (*App, error)
)

The staticfiles app must be registered to serve the embedded CSS and JS.

Layout¶

Layout() returns a LayoutFunc that renders a base HTML page with Bootstrap CSS, Bootstrap JS bundle (includes Popper), and htmx:

bootstrap.Layout() // returns burrow.LayoutFunc

The layout function:

1. Receives the rendered page fragment as template.HTML
2. Executes the "bootstrap/layout" template, passing the fragment as .Content
3. Includes navigation from context, CSRF meta tag, and theme switcher

Middleware Behaviour¶

The bootstrap middleware injects its layout only when no layout is already set in the request context:

• srv.SetLayout(custom) is called — custom layout wins, bootstrap skips
• srv.SetLayout() is NOT called — bootstrap layout takes effect
• Admin /admin route group always overrides unconditionally

This makes bootstrap batteries-included by default without fighting custom layouts.

Templates¶

The bootstrap app implements HasTemplates and contributes these templates:

Pagination¶

Use the pagination template in your own templates:

{{ define "notes/list" -}}
<h1>Notes</h1>
<ul>
  {{ range .Notes }}<li>{{ .Title }}</li>{{ end }}
</ul>
{{ template "bootstrap/pagination" .Page }}
{{- end }}

The pagination template expects a burrow.PageResult value. It renders nothing when TotalPages <= 1, shows previous/next buttons with disabled states, and includes ellipsis for large page counts.

For full pagination documentation, see the Pagination Guide.

Static Files¶

The bootstrap app embeds these static assets and implements HasStaticFiles to contribute them under the "bootstrap" prefix:

These are served at /static/bootstrap/bootstrap.min.css, etc. when the staticfiles app is registered.

Template Functions¶

The bootstrap app contributes these template functions via HasFuncMap:

These are used internally by the bootstrap/pagination template but are available in all templates.

Dark Mode¶

The layout includes a theme switcher toggle that persists the user's preference in localStorage. It uses Bootstrap's data-bs-theme attribute to switch between light and dark modes without a page reload.

Swapping Design Systems¶

The bootstrap package is intentionally self-contained. To use a different CSS framework, create a new contrib app (e.g., contrib/pico or contrib/tailwind) that provides its own assets and layout, and register it instead of bootstrap.New().

Interfaces Implemented¶