@toolpad/core
Version:
Dashboard framework powered by Material UI.
47 lines • 1.23 kB
TypeScript
import * as React from 'react';
import { PageHeaderToolbarProps } from "./PageHeaderToolbar.js";
import type { Breadcrumb } from './PageContainer';
export interface PageHeaderSlotProps {
toolbar: PageHeaderToolbarProps;
}
export interface PageHeaderSlots {
/**
* The component that renders the actions toolbar.
* @default PageHeaderToolbar
*/
toolbar: React.ElementType;
}
export interface PageHeaderProps {
/**
* The title of the page. Leave blank to use the active page title.
*/
title?: string;
/**
* The breadcrumbs of the page. Leave blank to use the active page breadcrumbs.
*/
breadcrumbs?: Breadcrumb[];
/**
* The components used for each slot inside.
*/
slots?: PageHeaderSlots;
/**
* The props used for each slot inside.
*/
slotProps?: PageHeaderSlotProps;
}
/**
* A header component to provide a title and breadcrumbs for your pages.
*
* Demos:
*
* - [Page Container](https://mui.com/toolpad/core/react-page-container/)
*
* API:
*
* - [PageHeader API](https://mui.com/toolpad/core/api/page-header)
*/
declare function PageHeader(props: PageHeaderProps): React.JSX.Element;
declare namespace PageHeader {
var propTypes: any;
}
export { PageHeader };