Primer

Site navigation

Hero

Use the hero component to render a full-width banner at the top of a page.

On this page

On this page

Anatomy

An image displaying a hero with a heading, description, primary and secondary actions.

  • Label: an optional label to provide leading context to the hero.
  • Heading: the main title of the hero.
  • Description: a short description of the hero.
  • Actions: the main and secondary actions the user should take on the page.
  • Image: an optional foreground image that appears adjacent to the text

Usage

Use the hero component to provide a title, description and action that introduces the main content of a page. The hero component is designed to be positioned at the top of a page and spans the full width of the viewport. Consider using the CTA banner to replicate the content and actions in other parts of the page.

Both heading and description of the hero should be short and descriptive. Heading should be not be longer than 2 lines, and description should be no longer than 3-4 lines.

The hero component is not designed to provide a lot of information to the user. Consider using other components, such as the section intro or the river component instead.

The hero heading is rendered as an h1 element by default. You can modify the heading level but be aware that this will affect the page's heading structure and may impact accessibility. See heading accesibility for more information.

The hero can optionally include primary and secondary actions. These actions are rendered as a button group and follow the same guidelines as the button group component.

Do

Use the hero component to introduce the page with short, descriptive text.

Don’t

Don't use long, complex text in the hero. Consider splitting the content using other components.

Options

Alignment

Hero elements can be aligned to the start or center of the page. By default, the hero is aligned to the start of the page to allow for an image or a visual asset to be positioned on the right of the hero. Use the center alignment if the asset is centered or not present, or the scenario calls for it.

Do

Use left alignment if the hero includes an image or visual asset on the right.

Don’t

Don't use center alignment if the background interfere with the legibility of the content.

Related components

  • Section intro: To provide a title, description and a link to a new section in the page.
  • River: To display a list of content items with a visual asset.
  • CTABanner: To draw attention to or create urgency around a user action.