Skip to content
Cimpress UI

Page header API

Usage guidelinesAPIResources

Import

Section titled “Import”
import { UNSTABLE_PageHeader } from '@cimpress-ui/react';

Accessibility notes

Section titled “Accessibility notes”

The page header renders the page title as an <h1>. Use one page header for the primary content of a page, and make sure the required title clearly identifies that page.

API reference

Section titled “API reference”

UNSTABLE_PageHeader

Section titled “UNSTABLE_PageHeader”
ref
Section titled “ ref ”
Ref<HTMLElement>

The ref type for this component.

UNSTABLE_PageHeaderProps
title *
Section titled “ title * ”
string

The title describing the page. Rendered as an <h1> element.

breadcrumbs
Section titled “ breadcrumbs ”
ReactNode

Optional navigation breadcrumbs displayed above the title.

actions
Section titled “ actions ”
ReactNode

Optional action buttons or controls displayed to the right of the title.

description
Section titled “ description ”
ReactNode

Optional row beneath the title for metadata or a short description. Automatically styled as subtle when a string is provided.

tabs
Section titled “ tabs ”
ReactNode

Optional tabs displayed below the header content.

id
Section titled “ id ”
string

The element's unique identifier. See MDN.

data-cim-style-root
Section titled “ data-cim-style-root ”
boolean

Use this attribute to "claim" the component tree for exclusive Cimpress UI usage.

UNSAFE_className
Section titled “ UNSAFE_className ”
string

Sets the CSS className for the element. Only use as a last resort. Use style props instead.

See styling guide.

UNSAFE_style
Section titled “ UNSAFE_style ”
CSSProperties

Sets the CSS style for the element. Only use as a last resort. Use style props instead.

See styling guide.