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

Documentation

Token specimen

A live side-by-side display of resolved Brickwork design tokens.

All components Component Brickwork 4.3.1

Try it

Level-three token pack

Open full-page preview

Compare recommended L3 tokens.

Brand foundation

Light

  • --bw-color-accent
  • --bw-color-border
  • --bw-color-border-strong
  • --bw-color-danger
  • --bw-color-fg
  • --bw-color-fg-on-accent per theme
  • --bw-color-success
  • --bw-color-surface
  • --bw-color-surface-marketing-tint
  • --bw-color-surface-overlay
  • --bw-color-surface-raised
  • --bw-color-surface-sunken
  • --bw-color-warning
  • --bw-elevation-1
  • --bw-elevation-2
  • --bw-elevation-3
  • --bw-font-family-display
  • --bw-font-family-mono
  • --bw-font-family-sans
  • --bw-radius-lg
  • --bw-radius-md
  • --bw-radius-sm

Dark

  • --bw-color-accent
  • --bw-color-border
  • --bw-color-border-strong
  • --bw-color-danger
  • --bw-color-fg
  • --bw-color-fg-on-accent per theme
  • --bw-color-success
  • --bw-color-surface
  • --bw-color-surface-marketing-tint
  • --bw-color-surface-overlay
  • --bw-color-surface-raised
  • --bw-color-surface-sunken
  • --bw-color-warning
  • --bw-elevation-1
  • --bw-elevation-2
  • --bw-elevation-3
  • --bw-font-family-display
  • --bw-font-family-mono
  • --bw-font-family-sans
  • --bw-radius-lg
  • --bw-radius-md
  • --bw-radius-sm
Use in theme documentation and brand verification.

Use it

Working invocation

This code creates the configuration shown above. Copy the template and the required Python context together.

templates/your_app/component.html

Django template

{% load brickwork_theming %}
{% bw_token_specimen level=level heading=heading %}

your_app/views.py

Python

context = {'level': 'L3', 'heading': 'Brand foundation'}

Guide

Add it to your project

  1. Load `brickwork_theming`.
  2. Call with no argument for load-bearing tokens, or with exactly one of tokens and level.

View this component's source for the installed release

Options

Public API

Option Type Default Required Description
tokens sequence of token names Not set No Overridable --bw-* tokens. Constraint: Each token must be a package token name; do not combine this selector with `level`.
heading string Not set No Section heading. Constraint: No additional package-level validation is documented beyond this option's stated type and its role in the component.
level string Not set No Recommended token level. Allowed: L1, L2, L3, L4. Constraint: Mutually exclusive with tokens.

Behaviour

Accessibility and responsive behaviour

Accessibility
Each pane is a labelled group; visual swatches are hidden from assistive technology and contrast chips name the pair and floor.
Responsive
Theme panes stack below md.
Without JavaScript
Without JS token values and measured contrast remain empty, while names and declared floors remain.

Need help?

Troubleshooting

Contract check: (templatetags/brickwork_theming.py): never {% include %} directly; the tag

Use the token-specimen tag so it builds rows from the token manifest or validates an explicit token list.

Documentation