Flag and Favorite

Intro

Warning

This article was written for an earlier guideline release, and may contain outdated content. An update is in progress. If you have any questions in the meantime, please post them in our SAP User Experience Community forum. Thank you!

The flag icon is used to flag objects for later reference and follow-up. The favorite icon is used to mark frequently needed objects as favorites.

In order for a business object to be flagged and/or be marked as favorite, the properties markFlag and markFavorite should be set to true. To display both indicators, set the property ShowMarkers to true.

Usage

Use flag if you want to flag objects for later reference and follow-up.
Use favorite if you want to mark frequently used objects as favorites.

Responsiveness

Size S

Size M

Size L /XL

Layout

A small flag indicates that the object is flagged. A small star indicates that the object is marked as a favorite.

Favorite and flag icons

Flags and Favorites in Object List Items

Flag and favorite icons should be placed in the reserved space in the first row of the status block, on the right-hand side.

The status line should be used for visualizing the flagged and favorite objects. The first status line remains empty if neither flags nor favorites are set.

If your app does not use flags or favorites, you can use both status lines for further information about the object status.

Flag and favorite - Object list item

Flags and Favorites in the Object Header

Behavior and Interaction

Set Flag/Mark as Favorite

In the full screen layout, the functions Mark as Favorite and Set Flag are available in the footer toolbar. Once the user has set a flag or favorite, the icon is highlighted (toggle button).

Flag and favorite - Set Flag/Mark as Favorite toggle (full screen layout)

In the split-screen layout, the functions Mark as Favorite and Set Flag are available in the details footer, and if the master list is set to multiselection mode, the functions are available in the master list footer.

Flag and favorite - Set Flag/Mark as Favorite in master list (split-screen layout)

Remove Flag/Favorite Settings

To remove the settings, click on the Set Flag and/or Mark as Favorite icon again.

Message Handling

Once the user has set a flag/ favorite, a respective message toast appears. The same holds true for unflagging/unmarking an object.

Flag and favorite - Message toast

Once the user has set a flag/ favorite, a respective message toast appears. The same holds true for unflagging/unmarking an object.

Flag and favorite - Message toast

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

Toggle button (guidelines)
Object header (guidelines)
Message toast (guidelines)

Implementation

Flag and favorites (SAPUI5 samples)
Toggle button (SAPUI5 samples)
Toggle button (SAPUI5 API reference)
Message toast (SAPUI5 samples)