Package org.patternfly.component.page

package org.patternfly.component.page

Provides the PatternFly page layout component and its subcomponents.

The page component provides the overall structure for an application, including a masthead with branding and tools, a sidebar for navigation, and a main content area with sections. It includes support for the masthead, sidebar, page sections, breadcrumbs, navigation, tabs, and groups.

Key Classes

• Display - Enumeration of page section display modes (inline, stack)
• Masthead - Application header with branding, navigation toggle, and tools
• MastheadBrand - Brand area within the masthead
• MastheadContent - Content area for header tools in the masthead
• MastheadLogo - Logo link within the masthead brand
• MastheadMain - Main area of the masthead containing toggle and brand
• MastheadToggle - Navigation sidebar toggle button in the masthead
• Page - Top-level page layout container
• PageBreadcrumb - Breadcrumb section within a page
• PageGroup - Group of page sections
• PageMain - Main content area of the page
• PageNavigation - Navigation section within a page
• PageSection - Content section within the page main area
• PageSidebar - Sidebar container for vertical navigation
• PageSidebarBody - Body content within the page sidebar
• PageTabs - Tabs section within a page
• PageWizard - Wizard section within a page

Usage

import static org.patternfly.component.page.Masthead.masthead;
import static org.patternfly.component.page.MastheadBrand.mastheadBrand;
import static org.patternfly.component.page.MastheadContent.mastheadContent;
import static org.patternfly.component.page.MastheadLogo.mastheadLogo;
import static org.patternfly.component.page.MastheadMain.mastheadMain;
import static org.patternfly.component.page.MastheadToggle.mastheadToggle;
import static org.patternfly.component.page.Page.page;
import static org.patternfly.component.page.PageMain.pageMain;
import static org.patternfly.component.page.PageSection.pageSection;
import static org.patternfly.component.page.PageSidebar.pageSidebar;
import static org.patternfly.component.page.PageSidebarBody.pageSidebarBody;

Page page = page()
        .addMasthead(masthead()
                .addMain(mastheadMain()
                        .addToggle(mastheadToggle())
                        .addBrand(mastheadBrand()
                                .addLogo(mastheadLogo("#")
                                        .add("Logo"))))
                .addContent(mastheadContent().text("Header tools")))
        .addSidebar(pageSidebar()
                .addBody(pageSidebarBody()
                        .add("Navigation")))
        .addMain(pageMain("main-id")
                .addSection(pageSection()
                        .text("Section 1"))
                .addSection(pageSection().secondary()
                        .text("Section 2")));

See Also:

• https://www.patternfly.org/components/page

Related Packages

Package	Description
org.patternfly.component	Provides PatternFly component implementations for building web applications in Java.

Class	Description
Display	Defines the display layout for Masthead content: inline or stacked.
Masthead	A masthead contains global properties such as logotype, navigation and settings in an organized fashion, and it is accessible from all parts of the application.
MastheadBrand	A brand section within a masthead within a Masthead component.
MastheadContent	Container for the content of a Masthead component.
MastheadLogo	A logo within a masthead within a Masthead component.
MastheadMain	Container for the main area of a Masthead component.
MastheadToggle	Container for the toggle of a Masthead component.
Page	The page component is used to define the basic layout of a page with either vertical or horizontal navigation.
PageBreadcrumb	Container to nest a Breadcrumb in a PageGroup or PageMain container.
PageGroup	Container to group multiple PageSectionLike containers.
PageMain	Container for the main page area.
PageNavigation	Container to nest a Navigation in a PageGroup or PageMain container.
PageSection	Container for a section in a PageGroup or PageMain component.
PageSectionBuilder<E extends HTMLElement, P extends PageSectionBuilder<E,P>>	Groups common methods/modifiers for page sections like PageBreadcrumb and PageSection.
PageSectionLike<E extends HTMLElement, P extends PageSectionLike<E,P>>	Common interface for page sections like PageBreadcrumb and PageSection.
PageSidebar	Container for the page sidebar.
PageSidebarBody	Container within the PageSidebar to hold content.
PageTabs	Container to nest a Tabs component in a PageGroup or PageMain container.
PageWizard	Container to nest a Wizard in a PageGroup or PageMain container.