Intro

You can let users flag objects for follow-up, or mark frequently-used objects as favorites. When an object is flagged or marked as a favorite, the corresponding object marker appears next to it:

  • A small flag indicates that the object is flagged.
  • A small star indicates that the object is marked as a favorite.
"Flag" and "Favorite" icons
Object marked as a favorite
Object marked as a favorite

Usage

  • Offer the Flag option if users need to flag objects for later reference and follow-up.
  • Offer the Favorite option if users need to mark frequently-used objects.
Information
The following controls do not support flag and favorite behavior:

Information
The markFlagged and markFavorite properties are deprecated for the object header (sap.m.ObjectHeader) and the object list item (sap.m.ObjectListItem). When using these controls, please use the marker aggregation of sap.m.ObjectMarker instead.

Responsiveness and Adaptiveness

The Flag and Favorite markers are normally displayed as icons (rather than text) on all screen sizes. If you implement the overflow toolbar, you can specify how the Flag and Favorite actions are handled when there is a shortage of space on the toolbar (move to overflow menu as necessary, always show on toolbar, always show in the overflow menu). For more information, see the toolbar overview.

Favorite icon shown in the overflow
Favorite icon shown in the overflow

Layout

The position of the flag or favorite marker depends on the UI control or floorplan. The button for making the setting appears in the relevant toolbar.

Object Header (Object Page)

In the object header, the markers appear right next to object title. The icon button for setting the status appears in the header toolbar.

Object marked as a favorite in the object header
Object marked as a favorite in the object header

Object List item

In an object list item, the marker appears in the first status line.

Flagged item in an object list
Flagged item in an object list

List Report

In list reports, the marker for a line item shows right beside the checkbox. To make the settings, users need to drill down into the object itself.

List report item marked as a favorite
List report item marked as a favorite

Behavior and Interaction

Users switch the setting on or off by clicking or tapping the Flag or Favorite button (icon), which behaves as a toggle.

Message Handling

When the user changes the flag or favorite setting, a message toast confirms that the marker has been activated or deactivated.

Example: Message toast after setting a favorite
Example: Message toast after setting a favorite

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