Skip to content

PageContainer API

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

Demos

Import

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

Learn about the difference by reading this guide on minimizing bundle size.



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

Props

Props of the native component are also available.

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
toolbarSnackbarThe component that renders the actions toolbar.

CSS classes

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

Class nameRule nameDescription
.disableGuttersStyles applied to the root element if disableGutters={true}.
.fixedStyles applied to the root element if fixed={true}.
.maxWidthLgStyles applied to the root element if maxWidth="lg".
.maxWidthMdStyles applied to the root element if maxWidth="md".
.maxWidthSmStyles applied to the root element if maxWidth="sm".
.maxWidthXlStyles applied to the root element if maxWidth="xl".
.maxWidthXsStyles applied to the root element if maxWidth="xs".
.rootStyles applied to the root element.

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

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.