Callout
An editorial note that belongs to the document content.
Try it
Rich note
A note with a link in its body.
Use it
Working invocation
This code creates the configuration shown above. Copy the template and the required Python context together.
{% extends "brickwork/components/_callout.html" %}
{% block body %}<p>Read the <a href="/guide/">integration guide</a>.</p>{% endblock %}context = {'title': 'Before you begin', 'variant': 'note'}Guide
Add it to your project
- Supply a textual title.
- Include with short `body`, or extend the partial and fill `body` for rich content.
Options
Public API
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
| title | str | Not set | Yes | Callout heading. Constraint: Must be non-empty when it supplies an accessible heading; a named title block may replace it. |
| body | str | Not set | No | Plain paragraph body. Constraint: No additional package-level validation is documented beyond this option's stated type and its role in the component. |
| variant | str | note | No | Editorial treatment. Allowed: note, info, success, warning, danger, neutral. Constraint: Use one of the documented variants; use `danger`, not an invented `error` severity. |
Named blocks
Fill these only when you extend the component template. They are not values passed to an include or tag.
| Block | What it replaces |
|---|---|
| body | Rich body markup that overrides the body string. Constraint: Fill by extending. |
Behaviour
Accessibility and responsive behaviour
- Accessibility
- It deliberately has no alert or live-region role; title text, not colour, states its kind.
- Responsive
- No breakpoint switch.
- Without JavaScript
- Static HTML only.
Need help?
Troubleshooting
Contract check: Required: title (the kind is stated as TEXT here, never colour alone).
Supply `title`, including the textual kind, because callouts deliberately do not use alert semantics or colour alone.