Summary

Add documentation on creating custom page banners.

Review Request #15077 — Created May 26, 2026 and submitted May 26, 2026, 9:20 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-8.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

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 a TemplateHook and some context
variables, but allowing for more advanced interactions and content.

This guide covers how to create page banners, walking through basic
TemplateHook usage 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.

Testing Done

Built the docs. Checked for build errors, spelling errors, and link
errors.

Ran this through Claude to check for additional problems.

Commits

Summary	ID
Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	90f65121eaff9b85e82d08eb902549fbea2d63b1

Summary

Add documentation on creating custom page banners.

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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.

90f65121eaff9b85e82d08eb902549fbea2d63b1

Issues

Description	From	Last Updated
Reminder to reference this page in the release notes where we talk about custom page banners.	maubin	May 26, 2026, 8:12 p.m.
Can we say "expired license warnings" instead.	maubin	May 26, 2026, 8:12 p.m.
Points 1 and 3 sound a bit confusing together. How about something like: 1. Banner templates are created by using …	maubin	May 26, 2026, 8:14 p.m.
Can we add something like this in a new paragraph below: See Closing Banners <extension-page-banners-closing>_ for more guidance.	maubin	May 26, 2026, 8:15 p.m.
Add a "to" between "listen" and "a" here.	maubin	May 26, 2026, 8:16 p.m.
Can we say "Here's an example that shows a banner only during maintenance hours:".	maubin	May 26, 2026, 8:16 p.m.
Shouldn't this be :ref: instead of using link syntax?	david	May 26, 2026, 8:50 p.m.
This still has a _ at the end.	david	May 26, 2026, 9:13 p.m.
typo: vairables -> variables	david	May 26, 2026, 8:43 p.m.
Needs spaces around the =	david	May 26, 2026, 8:43 p.m.
These dates are kinda funky. Mind adding a comment explaining why 1999-3999?	david	May 26, 2026, 8:43 p.m.
Needs spaces around the =	david	May 26, 2026, 8:43 p.m.
Needs spaces around the =	david	May 26, 2026, 8:43 p.m.
Should be getElementById('{{banner_id}}') (no #)	david	May 26, 2026, 8:43 p.m.
This needs a max-age or it won't persist past the browser session.	david	May 26, 2026, 8:43 p.m.
Hmm, just realized this also doesn't actually close the banner. Should we add bannerEl.remove()? This should probably also be taking …	david	May 26, 2026, 9:13 p.m.
This should be extension-page-banners I think.	david	May 26, 2026, 9:14 p.m.
This ref is extensions-page-banner-context but all the others are extension-page-banners-*	david	May 26, 2026, 9:19 p.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

Reminder to reference this page in the release notes where we talk about custom page banners.

docs/manual/extending/extensions/hooks/template-hook.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we say "expired license warnings" instead.
```

docs/manual/extending/extensions/page-banners.rst (Diff revision 1)

The issue has been resolved. Show all issues

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.

docs/manual/extending/extensions/page-banners.rst (Diff revision 1)

The issue has been resolved. Show all issues

Can we add something like this in a new paragraph below:

See Closing Banners <extension-page-banners-closing>_ for more guidance.

docs/manual/extending/extensions/page-banners.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Add a "to" between "listen" and "a" here.
```
docs/manual/extending/extensions/page-banners.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we say "Here's an example that shows a banner only during maintenance hours:".
```

Change Summary:

Improved wording throughout, and fixed typos.

Commits:

	Summary	ID
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	46e3bec7fb3ae1b6847257f7d60648ea2677afcb
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	68c900a71c2bd818679b07d0528fa89b986fe3f8

Diff:

Revision 2 (+858)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/page-banners.rst
	docs/manual/extending/extensions/hooks/template-hook.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/page-banners.rst (Diff revision 2)

The issue has been resolved. Show all issues

Shouldn't this be :ref: instead of using link syntax?

chipx86

May 26, 2026, 8:41 p.m.

It's on the same page, so it can be either. :ref: gets to anchors on a different page. ..._ gets to anchors on the current page.

docs/manual/extending/extensions/page-banners.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
typo: vairables -> variables
```
docs/manual/extending/extensions/page-banners.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
Needs spaces around the =
```

docs/manual/extending/extensions/page-banners.rst (Diff revision 2)

The issue has been dropped. Show all issues

These dates are kinda funky. Mind adding a comment explaining why 1999-3999?

chipx86

May 26, 2026, 8:41 p.m.

That takes all the fun out of that code sample.

docs/manual/extending/extensions/page-banners.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
Needs spaces around the =
```
docs/manual/extending/extensions/page-banners.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
Needs spaces around the =
```

docs/manual/extending/extensions/page-banners.rst (Diff revision 2)

The issue has been resolved. Show all issues

Should be getElementById('{{banner_id}}') (no #)

chipx86

May 26, 2026, 8:52 p.m.

Bah, I fixed this in one of the code samples and forgot to carry it over to this one.

docs/manual/extending/extensions/page-banners.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
This needs a max-age or it won't persist past the browser session.
```

Change Summary:


Fixed some errors in code samples.
Switched a local anchor ref to a :ref:.
Fixed a typo.
Added an upper-bound max-age to the sample cookie.

Commits:

	Summary	ID
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	68c900a71c2bd818679b07d0528fa89b986fe3f8
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	f0f24ad5e4d13ad122997cef99f7b49b2f80b710

Diff:

Revision 3 (+860)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/page-banners.rst
	docs/manual/extending/extensions/hooks/template-hook.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

docs/manual/extending/extensions/page-banners.rst (Diff revisions 2 - 3)
The issue has been resolved. Show all issues
```
This still has a _ at the end.
```

docs/manual/extending/extensions/page-banners.rst (Diff revisions 2 - 3)

The issue has been resolved. Show all issues

Hmm, just realized this also doesn't actually close the banner. Should we add bannerEl.remove()?

This should probably also be taking in the event and calling preventDefault() so we don't add # to the end of the URL.

docs/manual/extending/extensions/hooks/template-hook.rst (Diff revision 3)
The issue has been resolved. Show all issues
```
This should be extension-page-banners I think.
```
docs/manual/extending/extensions/page-banners.rst (Diff revision 3)
The issue has been resolved. Show all issues
```
This ref is extensions-page-banner-context but all the others are extension-page-banners-*
```

Change Summary:


Updated the close code sample to remove the banner.
Fixed reference names.
Removed a stray _.

Commits:

	Summary	ID
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	f0f24ad5e4d13ad122997cef99f7b49b2f80b710
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	d9bb6bc727d563935368799f7b67ef2dddae0ab7

Diff:

Revision 4 (+866)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/page-banners.rst
	docs/manual/extending/extensions/hooks/template-hook.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Take three on the ref name.

Commits:

	Summary	ID
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	d9bb6bc727d563935368799f7b67ef2dddae0ab7
	Add documentation on creating custom page banners. 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 a `TemplateHook` and some context variables, but allowing for more advanced interactions and content. This guide covers how to create page banners, walking through basic `TemplateHook` usage 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.	90f65121eaff9b85e82d08eb902549fbea2d63b1

Diff:

Revision 5 (+866)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/page-banners.rst
	docs/manual/extending/extensions/hooks/template-hook.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-8.x (74d347b)