@patternfly/patternfly

--- id: Popover section: components cssPrefix: pf-c-popover --- ## Examples ### Top ```html <div class="pf-c-popover pf-m-top" role="dialog" aria-modal="true" aria-labelledby="popover-top-header" aria-describedby="popover-top-body"> <div class="pf-c-popover__arrow"></div> <div class="pf-c-popover__content"> <button class="pf-c-button pf-m-plain" type="button" aria-label="Close"> <i class="fas fa-times" aria-hidden="true"></i> </button> <h1 class="pf-c-title pf-m-md" id="popover-top-header">Popover header</h1> <div class="pf-c-popover__body" id="popover-top-body">Popovers are triggered by click rather than hover. Click again to close.</div> <footer class="pf-c-popover__footer">Popover footer</footer> </div> </div> ``` ### Right ```html <div class="pf-c-popover pf-m-right" role="dialog" aria-modal="true" aria-labelledby="popover-right-header" aria-describedby="popover-right-body"> <div class="pf-c-popover__arrow"></div> <div class="pf-c-popover__content"> <button class="pf-c-button pf-m-plain" type="button" aria-label="Close"> <i class="fas fa-times" aria-hidden="true"></i> </button> <h1 class="pf-c-title pf-m-md" id="popover-right-header">Popover header</h1> <div class="pf-c-popover__body" id="popover-right-body">Popovers are triggered by click rather than hover. Click again to close.</div> <footer class="pf-c-popover__footer">Popover footer</footer> </div> </div> ``` ### Bottom ```html <div class="pf-c-popover pf-m-bottom" role="dialog" aria-modal="true" aria-labelledby="popover-bottom-header" aria-describedby="popover-bottom-body"> <div class="pf-c-popover__arrow"></div> <div class="pf-c-popover__content"> <button class="pf-c-button pf-m-plain" type="button" aria-label="Close"> <i class="fas fa-times" aria-hidden="true"></i> </button> <h1 class="pf-c-title pf-m-md" id="popover-bottom-header">Popover header</h1> <div class="pf-c-popover__body" id="popover-bottom-body">Popovers are triggered by click rather than hover. Click again to close.</div> <footer class="pf-c-popover__footer">Popover footer</footer> </div> </div> ``` ### Left ```html <div class="pf-c-popover pf-m-left" role="dialog" aria-modal="true" aria-labelledby="popover-left-header" aria-describedby="popover-left-body"> <div class="pf-c-popover__arrow"></div> <div class="pf-c-popover__content"> <button class="pf-c-button pf-m-plain" type="button" aria-label="Close"> <i class="fas fa-times" aria-hidden="true"></i> </button> <h1 class="pf-c-title pf-m-md" id="popover-left-header">Popover header</h1> <div class="pf-c-popover__body" id="popover-left-body">Popovers are triggered by click rather than hover. Click again to close.</div> <footer class="pf-c-popover__footer">Popover footer</footer> </div> </div> ``` ### Without header/footer ```html <div class="pf-c-popover pf-m-right" role="dialog" aria-modal="true" aria-label="Popover with no header example" aria-describedby="popover-no-header-body"> <div class="pf-c-popover__arrow"></div> <div class="pf-c-popover__content"> <button class="pf-c-button pf-m-plain" type="button" aria-label="Close"> <i class="fas fa-times" aria-hidden="true"></i> </button> <div class="pf-c-popover__body" id="popover-no-header-body">Popovers are triggered by click rather than hover. Click again to close.</div> </div> </div> ``` ## Documentation ### Overview A popover is used to provide contextual information for another component on click. The popover itself is made up of two main elements: arrow and content. The content element follows the pattern of the popover box component, with a close icon in the top right corner, as well as a header and body. One of the directional modifiers (`.pf-m-left`, `.pf-m-top`, etc.) is required on the popover component ### Accessibility | Attribute | Applies to | Outcome | | ----------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `role="dialog"` | `.pf-c-popover` | Identifies the element that serves as the popover container. **Required** | | `aria-labelledby="[id value of .pf-c-title]"` | `.pf-c-popover` | Gives the popover an accessible name by referring to the element that provides the dialog title. **Required when .pf-c-title is present** | | `aria-label="[title of popover]"` | `.pf-c-popover` | Gives the popover an accessible name. **Required when .pf-c-title is _not_ present** | | `aria-describedby="[id value of applicable content]"` | `.pf-c-popover` | Gives the popover an accessible description by referring to the popover content that describes the primary message or purpose of the dialog. Not used if there is no static text that describes the popover. | | `aria-modal="true"` | `.pf-c-popover` | Tells assistive technologies that the windows underneath the current popover are not available for interaction. **Required** | | `aria-label="Close"` | `.pf-c-button` | Provides an accessible name for the close button as it uses an icon instead of text. **Required** | | `aria-hidden="true"` | Parent element containing the page contents when the popover is open. | Hides main contents of the page from screen readers. The element with `.pf-c-popover` must not be a descendent of the element with `aria-hidden="true"`. For more info see [trapping focus](/accessibility-guide#trapping-focus). **Required** | ### Usage | Class | Applied to | Outcome | | ------------------------ | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `.pf-c-popover` | `<div>` | Creates a popover. Always use it with a modifier class that positions the popover relative to the element that triggered it. **Required** | | `.pf-c-popover__arrow` | `<div>` | Creates an arrow pointing towards the element the popover describes. **Required** | | `.pf-c-popover__content` | `<div>` | Creates the content area of the popover. **Required** | | `.pf-c-button` | `<button>` | Positions the close icon in the top-right corner of the popover. **Required** | | `.pf-c-title` | `<h1>`,`<h2>`,`<h3>`,`<h4>`,`<h5>`,`<h6>` | Initiates a title. Always use it with a modifier class. See [title component](/documentation/core/components/title) for more info. | | `.pf-c-popover__body` | `<div>` | The popover's body text. **Required** | | `.pf-c-popover__footer` | `<footer>` | Initiates a popover footer. | | `.pf-m-left` | `.pf-c-popover` | Positions the popover to the left of the element. | | `.pf-m-right` | `.pf-c-popover` | Positions the popover to the right of the element. | | `.pf-m-top` | `.pf-c-popover` | Positions the popover to the top of the element. | | `.pf-m-bottom` | `.pf-c-popover` | Positions the popover to the bottom of the element. |