Section intro
A convenience include for the public shared section-intro class contract.
Try it
Shared intro
All three shared intro roles.
Use it
Working invocation
This code creates the configuration shown above. Copy the template and the required Python context together.
{% include "brickwork_marketing/components/_section_intro.html" %}context = {'overline': 'Components', 'heading': 'One contract per component', 'lede': 'Read supported options from the shipped template.'}Guide
Add it to your project
- Use the public include path "brickwork_marketing/components/_section_intro.html" from the installed django-brickwork package.
- Place it inside a bw-section__inner.
- Include with any combination of overline, heading and lede.
- Write the same public classes yourself when custom surrounding markup is clearer.
Options
Public API
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
| overline | string | Not set | No | Optional eyebrow above the section heading. Constraint: No additional template constraint beyond the documented type. |
| heading | string | Not set | No | Section heading; its semantic level is set by this component. Constraint: No additional template constraint beyond the documented type. |
| lede | string | Not set | No | Short supporting copy below the section heading. Constraint: No additional template constraint beyond the documented type. |
Behaviour
Accessibility and responsive behaviour
- Accessibility
- Heading is h2; caller owns its correct place in the page outline.
- Responsive
- Fluid token-based typography, without a breakpoint switch.
- Without JavaScript
- Static HTML; no JavaScript required.
Need help?
Troubleshooting
The intro has no visual spacing.
Place it inside a `.bw-section__inner` container so the shared section spacing and measure contract applies.
Explore next