| additionalGroupedContent | React.ReactNode | | Additional content of the group |
| breadcrumb | React.ReactNode | | Breadcrumb component for the page |
| breadcrumbProps | PageBreadcrumbProps | | Additional props of the breadcrumb |
| children | React.ReactNode | | Content rendered inside the main section of the page layout (e.g. <PageSection />) |
| className | string | | Additional classes added to the page layout |
| defaultManagedSidebarIsOpen | boolean | true | If true, the managed sidebar is initially open for desktop view |
| getBreakpoint | (width: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | getBreakpoint | The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class
You can override the default getBreakpoint function to return breakpoints at different sizes than the default
You can view the default getBreakpoint function here:
https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/helpers/util.ts |
| getVerticalBreakpoint | (height: number | null) => 'default' | 'sm' | 'md' | 'lg' | 'xl' | '2xl' | getVerticalBreakpoint | The page resize observer uses the breakpoints returned from this function when adding the pf-m-breakpoint-[default|sm|md|lg|xl|2xl] class
You can override the default getVerticalBreakpoint function to return breakpoints at different sizes than the default
You can view the default getVerticalBreakpoint function here:
https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/helpers/util.ts |
| groupProps | PageGroupProps | | Additional props of the group |
| header | React.ReactNode | | Header component (e.g. <PageHeader />) |
| isBreadcrumbGrouped | boolean | | Flag indicating if the breadcrumb should be in a group |
| isBreadcrumbWidthLimited | boolean | false | Flag indicating if breadcrumb width should be limited |
| isManagedSidebar | boolean | false | If true, manages the sidebar open/close state and there is no need to pass the isNavOpen boolean into
the sidebar component or add a callback onNavToggle function into the PageHeader component |
| isNotificationDrawerExpanded | boolean | false | Flag indicating Notification drawer in expanded |
| isTertiaryNavGrouped | boolean | | Flag indicating if the tertiaryNav should be in a group |
| isTertiaryNavWidthLimited | boolean | | Flag indicating if tertiary nav width should be limited |
| mainAriaLabel | string | | Accessible label, can be used to name main section |
| mainContainerId | string | | an id to use for the [role="main"] element |
| mainTabIndex | number | null | -1 | tabIndex to use for the [role="main"] element, null to unset it |
| notificationDrawer | React.ReactNode | | Notification drawer component for an optional notification drawer (e.g. <NotificationDrawer />) |
| onNotificationDrawerExpand | () => void | () => null | Callback when notification drawer panel is finished expanding. |
| onPageResize | ((object: any) => void) | null | (): void => null | Can add callback to be notified when resize occurs, for example to set the sidebar isNav prop to false for a width < 768px
Returns object { mobileView: boolean, windowSize: number } |
| role | string | | Sets the value for role on the <main> element |
| sidebar | React.ReactNode | | Sidebar component for a side nav (e.g. <PageSidebar />) |
| skipToContent | React.ReactElement | | Skip to content component for the page |
| tertiaryNav | React.ReactNode | | Tertiary nav component for the page |
