/ui-fabric-ios

Office UI Fabric for iOS - The front-end framework for building experiences for Office and Office 365

Primary LanguageSwiftMIT LicenseMIT

Build status GitHub release

The iOS UI framework for building experiences for Office and Office 365.

Office UI Fabric for iOS is a native library that provides the Office UI experience for the iOS platform. It contains information about colors and typography, as well as custom controls and customizations for platform controls, all from the official Fluent design language used in Office and Office 365 products.

Contents

Colors and Typography

Office UI Fabric for iOS provides colors and typography core to experiences within the Fluent Design language.

Controls

Office UI Fabric for iOS includes an expanding library of controls written in Swift and supporting Objective-C. These controls implement the Fluent Design language and provide consistency across Office experiences.

Some of the controls available include:

  • MSActivityIndicatorView
  • MSAvatarView
  • MSBadgeView
  • MSButton
  • MSDateTimePicker
  • MSDrawerController
  • MSHUD
  • MSLabel
  • MSPersonaListView
  • MSPopupMenuController
  • MSSegmentedControl
  • MSTableViewCell

A full list of currently supported controls can be found here: OfficeUIFabric.

Install and use Office UI Fabric

Requirements

  • iOS 11+
  • Xcode 10.2+
  • Swift 4.2+

1. Using CocoaPods

To get set up with CocoaPods visit their getting started guide.

To integrate Office UI Fabric for iOS into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'OfficeUIFabric', '~> 0.2.0'

2. Using Carthage

To integrate Office UI Fabric using Carthage, specify it in your Cartfile:

github "OfficeDev/ui-fabric-ios" ~> 0.2.0

then follow the Carthage itegration steps to add the OfficeUIFabric.framework into your XCode project

3. Manual installation

  • Download the latest changes from the Office UI Fabric for iOS repository.
  • Move the OfficeUIFabric folder into your project folder.
  • Move the OfficeUIFabric.xcodeproj into your Xcode project.
  • In Xcode select your project -> your target -> General -> Embedded Binaries -> add OfficeUIFabric.framework.

Import and use the library

After the framework has been added you can import the library to use it:

import OfficeUIFabric

Demo app

Included in this repository is a demo of currently implemented controls. A full list of implemented controls available in the demo can be found here: Demos.

To build and deploy the demo follow these steps:

  • Download or clone the Office UI Fabric for iOS repository.
  • Open OfficeUIFabric.xcworkspace in Xcode.
  • In the Xcode scheme menu choose Demo.development and choose a device to deploy to.
  • Once deployed you can choose a control to demo from the list of controls on the selected device.

Contributing

Post bug reports, feature requests, and questions in Issues.

Changelog

We use GitHub Releases to manage our releases, including the changelog between every release. You'll find a complete list of additions, fixes, and changes on the Releases page.

License

All files on the Office UI Fabric for iOS GitHub repository are subject to the MIT license. Please read the LICENSE file at the root of the project.