Compass

Info alert:Beta feature

This beta component is currently under review and is still open for further evolution. It is available for use in product. Beta components are considered for promotion on a quarterly basis. Please join in and give us your feedback or submit any questions on the PatternFly forum or via Slack. To learn more about the process, visit our about page or our Beta components page on GitHub.

Examples

Basic

In a basic compass layout, content can be passed to the following props to populate areas of the page:

  • header: content rendered in the top of the page. This will typically be a CompassHeader component to break the header into 3 areas consisting of a logo or brand, middle navigation, and profile.
  • sidebarStart: content rendered in the left side or start side of the page
  • main: content rendered in the center of the page. This will typically consist of a CompassMainHeader or CompassHero, along with a CompassContent filled with one or more CompassPanel components.
  • sidebarEnd: content rendered in the right side or end side of the page
  • footer: content rendered in the bottom of the page

The background image of the Compass and CompassHero may be customized by using their respective backgroundSrcLight and backgroundSrcDark props. The CompassHero also allows customization of a color gradient across its container by using the gradientLight and gradientDark props.

Nav
Profile
Sidebar start
Hero
Content title
Content
Sidebar end

Demo

Demo screenshot

Props

Compass

*required
NameTypeDefaultDescription
isFooterExpandedNo type infotrue
isHeaderExpandedNo type infotrue
isSidebarEndExpandedNo type infotrue
isSidebarStartExpandedNo type infotrue

CompassHeader

*required
NameTypeDefaultDescription

CompassContent

*required
NameTypeDefaultDescription

CompassHero

*required
NameTypeDefaultDescription

CompassMainHeader

*required
NameTypeDefaultDescription

CompassPanel

*required
NameTypeDefaultDescription

CSS variables

Expand or collapse columnSelectorVariableValue