SAPFiori

The SAPFiori framework includes a number of UI components which implement the Fiori Design Language. These controls inherit from the Apple UIKit components, and may be utilized programmatically, or via Interface Builder in *.xib or *.storyboard files.

Installation

1. Add SAPFiori.framework and SAPCommon.framework to your Xcode project.
2. Add the framework files to the Embedded Binaries section of the General tab for project configuration.

The frameworks should be linked to your project, and appear under the Link Binary with Libraries and Embedded Frameworks sections in the Build Phases tab of your App’s Xcode project settings.

Component Categories

Select from the following categories on the left for implementation details, or related links below for additional design guidelines:

• Floorplan examples – See also Fiori Design Guidelines for List Report and Object Floorplans.
  • Onboarding patterns– See also Fiori Design Guidelines for Onboarding.
  • Object views – See also Fiori Design Guidelines for Object Cell and ObjectHeader.
  • Contact views – See also Fiori Design Guidelines for Contact Cell.
  • Timeline views – See also Fiori Design Guidelines for Timeline View and Timeline Preview.
  • KPI view – See also Fiori Design Guidelines for KPIs.
  • Grid view – See also Fiori Design Guidelines for Grid Layout.
  • Map view – See also Fiori Design Guidelines for Map.
  • Create and filter patterns – See also Fiori Design Guidelines for Create and Filter patterns.
  • Attachments controller – See also Fiori Design Guidelines for Attachement type.
  • Collection views – See also Fiori Design Guidelines for Collection View.
  • Overview patterns – See also Fiori Design Guidelines for Header and Overview.
  • Feedback Indicators – See also Fiori Design Guidelines for Feedback.
  • Search bar and barcode scan – See also Fiori Design Guidelines for Search and Scan View.
  • Branding and theming – See also Fiori Design Guidelines for Branding.
  • Calendar View.
  • IBDesignable experimental

Additional Component Notes

The following components inherit from Apple UIKit UITableView and UITableViewCell:

• FUIBaseTableViewCell and NibDesignableFUIBaseTableViewCell - Base classes used in most SDK table view cells, supporting Fiori-design cell selection style (isMomentarySelection), and enabling per-cell cell separator removal at the edges of table view sections.

  • FUIObjectTableViewCell - Standard table view cell for displaying general business object data. The cell contains: a left stack of icons, An image (square or circle), three levels of text: first is headline, second is a subheadnline, third is footnote, a description (only shows up on .regular horizontal size mode), and two status attributes (text or icon).
  • FUIContactCell - Contains contact information including an image, several labels, and an activity component.
  • FUITimelineCell, FUITimelineMarkerCell, and FUITimelinePreviewTableViewCell - Displays a list of items (objects, events, or posts) in chronological order. FUITimelinePreviewTableViewCell is an auto-sizing table view cell container for a FUITimelinePreviewView instance.

  • FormKit cells: A collection of UITableViewCell subclasses, which are used to construct table views for creating or editing business objects, or for building filter controls. FormKit cells provide change handlers to respond to user interaction. Those extending FUIInlineValidationTableViewCell also support in-line validation views.

    • FUITitleFormCell
    • FUINoteFormCell
    • FUIKeyValueFormCell
    • FUISimplePropertyFormCell
    • FUIDatePickerFormCell
    • FUIDurationPickerFormCell
    • FUIValuePickerFormCell
    • FUISwitchFormCell
    • FUISegmentedControlFormCell
    • FUIFilterFormCell
    • FUIListPickerFormCell
    • FUIAttachmentsFormCell

  • FUIGridTableViewCell - A table view cell for displaying a FUIGridRowItem–common for List Report floorplan.

Important: UITableViewCell subclasses in the SAPFiori framework are designed to be used with iOS’s AutoLayout engine. To enable AutoLayout to calculate the correct height of cells, developers should:

1. Set the table view’s estimatedRowHeight property, to a number that is close to the expected height at runtime. This value will be used, before the cell’s dimensions are calculated, to set the table view’s scrollbar position and height.
2. Set the table view’s rowHeight property to UITableViewAutomaticDimension, to indicate that the AutoLayout engine should calculate the correct height for the cell, based upon each cell’s content. See Defining height of a table view cell for details.

The following components inherit from Apple UIKit’s UICollectionView and UICollectionViewCell:

• FUIObjectCollectionViewCell - This subclass of UICollectionViewCell matches the API of the FUIObjectTableViewCell, and is commonly used in displaying a collection of general business objects
• FUISimpleCollectionViewCell - A basic UICollectionViewCell containing an image view and label.
• FUISimplePropertyCollectionViewCell - This subclass of UICollectionViewCell matches the views API of the FUISimplePropertyFormCell, and displays horizontally-aligned key label and value text field.
• FUIKeyValueCollectionViewCell - This variant of UICollectionViewCell contains a vertically-stacked key label and a value text field.
• FUITimelineCollectionViewCell - This variant of UICollectionViewCell is typicaly rendered internally by the FUITimelinePreviewView component.

The following layouts inherit from Apple UIKit’s UICollectionViewFlowLayout:

• FUIHorizontalScrollCollectionViewLayout - A flow layout, which aligns all items for a section into a single row.
• FUIHorizontalFlowCollectionViewLayout - A flow layout, which provides the option to scale collection cell items’ dimensions upwards, to fill the collection content width
• FUIStandardAutoSizingColumnFlowLayout - A flow layout, which arranges collection cell items into a grid, where each row is top-aligned, and items’ widths are stretched to fill the specified number of columns.
  
• FUIKeyValueFlowLayout - A variant of FUIStandardAutoSizingColumnFlowLayout, with pre-defined item spacings to implement Fiori Design Language for arranging FUIKeyValueCollectionViewCell items.
• FUITimelineCollectionViewHorizontalFlowLayout - A variant of FUIStandardAutoSizingColumnFlowLayout which resizes collection view cell items, to lay them out according to a specified number of columns. All items on the same row are resized to have identical cell height using the height of the tallest cell in that row.

Onboarding and activation

The following user activation and onboarding components allow you to quickly integrate all required onboarding steps into apps and connect to SAP Cloud Platform Mobile Services. The onboarding framework supports various onboarding scenarios, including: login screen with demo mode, SAP Cloud ID with OAuth, and touch ID and passcode:

• FUIWelcomeScreen - A screen that allows application onboarding. The screen has two versions to display the application name, instructions on how to start the activation process, and the option to run the application in demo mode. Version 1 has no Activation button; version 2 has Activation button after user is redirected to the screen that has a sign in.

• FUIPasscodeCreateController, FUIPasscodeInputController, and FUIPasscodeChangeController - Provides passcode and Touch ID screens used for setting up a passcode and enabling iPhone native Touch ID for application authentication.

The following component inherits from Apple UIKit UIView:

• FUIObjectHeader - Header-style view, with API similar to FUIObjectCell pattern. It is typically added to UITableView as its tableHeaderView.

• FUIProfileHeader - Header-style view, with API similar to FUIContactCell pattern. It is typically added to UITableView as its tableHeaderView.

• FUIKPIHeader - Header-style view, for displaying sets of FUIKPIView instances. It is typically added to UITableView as its tableHeaderView.

• FUIKPIView - An UIView that enables a developer to present KPI information in a formatted manner consistent with the Fiori Design Language.

• FUITimelinePreviewView - An UIView contains a header and a collection view for showing an excerpt of your project’s milestones in a convenient linear visual presentation.

• FUIActivityControl - A stand alone component that supports user activities such as phone, email, message, and videoCall. Used natively in FUIContactCell, and typical in FUIProfileHeader designs.

• FUIInlineValidationView - An auxiliary view that contains a validation message for FormKit cells. Used natively within FUIInlineValidationTableViewCell.

• FUIBannerMessageView - An animated view for presenting notifications and displaying status. Pins to UINavigationBar, or FUIObjectHeader.

The following utility classes extend native UIKit types:

Note: With the introduction of the closure-styled observe API in Swift 4, and suport for Smart KeyPaths SE-0161, it is recommended to use the native KVO technique for change observation, rather than the onChangeHandler closure API in FUIImageView, FUILable, and FUITextField, as the native API is very similar, and more flexible.

• FUIImageView - An enhanced UIImageView that supports applying a circular mask to an image, and also a change handler on the image property.
• FUILabel - Extension to UILabel, supporting insets: UIEdgeInsets in intrinsicContentSize calculation, and also a change handler on the text property.
  
• FUITextField - Extension to UITextField, supporting a change handler on the text property.
• FUISearchBar - Extension to UISearchBar, supporting a native barcode scanner property.
• FUINavigationBar - Extension to UINavigationBar, supporting a simple style technique to match Fiori Design Language.

Other components

• FUIFeedbackScreen - An UIViewController used to display a feedback screen for the application.

Branding and Theming

Controls in the SAPFiori framework may optionally be styled, using a CSS-like stylesheet. The SAPFiori integrates the open-source NUI framework, which exposes styling properties of UIKit API’s as CSS-like style attributes. The NUI library is embedded in SAPFiori, so no installation is required.

UI components in SAPFiori are styled programmatically by default, and are also assigned a list of style classes which are interpretable by the NUI engine. These style classes may be read, or modified, via the styleClassPath property.

To override the default style of a control at runtime, using a stylesheet (an *.nss file), the developer modify the class definitions in the stylesheet for the relevant style classes, and then activate the NUI engine at runtime by supplying the stylesheet.

See the NUI README for additional information about setting style syntax in the stylesheet.

Developers may assign style classes to any UIView-inheriting control.