Skip to main content
U.S. flag

An official website of the United States government

Dot gov

The .gov means it’s official.
Federal government websites often end in .gov or .mil. Before sharing sensitive information, make sure you’re on a federal government site.

Https

The site is secure.
The https:// ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely.

Components

Banner - Maintenance

Use: Deployed
Banners specifically for site-wide system messages, typically system maintenance, which are fixed to the top of the viewport.

Examples

Before maintenance

View MaintenanceBanner in Storybook

During maintenance

View MaintenanceBanner in Storybook

Usage

When to use MaintenanceBanner

  • System maintenance. Before and during maintenance there are specific system status messages that we use to communicate the maintenance window to users. Maintenance messages are used when all (or most) unauthenticated and authenticated applications, tools, or sign in experiences across the entire site are affected (e.g., vets-api).

When to consider something else

  • Anything that is not a System status message. This component is ONLY for site-wide system status messages. There is no other appropriate use.

Behavior

The content and UX behavior of sitewide maintenance banners are standardized. Only the duration, dates, and times are customizable.

The Public Website Team (Office of the CTO Digital Experience) publishes downtime maintenance banners.

  • Specify custom dates and times.
  • Specify custom duration (how many hours or minutes) in the upcoming/before message.
  • Times are always given in ET.
  • Sitewide maintenance banners are always dismissible per session.
  • The ‘upcoming’ before message should be published at least 12 hours in advance. (Can be more in advance when the outage is unusually long or comprehensive.)
  • Banner expires and automatically removed when downtime is complete.
  • A maximum of 3 banners are allowed simultaneously.
Edit this page in GitHub (Permissions required)
Last updated: Aug 24, 2022