Updated: March 17, 2021

Message Popover

sap.m.messagePopover

Intro

The message popover (sap.m.MessagePopover) control can handle multiple messages within SAP Fiori. In combination with a message manager, it automatically displays messages that occur after validation points.

With the message concept, we provide a way to centrally manage messages and show them to the user without additional work for the developer.

Message popover
Message popover

Usage

Use the message popover if:

  • You want to display multiple messages to the user.
  • You do not want to interrupt users while they are performing an action.

Responsiveness

Size S (Smartphone)

On smartphones, the message popover is automatically shown in full-screen mode.

Full screen message popover on a smartphone
Full screen message popover on a smartphone

Layout

Filtering

Initial state

Initially, the filter bar shows all the different types of messages found in the message popover.

General filter

Segmented buttons at the top of the message popover allow the user to filter the messages by type (error, warning, success and information), allowing the user to focus on the messages he or she is interested in.

Filter on top of message popover
Filter on top of message popover

List

Short description

The short message text provides a simple and helpful short message. It’s the same message as the one attached on the UI control where the issue occurred.

Subtitle

The subtitle provides the chance to give your message an identifier. We recommend that you add the label of the field where the error occurred. Based on the subtitle, the user should be able to identify the corresponding UI control on the UI (for example, the input field in a form).

Navigation to second page

In case there is a long text available, the message popover automatically provides a “chevron” on the right side so that the user is able to navigate to the second page of the message popover, where he or she can read the long text of the message.

Messaging button in full screen layout
Messaging button in full screen layout

Aggregating Messages

If the application development team wants to aggregate messages, they have the chance to fill the counter property of each list item. The app team will have to implement this aggregation on their own as the message popover just provides the counter property.

Messaging button in full screen layout
Messaging button in full screen layout

Detail Page of Message Popover

Segmented buttons at the top of the message popover allow the user to filter the messages by type (error, warning, success and information), allowing the user to focus on the messages he or she is interested in.

Messaging button in full screen layout
Messaging button in full screen layout

Messaging Button

If there are no messages to display, you do not need to show a messaging button. The toolbar then only includes the “normal” actions related to the object.

If there are messages to display, the messaging button must look like the example shown in the figure on the right.

Messaging button in toolbar
Messaging button in toolbar

How to Display the Message Popover

An overview of the different steps needed to display the message popover is provided below. For further information, see message handling.

Behavior and Interaction

When Should the Message Popover Open?

Activation actions

If the user clicks or taps on an activating action (such as Create, Save, or Submit), the message popover should open automatically to inform the user about the active errors on the UI. The message popover provides the user with an overview of the error messages.

Form field validation

If an error occurs (for example, after validating an input field), the message button appears with the number of messages inside. The message popover does not open automatically.

Detailed view
Detailed view

Navigation to the Second Page of the Message Popover

If the message provides a long text from the back-end system, the user is able to navigate to a second page within the message popover. There, the user will typically find more information and helpful message text.

Navigation to second page of the message popover
Navigation to second page of the message popover

Navigation to the Relevant Field

Add a navigation link to direct users to the field on the UI that triggered the message. This can be a field in the visible area, a field somewhere else on the same page, or a field on another tab or screen.

For more information about the navigation, see Navigating to the Corresponding Field on the UI in the Message Handling article.

Developer Hint
Set the navigation link with the activeTitlePress event. This allows users to click or tap on the message text in both the first and second page of the message popover.
Navigation to from the message text to a field on the UI
Navigation to from the message text to a field on the UI

Guidelines

Messaging Overview

No messages to display

If there are no messages to display, you do not need to include a message button in the toolbar.

Highlight the fields

First, highlight the specific field(s) if possible, and change their value state according to the type of message, such as error, warning, or success messages.

Message popover

In addition to the field(s) being highlighted, a button also appears in the toolbar, displaying an icon and the number of messages that have occurred. This number matches the number of fields that have been highlighted. Whenever multiple messages occur, they should be displayed in the message popover, which can be triggered via a button on the left side of the footer toolbar.

Display single messages in a message box

There may also be messages that have to interrupt the user. At present, we are only aware of technical issues such as network errors and connection issues.

Validation Points

No guidelines are currently available regarding data validation. Several cases are possible, which depend on the users, the performance, and the data that needs to be validated. These cases include:

  • After focusing out
  • After pressing a key
  • After clicking or tapping an action, such as Create, Save, or Submit

Resources

Want to dive deeper? Follow the links below to find out more about related controls, the SAPUI5 implementation, and the visual design.

Elements and Controls

Implementation