How to use system icons in your app
Swift version: 5.6
iOS 13 lets us use icons from a range of over 1500 designed by Apple, all of which come in a variety of weights and sizes. These icons form part of new UIImage API, and they are vector-based so you can us them at a range of sizes without loss of quality.
Note: This is a stringly typed API, so you should download the new SF Symbols app that lists all variants – download it here.
To load a system icon you use the new UIImage(systemName:) initializer. In its most basic form it looks like this:
let paperPlane = UIImage(systemName: "paperplane.fill")
let action = UIImage(systemName: "square.and.arrow.down")You can request specific weights of your icon by creating an instance of UIImage.SymbolConfiguration like this:
let boldConfig = UIImage.SymbolConfiguration(weight: .bold)
let boldBell = UIImage(systemName: "bell", withConfiguration: boldConfig)More usefully, you can also tell UIKit what kind of text is being rendered nearby so it can ensure the icon is sized appropriately, like this:
let largeConfig = UIImage.SymbolConfiguration(textStyle: .largeTitle)
let largeBolt = UIImage(systemName: "bolt", withConfiguration: largeConfig)This ensures your icons work correctly alongside your other Dynamic Type code.
SAVE 50% To celebrate WWDC23, all our books and bundles are half price, so you can take your Swift knowledge further without spending big! Get the Swift Power Pack to build your iOS career faster, get the Swift Platform Pack to builds apps for macOS, watchOS, and beyond, or get the Swift Plus Pack to learn advanced design patterns, testing skills, and more.
Available from iOS 13.0
Similar solutions…
- How to detect when the system is under pressure and you should reduce your work
- How to stop system gestures from interfering with your own
- How to change your app icon dynamically with setAlternateIconName()
- How to control which screen edges trigger system gestures using preferredScreenEdgesDeferringSystemGestures
- How to read your app’s version from your Info.plist file
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
