Updated: April 18, 2023

Semantic Page

sap.f.SemanticPage

Intro

The semantic page is recommended as the basic layout for freestyle applications. It builds on the basic functionality of the dynamic page and adds predefined content elements to the header toolbar (1) and footer toolbar (2), such as a title, global actions, and finalizing actions.

Using the semantic page significantly reduces the development effort for app teams, and ensures that the placement of the header and footer content conforms with the SAP Fiori Design Guidelines.

Semantic page
Semantic page

When to Use

Use the semantic page if:

  • You are building a freestyle application.
  • You want to use a predefined layout to reduce development time.

Do not use the semantic page if:

Components

The semantic page is based on the structure of the dynamic page. In short, the semantic page has the following elements:

  1. Header title
  2. Header content
  3. Page content, dependent on the use case
  4. Footer toolbar with finalizing actions

The control’s semantics determine whether content specified in the control appears in the header toolbar or footer toolbar.

Semantic page structure
Semantic page structure

Header Title

Semantic page - Header title example
Semantic page - Header title example

Mandatory Elements

  • Title (1): The title is located on the left-hand side of the header title bar and is always visible.

Optional Elements

  • Subtitle (2): The subtitle is always below the title and is often used to summarize the most important information.
  • Breadcrumb (3): Depending on the use case, you can add a breadcrumb navigation.
  • Key information (4): Key information is located in the middle area, and is left aligned. This can be text, mini facets, or KPI tags, for example.
  • Global actions toolbar (5): The global actions toolbar for the entire floorplan is located on the right-hand side. Always use buttons for global actions, visualized either as text or icons. For more information, see header toolbar.
    Overflow menu: Actions move into the overflow from right to left. Icons are shown in the overflow menu with a corresponding text.
  • Layout actions (6): These are actions like the Close or Full Screen / Exit Full Screen icons, which are mainly offered by the flexible column layout. Depending on the screen size, layout actions are placed either to the right of the global actions toolbar, separated by a divider line, or above the global actions.

For more information about the expandable and collapsible header and its features, see dynamic page.

Guidelines

  • Layout actions never move into the overflow and are always last in the header toolbar.
  • Do not remove or disable actions within the header title when it is collapsed.

Header Content

The optional header content is not defined in the semantic page and can be populated according to the use case.

Page Content

Like the header content, the page content is also not specified by the semantic page. It is proportionally the largest area of the layout and can be populated according to the use case.

Footer Toolbar

Semantic page - Footer toolbar
Semantic page - Footer toolbar

The footer toolbar is optional and contains the following components:

  1. Message button (containing the message popover) on the left-hand side
  2. Draft indicator on the right-hand side, just before the finalizing actions
  3. Finalizing actions on the right-hand side

Behavior and Interaction

The interaction and guidelines for the dynamic page also apply for the semantic page. The actions in the semantic page and their order are predefined and follow the rules of the action placement concept. For more information about toolbars in general, see toolbar overview.

Initial Focus

When the semantic page is loaded, set the initial focus as follows:

  • If the page is in display mode, set the focus on the first section.
  • If the page is in edit mode, set the focus on the first empty mandatory field.
  • If there are no mandatory fields in edit mode, set the focus on the first editable element or first action.

Responsiveness

The semantic page offers considerable freedom and flexibility. It is designed to adapt automatically to small, medium, and large screen sizes. Next to that the responsive behavior depends on the behavior of the content being displayed.

The title (sap.m.Title) and subtitle (sap.m.Text) on the left truncate in collapsed mode to save vertical space and wrap in expanded mode to offer the full text. This behavior needs to come from the respective controls for the title and subtitle. Overall, it is recommend not to show more than 2 lines of text in collapsed mode to avoid a disproportionate header height, especially on mobile devices, when no summary line is used. This can either be a combined title and subtitle or a longer wrapping title. For more information see wrapping and truncating text.

Key information (middle area, left aligned) stays as long as possible before it moves into the overflow.

Global actions also stay as long as possible, but have a predefined width depending on the available space. If no key information is available, the title and global actions automatically get more space. The toolbar follows the standard toolbar overflow guidelines, and adds buttons to the overflow menu from right to left.

The combination of a semantic page within in a flexible column layout and accompanying layout actions works as described for the dynamic page. The same applies for the summary line and letterboxing.

Top Tips

  • Use always a header title.
  • Use the header title and header content to provide the most relevant information and actions for your use case.
  • Do not remove or disable actions within the header title when it is collapsed.
  • Make sure that the layout actions in the flexible column layout are displayed correctly and never get hidden in the overflow.
  • Start your application in expanded mode if users need further content or adjustment options to get started.
  • Offer the pinning feature whenever users may need to fix the header content while scrolling through the page content.
  • Activate the summary line on smartphones to help users focus on the actual content of the page.

Related Topics

Elements and Controls

Implementation