Skip to content

PageHeader API

API reference docs for the React PageHeader component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import { PageHeader } from '@toolpad/core/PageContainer';


A header component to provide a title and breadcrumbs for your pages.

Props

NameTypeDescription
breadcrumbsArray<{ path: string, title: string }>

The breadcrumbs of the page. Leave blank to use the active page breadcrumbs.

slotProps{ toolbar: { children?: node } }

The props used for each slot inside.

slots{ toolbar?: elementType }

The components used for each slot inside.

See Slots API below for more details.

titlestring

The title of the page. Leave blank to use the active page title.

The component cannot hold a ref.

Slots

Slot nameClass nameDefault componentDescription
toolbarPageHeaderToolbarThe component that renders the actions toolbar.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.