How to check whether a module is available using canImport()
Swift version: 5.0
Writing multi-platform code has its own challenges, but if you use the canImport() compiler test then one big challenge is solved for you: you can write one chunk code to run if a specific module is available, and another chunk otherwise.
For example, this code will check for UIKit, AppKit, and all other possibilities so that you can pick whichever color type is best for the current platform:
#if canImport(UIKit)
// iOS, tvOS, and watchOS – use UIColor
#elseif canImport(AppKit)
// macOS – use NSColor
#else
// all other platforms – use a custom color object
#endifBefore canImport() was available we need to use #if os(macOS) instead, like this:
#if os(iOS) || os(tvOS) || os(watchOS)
// use UIColor
#else
// use NSColor
#endifUsing canImport() is an improvement because it lets you focus on what functionality you want rather than what operating system. So, if UIKit became available on macOS tomorrow you wouldn’t need to change your code to use it.
LEARN SWIFTUI FOR FREE I wrote a massive, free SwiftUI tutorial collection, and also have a growing list of free SwiftUI tutorials on YouTube – get started today!
Available from iOS 8.0
Did this solution work for you? Please pass it on!
Other people are reading…
- What does weak mean?
- How to format JSON using Codable and pretty printing
- How to specify default values for dictionary keys
- What’s the difference between a function and a method?
- How to use map() to transform an array
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
