Skip to main content

HeroBase

Overview​

HeroBase represents the base structure for a hero component. It is extended by other hero-related components and includes attributes for accessibility, text, and layout customization.

Attributes​

id​

type: string

A unique identifier for the hero component.

ariaLabel​

type: string (optional)

The ARIA label for the hero component, used for accessibility purposes.

eyebrowText​

type: object (optional)

Text displayed as an eyebrow above the main header.

text​

type: string (optional)

The eyebrow text content.

format​

type: literal = 'markdown' | 'html' (optional)

The format of the eyebrow text content.

type: object (optional)

The main header text for the hero.

text​

type: string (optional)

The header text content.

format​

type: literal = 'markdown' | 'html' (optional)

The format of the header text content.

subcopy​

type: object (optional)

The subtext or additional information displayed below the header.

text​

type: string (optional)

The subcopy text content.

format​

type: literal = 'markdown' | 'html' (optional)

The format of the subcopy text content.