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.
Name | Type | Description |
---|---|---|
breadcrumbs | Array<{ 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. |
title | string | The title of the page. Leave blank to use the active page title. |
The component cannot hold a ref.
Slot name | Class name | Default component | Description |
---|---|---|---|
toolbar | PageHeaderToolbar | The 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.