599e69c7fa | ||
---|---|---|
.github | ||
apple/FluentUI-All.xcworkspace | ||
ios | ||
macos | ||
public | ||
scripts | ||
.gitignore | ||
.swiftlint.yml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
FluentUI.nuspec | ||
LICENSE | ||
MicrosoftFluentUI.podspec | ||
Package.swift | ||
README.md | ||
SECURITY.md |
README.md
Fluent UI Apple
Fluent UI Apple contains native UIKit and AppKit controls aligned with Microsoft's Fluent UI design system.
Getting Started
Install and use FluentUI
Requirements
- iOS 15+ or macOS 10.15+
- Xcode 14.3+
- Swift 5.7.1+
Using Swift Package Manager
To integrate FluentUI using SwiftUI, specify it as a dependency in your Xcode project or Package.swift
file:
dependencies: [
.package(url: "https://github.com/microsoft/fluentui-apple.git", .upToNextMinor(from: "X.X.X")),
],
Using CocoaPods
To get set up with CocoaPods visit their getting started guide.
To integrate FluentUI into your Xcode project using CocoaPods, specify it in your Podfile:
pod 'MicrosoftFluentUI', '~> X.X.X'
Manual installation
- Download the latest changes from the FluentUI for Apple repository.
- Move the
fluentui-apple
folder into your project folder. - For iOS platform
- Move
ios/FluentUI.xcodeproj
into your Xcode project. - In Xcode select your project -> your target -> "General" -> "Frameworks, Libraries, and Embedded Content" -> add
libFluentUI.a
. - In Xcode select your project -> your target -> "Build Phases" -> "Copy Bundle Resources" -> add
FluentUIResources-ios.bundle
.
- Move
- For macOS platform
- Move
macos/xcode/FluentUI.xcodeproj
into your Xcode project. - In Xcode select your project -> your target -> "General" -> "Frameworks, Libraries, and Embedded Content" -> add
FluentUI.framework
.
- Move
Import and use FluentUI
After the framework has been added you can import the module to use it:
For Swift
import FluentUI
For Objective-C
#import <FluentUI/FluentUI-Swift.h>
List of Available Controls
For more platform-specific information, please see the iOS readme file and the the macOS readme file.
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 FluentUI Apple GitHub repository are subject to the MIT license. Please read the LICENSE file at the root of the project.
Usage of the logos and icons referenced in FluentUI Apple is subject to the terms of the assets license agreement.