Checks run (2 succeeded)
flake8
passed.
JSHint
passed.
Add documentation on creating custom page banners.
Review Request #15077 — Created May 26, 2026 and updated
Page banners are a new feature in Review Board 8. They give extensions a
consistent way of displaying important information at the top of any or
all pages, using little more than aTemplateHookand some context
variables, but allowing for more advanced interactions and content.This guide covers how to create page banners, walking through basic
TemplateHookusage and working through subclasses for dynamic content,
custom templates for additional layout and scripting, and details like
how to use cookies and JavaScript to implement support for closing
banners.
Built the docs. Checked for build errors, spelling errors, and link
errors.Ran this through Claude to check for additional problems.
| Summary | ID |
|---|---|
| 46e3bec7fb3ae1b6847257f7d60648ea2677afcb |
| Description | From | Last Updated |
|---|---|---|
|
Reminder to reference this page in the release notes where we talk about custom page banners. |
maubin
|
|
|
Can we say "expired license warnings" instead. |
maubin
|
|
|
Points 1 and 3 sound a bit confusing together. How about something like: 1. **Banner templates are created** by using … |
maubin
|
|
|
Can we add something like this in a new paragraph below: See Closing Banners <extension-page-banners-closing>_ for more guidance. |
maubin
|
|
|
Add a "to" between "listen" and "a" here. |
maubin
|
|
|
Can we say "Here's an example that shows a banner only during maintenance hours:". |
maubin
|
-
-
-
-
Points 1 and 3 sound a bit confusing together. How about something like:
1. **Banner templates are created** by using or subclassing :ref:`TemplateHook <template-hook>` along with :file:`ui/components/page-banner.html`. 3. **Banners are registered** by instantiating the :ref:`TemplateHook <template-hook>` using the ``page-banners`` hook point in your extension. -
Can we add something like this in a new paragraph below:
See
Closing Banners <extension-page-banners-closing>_for more guidance. -
-