This guideline now covers both SAPUI5 and SAP Web Components. Learn more.
Information
Icon
false

Intro

The popover is a small overlay window that appears on top of an existing UI element. It displays additional information for an object in a compact way and without leaving the page. The popover can contain various UI elements such as fields, tables, images, and charts. It can also include actions in the footer.

Popover showing a small newsletter subscription form with an email field and a Subscribe button.

Popover

Component availability

This component is available in the following libraries:

<div> <div data-valign="middle">Library</div> <div data-valign="middle">Technical Name</div> <div data-valign="middle">Identifier</div> </div> <div> <div data-valign="middle">SAPUI5 Demo Kit</div> <div><a href="https%3A%2F%2Fui5.sap.com%2F%23%2Fentity%2Fsap.m.Popover">sap.m.Popover</a></div> <div data-valign="middle">:badge, info, large, _, SAPUI5:</div> </div> <div> <div data-valign="middle">SAP Web Components</div> <div data-valign="middle"><a href="https%3A%2F%2Fui5.github.io%2Fwebcomponents%2Fcomponents%2FPopover%2F">ui5-popover</a></div> <div data-valign="middle">:badge, info, large, _, SAP Web Components:</div> </div> <div> <div data-valign="middle">SAP Web UI Kit (Figma)</div> <div data-valign="middle"><a href="https%3A%2F%2Fwww.figma.com%2Fdesign%2FSILcWzK5uFghKun9jx6D7c%2FSAP-Web-UI-Kit%3Fnode-id%3D153790-1130">Popover</a></div> <div data-valign="middle">:badge, info, large, _, Figma:</div> </div>
<div> <div data-valign="middle">Library</div> <div data-valign="middle">Technical Name</div> <div data-valign="middle">Identifier</div> </div> <div> <div data-valign="middle">SAPUI5 Demo Kit</div> <div><a href="https%3A%2F%2Fui5.sap.com%2F%23%2Fentity%2Fsap.m.Popover">sap.m.Popover</a></div> <div data-valign="middle">:badge, info, large, _, SAPUI5:</div> </div> <div> <div data-valign="middle">SAP Web Components</div> <div data-valign="middle"><a href="https%3A%2F%2Fui5.github.io%2Fwebcomponents%2Fcomponents%2FPopover%2F">ui5-popover</a></div> <div data-valign="middle">:badge, info, large, _, SAP Web Components:</div> </div> <div> <div data-valign="middle">SAP Fiori for Web UI Kit (Figma)</div> <div data-valign="middle"><a href="https%3A%2F%2Fwww.figma.com%2Fcommunity%2Ffile%2F1494295794601744471%2Fsap-fiori-for-web-ui-kit">Popover</a></div> <div data-valign="middle">:badge, info, large, _, Figma:</div> </div>

When to Use

2
do
false

Use the popover to:

  • Define a custom structure when the quick view component does not meet the requirements.
  • Show UI elements that are not supported by the quick view component.
  • Display lightweight, contextual content.
  • Show details for a list item, contact information, or a short preview without leaving the current view.
  • Let users stay in context while viewing or editing related information.
  • Present content that is directly related to a specific UI element.
  • Provide quick, non-disruptive actions without navigating away.
dont
false

Don’t use a popover to:

  • Display content that is better suited for a quick view component.
  • Display object details in a list-detail layout (these details belong in the dedicated details area).
  • Display content that requires full user focus or involves complex interaction.
  • Interrupt the user's flow by requiring explicit input or confirmation. Instead, use a dialog.
  • Create modal behavior where the background is not interactive. Instead, use a dialog.
  • Provide information that is not directly related to a specific UI element.
  • Present content that takes up more than one-third of the phone screen. Use a responsive popover instead.
  • Show large or scroll-heavy content.
  • Include a header or footer when the popover needs a title or action. Leave them out if the content is clarified by the context provided by the triggering element, is clear on its own, or doesn't require any action.
  • Place the popover directly beside its trigger element, keeping the trigger visible so the relationship is obvious.
  • Ensure the popover can be dismissed based on your scenario: by clicking outside of it, re-clicking its trigger, or by selecting an action within it, and make sure user focus returns to the trigger element afterward.
  • Use popovers for navigation flows when showing nested details.
  • Consider using responsive popovers for larger screens where full-screen display and touch interactions are supported.

Anatomy

  1. Header (optional): Contains a title and a back button when navigation is available.
  2. Content area: Can contain any component.
  3. Resize handle (optional): The resize handle is visible when the popover is resizable.
  4. Footer (optional): Contains one or more actions.
  5. Arrow (optional): Visually connects the popover to its trigger element.

Anatomy of popover with numbered pointers referencing the header, content area, resize handle, footer, and an arrow.

Anatomy of a popover

information
You can define a fixed height for the popover. If the content exceeds that height, a scrollbar appears automatically.

Types

The popover can include a header, a footer, or both. A header and footer are useful if you need to contextualize the information with a title or add any actions to the footer (A). In contrast, a popover without a header or footer is ideal for simple content that is already clarified by the surrounding context provided by the triggering element, is inherently clear, and doesn't require a title or additional actions (B).

Examples of popovers with header and footer (A) and without either (B).

Examples of popovers with a header and footer, and without either

Popover with a custom header

A popover with a custom header is useful when the standard header doesn't meet specific application requirements. You can place any component inside a custom header, such as adding an alternative way to dismiss the popover using a Close button at the end of the header (A). Additionally, you can use a header that provides back navigation to a previous page. In this scenario, you might also include options for additional actions at the end of the header (B).

Examples of popover with custom header including close button (A) and back navigation (B).

Examples of a popover with custom headers

Popover with a subheader

The popover can include an additional subheader that may contain any component (A). It is also possible to use the popover without a main header, having only the subheader instead (B).

Two popovers shown side by side: one with both a header and a subheader (A), and one with only a subheader and no main header (B).

Popover with both a header and a subheader, and another with only a subheader

States

The popover doesn’t have its own states. When the popover opens, focus moves to the first interactive element within it. Initial focus can be configured to land on a specific element.

Focus State

The focus state determines which component receives the user input when using an input device, for example, a keyboard.

A. Focus state: Appears with a visible outline around the interactive element, for example, a button.

B. Unfocused state: Applies to all elements that are not focused.

Popover showing focused and unfocused buttons, with one button highlighted by a visible focus outline (A) and another shown without focus (B).

A popover with both focused and unfocused buttons

For more information, see Focus States.

Behavior and Interaction

Opening a popover

A popover opens when users click the element that triggers it, such as a link or button. The popover then positions itself next to the trigger element, ensuring the trigger element remains visible and accessible. This behavior is typically designed to maintain context for the user, allowing users to still see that element and click it again if needed.

Hovering over the trigger element displays the hover state before opening the popover (A). Clicking the trigger opens the popover (B).

Sequence showing hover state on an Open Popover button with a cursor over it (A) and a popover opening on click (B) to the right.

Opening a popover when clicking a button

Closing a popover

The popover can be dismissed as follows: by clicking outside its boundaries (A), by clicking the trigger element again (B), or by selecting an action within the popover (C). When the popover closes, focus returns to its trigger element.

Sequence showing closing popover by clicking outside (A), on Open Popover button (B), and on Cancel button (C).

Closing a popover by clicking outside of it, on the trigger element, or by clicking a “Cancel” button

The popover supports a navigation flow when additional details or nested content are needed for a selected item.

Clicking the trigger element (A) opens the popover as an overlay (B), displaying the content within while keeping the trigger visible.

Sequence showing clicking on Open Popover button (A), opening a popover and selecting an item to show details (B).

Opening a popover and selecting an item

The selected item (B) reveals its detailed view (C) with a back arrow button in the header. The content area provides contextually relevant information. Clicking on the back arrow (C) returns to the full list view (D), allowing users to select a different item.

Sequence showing clicking the back arrow in popover details header (C) and returning to list view (D).

Clicking on the back arrow button, the popover displays the full list again

Resizing a popover :badge, info, large, _, SAPUI5 only:

A popover can be resizable, depending on the implementation. When resizing is enabled, a handle, such as one in the bottom-right corner, appears, allowing the user to drag and adjust the popover’s dimensions.

Sequence showing how a popover (A) can be resized by dragging an arrow in the bottom right corner (B) and then releasing it (C) to take in its new form.

Resizing a popover

Responsiveness

The popover behaves differently on mobile phones than on tablet and desktop devices.

Desktop and tablet devices: Opens as a standard-sized popover.
Mobile phones: Opens as a full-screen dialog. This behavior applies to both portrait and landscape orientations.
Touch devices: Touch interactions work similarly to mouse interactions: tap gestures open and close the popover, while drag gestures resize it.

Responsive popover on a mobile device – appears as a full-screen dialog with a header title at the top, a close button in the top right, a scrollable content area, and two action buttons at the bottom.

Responsive popover on a mobile phone

Accessibility

SAP follows international standards, such as WCAG and WAI-ARIA, and strives to make our business solutions accessible and inclusive.

For more information, see Accessibility in SAP Fiori and the Accessibility Design Tools Handbook.

Keyboard Navigation

The following keyboard combinations are supported by the SAPUI5 Popover component.

<div> <div>Key Combination</div> <div>What It Does</div> </div> <div> <div><strong>Tab</strong></div> <div>Navigates inside the popup. If the focus is on the last active element, it moves to the first one, staying inside the popup.</div> </div> <div> <div><strong>Shift + Tab</strong></div> <div>Backward navigation.</div> </div> <div> <div><strong>Escape</strong></div> <div> <p>Cancels and closes the Dialog.</p> <p>By default, the focus goes to the <strong>Cancel</strong> button, if available.</p> </div> </div>

Screen Reader Support

For additional details on screen reader support and Accessible Rich Internet Applications (ARIA), see UI5 Screen Reader Support and WAI-ARIA Authoring.

Content

Localization

Popover supports both left-to-right (LTR) and right-to-left (RTL) reading directions. The layout automatically mirrors to match the language direction.

Popover in a left-to-right (LTR) layout with left aligned text and elements, and OK and Cancel buttons in the bottom right corner of the footer.

Left-to-right text directions

Popover in a right-to-left (RTL) layout with right aligned text and elements, and OK and Cancel buttons in the bottom left corner of the footer.

Right-to-left text directions

Features

Placement

A popover can appear without an arrow (A) or with an arrow (pointing left, right, top, or bottom) to visually connect to the trigger element (B).

Popover without an arrow (A) compared to a popover with directional arrows (B) (pointing left, right, top and bottom) to visually connect to a trigger element like Open Popover.

Arrow placement options

Resize handle positioning

The resize handle is always positioned on the opposite side of the arrow to maintain usability and prevent visual interference. When the arrow is centered on any side of the popover, the handle appears in the opposite corner. The exact placement (up/down or left/right) depends on the initial position of the arrow, ensuring optimal interaction space and clear visual separation between the arrow and the resize handle.

Popover examples with the arrow positioned on the left (A) and on the top (B), with a resize handle in the bottom right corner.

The arrow is positioned at the left (A) and top (B), with the resize handle appearing on the opposite side

Modal behavior determines whether clicking outside the popover closes it or leaves it open. If modal behavior is disabled, clicking anywhere outside the popover automatically closes it. If enabled, outside clicks are ignored, and the popover remains open. In this case, it can only be dismissed via an available action within the popover or by activating a trigger element, such as a button or link.

Framework Comparison

Some behaviors differ between frameworks due to implementation specifics. The table below summarizes the differences between SAPUI5 and SAP Web Components and lists the framework-specific patterns.

<div> <div>Feature</div> <div>SAPUI5</div> <div>SAP Web Components</div> </div> <div> <div>A popover can be made resizable by displaying a handle in the bottom-right corner, allowing its dimensions to be adjusted dynamically. For more information, see <a href="https%3A%2F%2Fwww.sap.com%2Fdesign-system%2Ffiori-design-web%2Fui-elements%2Fpopover%2F%23resizing-a-popover-badge-info-large-_-sapui5-only">Resizing a popover</a>.</div> <div>Available</div> <div>Not available</div> </div>

[internal_only]To request this feature for SAP Web Components, submit an InnerSource request.[/internal_only]

Guidelines

Components
Quick View

Implementation

SAPUI5
Popover (samples)
Responsive Popover (samples)

SAP Web Components
Popover

Specifications

Popover (visual design)

SAP Web UI Kit

Popover

Guidelines

Components
Quick View

Implementation

SAPUI5
Popover (samples)
Responsive Popover (samples)

SAP Web Components
Popover

UI Kit (Figma)

SAP Fiori for Web UI Kit / Popover