Components
Banner - Official Gov
Use: Deployed
This banner identifies official websites of government organizations in the United States. They also help visitors understand whether a website is official and secure.
Examples
Default
View va-official-gov-banner in Storybook
View va-official-gov-banner in StorybookInternationalization
View va-official-gov-banner internationalization in Storybook
Usage
USWDS v3 component
This component comes directly from the U.S. Web Design System (USWDS). Thus we follow the guidance and considerations documented in the USWDS for this component. The guidance below augments the USWDS guidance to give specifics on how we use the component at the VA.
View USWDS guidance on BannerWhen to use Banner - Official Gov
Always. The official government banner should appear on every VA.gov page at the very top of the page.
How to use Banner
Auto-injected. The official government banner is automatically injected onto all VA.gov pages using our content-build process.
Placement
Above header. The official government banner appears directly above the VA.gov header and
Code usage
Attributes and Properties
| Property | Attribute | Type | Default | Description |
|---|---|---|---|---|
disableAnalytics |
disable-analytics |
boolean |
false |
If `true`, the component-library-analytics event is disabled. |
tld |
tld |
string |
'gov' |
Accepts a top level domain (TLD) value of either `gov` or `mil`. Default is `gov`. |
Events
| Name | Description |
|---|---|
component-library-analytics |
The event used to track usage of the component. |