Intro
The Info Popover component provides additional information for an individual UI element at a glance, without disrupting the user's workflow.
When to Use
Use the Info Popover:
- To provide additional information for an individual UI element, at a glance, without disrupting the user's workflow or having them leave the page.
- To provide additional context only when the user needs it (progressive disclosure).
- To clarify something to the user, but you don’t have enough space in the UI.
- To show UI elements not available in quick view.
Don’t use the Info Popover:
- For actionable tasks such as confirming a successful action, confirming a deletion, etc.
- To hide essential information within info popovers.
- When the quick view is more appropriate for your use case
- When the objects are in the list in a list-detail layout (ie. the information will be in the details).
- When the UI is self-evident and does not need additional descriptions.
- If there are already a lot of icon popovers in your UI. Don’t overuse info popovers and instead see if its UX can be improved to mitigate usage of info popovers.
Top Tips
- When the content exceeds the max height of the popover, the content should be truncated and scroll should be initiated.
- The popover should be opened via clicking the icon button. It is recommended to avoid interaction methods such as hover to improve accessibility.
Anatomy
- Icon Control: Opens the popover on click. The component used for the Info Popover is a clickable Icon Control. The target area of the icon control is 16x16px.
- Text: The text within an info popover should be 1-2 sentences long. For situations with longer text, refer to the documentation here. The component used for the Info Popover is a Text Control. As the content of the text is long and continuous, the line height should use the variable: --sapContent_LineHeight (1.5rem).
- Popover: The popover component contains the help text for the info popover. The height of the popover will adjust to the length of the text. The spacing between popover control and icon control (including icon padding) is 0rem. The component used for the Info Popover is a Popover.
Info Popover - Anatomy
Position
The position of the popover respective to the icon control should follow the same pattern as the Popover component. The default popover position is to the right of the object it is related to. If development sets the placement type to ‘Auto’, it will automatically decide the placement based on the location of the related object and available space on the screen.
Info Popover - Positions
Placement
Do
Info Popovers are placed beside a sentence of block of text. These cases include:
- Beside input labels (after the colon and asterisk)
- Beside headers
- Beside checkboxes
- Beside radio button group labels
Don't
Don't place Info Popovers:
- Beside input fields (they should be beside the input field labels)
- Beside individual radio buttons (keyboard navigation is not feasible)
- Within menus
Beside Input Labels
Info Popover beside Input Label
Beside Headers
Info Popover beside Header
Beside Checkboxes
Info Popover beside Checkboxes
Beside Radio Button Group Label
Radio Buttons already have special keyboard handling where a tab chain exists for all radio buttons within a group. The radio button group does not distinguish between focus and selection making it impossible to have an ‘inner’ focus on the info icon.
To address this issue, the solution we have for using icon popovers for radio button groups is to have one single icon popover dedicated to the entire radio button group. Within this popover, information for each of the radio buttons are provided. This is one of the few exceptions the popover text length will exceed 1-2 sentences. The popover height will automatically adjust to the length of the popover text. An example of this solution is shown below:
Info Popover beside Radio Button Group Header
Behavior and Interaction
Opening an Info Popover
The user opens a popover by hovering over the Info Popover icon. Refer to the accessibility specs to see keyboard navigation patterns for the Info Popover.
Opening an Info Popover
Closing an Info Popover
The popover is closed when the user’s mouse leaves the icon target area. Refer to the accessibility specs to see keyboard navigation patterns for the Info Popover.
Closing an Info Popover
UI Text Recommendations
Do
- Text in info popovers should be limited to 1-2 sentences; keep it concise! If longer, a more appropriate component should be used such as Message Box or Quick View Cards.
- Use people-centric language; avoid jargon.
Don't
- Write long paragraphs filled with complex language.
- Repeat text that can be referred to larger documentation.
Exceptional Cases
Info Popovers within Menus
Avoid using info popovers within menus. However, if necessary, use Custom List Items (‹ui5-li-custom›) instead of standard menu items when placing info popovers within menus. This ensures the Info Icon can be navigated to via keyboard. When using the custom list item component in UI5, developers would need to add a ‘tooltip’ property for the list item to create an info popover. To reference keyboard navigation for icon popovers within menus, refer to the documentation.
Menu with Custom List Item
- ‹ui5-menu›: See docs.
- ‹ui5-li-item›: The custom list item component should be nested in within the menu component for menu items that require an info popover. A ‘tooltip’ property should be turned on when adding an info popover to a menu item. See docs.
- ‹ui5-popover›: See docs.
- ‹ui5-icon›: See docs.
Info Popovers within Menus using Custom List Items
Resizing Behaviour
It is recommended to have messages that are 1-2 sentences long within info popovers. However, in situations that may need longer messages, providing the user ways to resize the popover is recommended. Resizing behaviour allows popovers to be made smaller to show more of the screen content or larger to view the entire popover message.
- Scroll Bar: If the popover content is too large to fit within the default dimensions of the info popover, a scroll bar will appear for the user to scroll through the entire popover content.
- Truncation: Truncation indicates to the user that there is more content in the popover that can only be viewed if the user resizes the popover or scrolls down.
- Resize Handle: After a certain breakpoint (height: 25rem), a resize handle should appear. The resize handle consists of the icon resize-corner which indicates to the user they can drag the popover to resize the popover. For documentation on the resize handle placement, refer to the documentation here.
Resize Handle for Info Popovers
Footer Actions
Info popovers are recommended to only contain simple text messages. However, there are info popovers that exist that use footer actions. These footer actions are used in situations where the info popover provides a brief summary of an object and the footer action may include a button that directs the user to the object itself for more context.
- Footer: The footer section of the info popover is used if there is a need to contain an action within the info popover.
- Footer Action: The footer action comes in the form of a Button component usually that directs the user to a more elaborate version of the info popover’s content. Refer to the Fiori guidelines more information.
Info Popover with Footer Actions
Localization
The Info Popover should be mirrored for RTL languages. This includes the way the text within the popover is written along with the arrow position and where the popover is displayed respective to the icon control.