How to use #available to check for API availability

Swift version: 5.1

Paul Hudson    @twostraws    May 28th 2019

One of my favorite Xcode features is the ability to have Xcode automatically check API availability for you, which means it will refuse to run code that is not available on the minimum iOS version you support.

Of course, there are times when you really do need to use a newer feature, for example if you want to use UIStackView where it's available but otherwise show a message to users asking them to upgrade. For this, Swift has #available, which lets you state that a certain block of code should only execute on specific versions of iOS.

To use the previous example, this code checks whether the user has iOS 9.0 or later on their device:

if #available(iOS 9, *) {
    // use UIStackView
} else {
    // show sad face emoji
}

Any code inside the // use UIStackView block can be executed as if your deployment target were iOS 9.0.

If you want, you can mark whole functions or classes as requiring a specific iOS version by using @available, like this:

@available(iOS 9, *)
func useStackView() {
    // use UIStackView
}

Available from iOS 7.0

Similar solutions…

• SwiftUI tips and tricks
• How to check whether a module is available using canImport()
• What’s the difference between @ObservedObject, @State, and @EnvironmentObject?
• How to use @available to deprecate old APIs
• How to run code when your app is terminated

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.