Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 2.31 KB

README.md

File metadata and controls

94 lines (59 loc) · 2.31 KB
Raw

FluentIcons iOS & macOS

Installation

CocoaPods

use_frameworks!
pod "FluentIcons", "1.1.266"

Carthage

git "[email protected]:microsoft/fluentui-system-icons.git" "1.1.266"

Usage

iOS

import FluentIcons

UIImage(fluent: .appStore24Filled)

# To specify a tint color
let imageView = UIImage(fluent: .appStore24Regular)
imageView.tintColor = .label

# or
let imageView = UIImage(fluent: .appStore24Regular, tintColor: .label)

macOS

import FluentIcons

NSImage.fluentIcon(.appStore24Filled)

Benefits

1. No more missing assets!

By using the enum FluentIcon.myIcon24Regular you can be sure that the icon exists in your app at compile time.

No more risky stringly typed UIImage(named: "")!

2. Only includes what you use

At build/release time you can run the following script to ensure all unused assets are stripped from the app:

CocoaPods

ICON_SOURCE_PATH="./Pods/FluentIcons"

$ICON_SOURCE_PATH/ios/remove-unused-fluent-icons/run \
	--path-to-source-code "." \
	--path-to-fluent-icon-source $ICON_SOURCE_PATH

Carthage

ICON_SOURCE_PATH="./Carthage/Checkouts/fluent-mobile-icons"

$ICON_SOURCE_PATH/ios/remove-unused-fluent-icons/run \
	--path-to-source-code "." \
	--path-to-fluent-icon-source $ICON_SOURCE_PATH

carthage build --platform iOS fluent-mobile-icons

Optionally if you are using React Native or are referencing icons outside of your codebase, you can pass an icon list to prevent these icons from being removed.

--path-to-list-of-icons-to-keep OutlookReactNativeKit/ReactResources/FluentIcons.txt

3. Consistent asset rendering

All non-color icons are rendered as template images so you can easily apply a tintColor to your UIImageView or UIButton. You no longer need to specify .withRenderingMode(.alwaysTemplate) in case you're unsure the asset was misconfigured.

FAQ

1. Will this increase my apps build size

It will only increase for the icons you use in your app but you'll need to set up the script using the instructions above ^ to strip out all unused assets.

2. Why are there assets of different sizes? Can't all PDFs be scaled?

Technically they can! But the design team has tailored each icon to each specific size. For example, smaller icons generally have less detail in the image.