Sync settings through iCloud key-value storage.
Similar to @AppStorage
and @SceneStorage
in iOS14, this @CloudStorage
property wrapper persists values across app restarts.
But this also synchronizes these values across devices using iCloud Key-Value Storage.
- Select your project file in Xcode, select the target and click "Signing & Capabilities"
- Hit the "+ Capability" button in the top-left
- Search for "iCloud" and add the capability
- Enable the "Key-value storage" service
Hit File -> Add Packages... and paste the URL of this GitHub repo to add it to your project.
These values will be synced between devices of the user of your app:
@CloudStorage("readyForAction") var readyForAction: Bool = false
@CloudStorage("numberOfItems") var numberOfItems: Int = 0
@CloudStorage("orientation") var orientation: String?
See also the example app in this repository.
The same caveats apply as with key-value storage itself:
Key-value storage is for discrete values such as preferences, settings, and simple app state.
Use iCloud key-value storage for small amounts of data: stocks or weather information, locations, bookmarks, a recent documents list, settings and preferences, and simple game state. Every app submitted to the App Store or Mac App Store should take advantage of key-value storage.
From Apple's documenation on choosing the proper iCloud Storage API
In general, key-value storage is not meant as a general purpose syncing service. If you need any advanced capabilities to prevent data loss, consider using CloudKit instead.
Nonstrict B.V., Tom Lokhorst & Mathijs Kadijk, released under MIT License