PageContainer API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

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

Props of the native component are also available.

Name	Type	Description
breadcrumbs	Array<{ path: string, title: string }>	The breadcrumbs of the page. Leave blank to use the active page breadcrumbs.
slotProps	{ header: { breadcrumbs?: Array<{ path: string, title: string }>, slotProps?: { toolbar: object }, slots?: { toolbar?: elementType }, title?: string } }	The props used for each slot inside.
slots	{ header?: elementType }	The components used for each slot inside. See Slots API below for more details.
sx	Array<func \| object \| bool> \| func \| object	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page 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
header		`PageHeader`	The component that renders the page header.

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.	disableGutters	Styles applied to the root element if `disableGutters={true}`.
.	fixed	Styles applied to the root element if `fixed={true}`.
.	maxWidthLg	Styles applied to the root element if `maxWidth="lg"`.
.	maxWidthMd	Styles applied to the root element if `maxWidth="md"`.
.	maxWidthSm	Styles applied to the root element if `maxWidth="sm"`.
.	maxWidthXl	Styles applied to the root element if `maxWidth="xl"`.
.	maxWidthXs	Styles applied to the root element if `maxWidth="xs"`.
.	root	Styles applied to the root element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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