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:

Additional Component Notes

The following components inherit from Apple UIKit UITableView and UITableViewCell:

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:
The following layouts inherit from Apple UIKit’s UICollectionViewFlowLayout:
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:
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.