Home Object Status

Updated: December 19, 2016
SAPUI5 Version 1.26

Object Status

sap.m.ObjectStatus

Intro

The object status is a short text that represents the semantic status of an object. It has a semantic color and an optional icon. As such, you will mostly find the object status in the object header and in the table as a status attribute of a line item.

Usage

Use the object status if:

  • You need to display the semantic status of an object: negative (property: error), critical (property: warning), positive (property: success), or neutral (property: none).
  • You need to indicate that the current object instance is locked by another user.

Do not use the object status if:

  • You want to use it for decoration.
  • You want to display system messages.

Responsiveness

The object status wraps if it becomes too long for the screen width available.

Components

The object status consists of the following:

  • A semantically colored text (property: text)
  • An optional icon (property: icon)
  • A title that serves as a label (property: title)

It is mainly used with semantically colored text only.

Semantic colors
Semantic colors

Guidelines

  • Use semantic text only and avoid using it with an icon.
  • Use the following semantics to indicate the status: negative (property: error), critical (property: warning), positive (property: success), or neutral (property: none).
Use semantic text only
Use semantic text only
  • Only use icons that are unambiguous and easily understood, such as the locked item icon. If you think your icon would need a descriptive text to be understood, use text only.
  • In the case of locked items, you may add some information about who currently has access to the locked item in question.
Locked status
Locked status
Status indicating that the item is locked by a certain user
Status indicating that the item is locked by a certain user
  • Do not use the title of the object status outside the object header. Even though both wrap, you should keep the text as short as possible.
Avoid long titles and text if possible
Avoid long titles and text if possible

  • When an object status is used in a table, it should be center-aligned. 

Object status should be aligned to the center
Object status should be aligned to the center

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

No link

Implementation