How to check whether a module is available using canImport()
Swift version: 5.1
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.
SPONSORED Catch bugs as soon as they happen and know exactly why a crash occurred by integrating Instabug's SDK in one minute. You will automatically receive device data, network logs, and reproduction steps with every bug and crash report.
Sponsor Hacking with Swift and reach the world's largest Swift community!
Available from iOS 8.0
Similar solutions…
- How to convert dates and times to a string using DateFormatter
- How to check for internet connectivity using NWPathMonitor
- How to detect keyboard input using pressesBegan() and pressesEnded()
- How to test asynchronous functions using expectation()
- How to provide relative sizes using GeometryReader
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
