Intro

The comparison pattern allows users to select items from a list and display them side-by-side. This makes it easier to compare the characteristics of multiple items.  

When to Use

Use the comparison pattern if:

  • Users need to compare two or more similar items.
  • Users need to compare versions of the same item.
  • You are using the Dynamic Page Layout.

Do not use the comparison pattern if:

  • There is no business need for displaying items side-by-side. Don’t use the pattern purely for visualization.
  • You want to display only one item. In this case, use the Object Page Floorplan instead.

Components

The comparison pattern comprises the following components. All are mandatory: 

  • Triggering action: Opens the comparison view for the selected items.
  • Header areaShows the most important characteristics for identifying and comparing itemsEach item is represented by a card.
  • Content areaShows all characteristics needed for comparison. Each item is represented by a panel.

Triggering Action

The comparison is triggered by a button on a selection screen (for example, in a table toolbar).

Guidelines
Use the action text Compare or Compare [Objects]. In parentheses, include a counter for the number of selected items.

For example:
Compare (3)
Compare Products (3)

Header Area

The dynamic page header holds the header area of the comparison pattern. It uses the snapping behavior.

The header area has two main components:

1. Carousel

The carousel control displays the items in cards.

If there is not enough space to show all cards, paging buttons are displayed. Each time a user navigates left or right, the previous or next card is displayed. This also affects the respective panels in the content area. They are updated with the details of the item represented by the card.

Developer Hint
Always show the paging indicator when there is navigation between the cards (property showPageIndicator = true).

2. Card

The card contains the most important characteristics for an item. It consists of the card header and the card content.

Guidelines

  • Apply the same size and structure for all cards.
  • In the header area, show at least a title. A subtitle and image/avatar are optional. Do not show any other information.
  • For a lighter and more convenient comparison, limit the details you display in the card content. This keeps the cards shorter and easier to read. Use the panels to show more information.

When the header snaps, the information in the header area stays and the card content hides.

Warning
The comparison pattern uses the sap.f.card control in the header area. Do not use sap.f.card outside the comparison pattern.
Comparison pattern - Header area
Comparison pattern - Header area
Comparison pattern - Snapped header
Comparison pattern - Snapped header

Content Area

The dynamic page content area holds the content area of the comparison pattern.

The content area must contain at least two panels. For easier and faster comparison, use up to 10 panels to display the specifics of the selected items.

Panel

The expandable panel (1) is used to display all comparable characteristics in columns. A column is aligned with the respective card.

The first column of each panel should contain the characteristics of the item represented with the first card, the second column the item represented with the second card, and so on.

A panel must have a title that describes the characteristics. When collapsed (2), the panel displays only the title toolbar.

Guidelines

  • Show at least two panels in the content area.
  • For easier and faster comparison, use up to 10 panels to display the specifics of the selected items.
  • If an item is missing a characteristic, leave the corresponding field blank. Learn more here.

Comparison pattern - Content area
Comparison pattern - Content area
Comparison pattern content area - Expanded and collapsed panels
Comparison pattern content area - Expanded and collapsed panels
Missing characteristics
Missing characteristics

Behavior and Interaction

Adding More Items

If your users need to add more items while comparing, place an Add to Comparison action in the header. For more information, see Dynamic Page Layout – Header Title.

For adding more items, either show a dialog or the original page the user started from. Make sure that you display the items that are already in the comparison: in the dialog, also show the previously selected items; in the original page, keep the items selected.

Responsiveness

The comparison pattern adapts the number of visible items based on the screen size. If a card is no longer in the visible area, also hide its corresponding column in the panels.

On size S, there is only one visible card in the header area and its corresponding panels in the content area. Users can navigate left or right to see the next or previous item.

The comparison pattern maintains the scrolling position of the page when switching to the next or previous item. This feature helps the user focus on a certain characteristic while navigating through the items.

On size M and larger, always show two or more cards with their corresponding panel columns in the visible area.

Size S
Size S
Size S - Snapped header
Size S - Snapped header
Size M
Size M
Size M -Snapped header
Size M -Snapped header
Size L
Size L
Size L - Snapped header
Size L - Snapped header

Example

Top Tips

Compare apples with apples.

Wording

  • For triggering the comparison, use a meaningful button text with the number of selected items in brackets. We recommend “Compare (<number of selected items>)”, for example, Compare (3).
  • Use a page title that describes the task. We recommend “Compare <selected object type>”, for example, Compare Products.
  • Use precise panel titles to describe the characteristics.

Cards

  • Show only the most important information for an item on the card.
  • If the cards contain only a title, subtitle, and image/avatar, show the dynamic page header in collapsed mode when starting the app.
  • Link each item’s object page (if available) to the header area of the card. This gives users access to all the characteristics for a specific item to help them make a final decision.

Related Topics

Elements and Controls

Implementation