Banner - Maintenance

Examples

Default (during maintenance)

View va-maintenance-banner in Storybook

Warning (upcoming maintenance)

View va-maintenance-banner maintenance warning in Storybook

Usage

When to use Banner - Maintenance

• System maintenance. Before and during maintenance, we use specific system status messages to communicate the maintenance window to users. Use maintenance messages 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. For application-level maintenance, review the downtime notifications guidance.

Behavior

The content and UX behavior of site-wide 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. These banners have the following characteristics:

• Dates, times, and duration (how many hours or minutes) are customizable in the upcoming/before message.
• Times are always given in Eastern time (ET).
• Banners are always dismissible per session.
• The “upcoming” before message should be published at least 12 hours in advance. Allow more lead time when the outage is unusually long or comprehensive.
• The banner automatically expires when downtime is complete.
• A maximum of 3 banners can appear simultaneously.

Code usage

Provide feedback

Share your feedback, report issues, or suggest improvements for the Banner - Maintenance component. Your input helps us make the design system better for everyone.

• Get immediate support in #platform-design-system for technical or urgent issues.
• Explore all feedback channels for additional ways to share your input.