I wrote a Swift library to help with prototyping (haven’t used it yet in production apps).
CloudStorage is property wrapper that will save values in iCloud key-value storage. These values are persisted across app restarts and will sync between different devices that are signed into the same iCloud account. This property wrapper is similar to AppStorage and SceneStorage, two new types Apple introduced with iOS 14.
The basic API is the same as for AppStorage; add
@CloudStorage("someName") in front of a property, to save the value to iCloud key-value storage.
Make sure you enable the “key-value storage” service in the iCloud capability. See Apple’s documenation.
@CloudStorage("readyForAction") var readyForAction: Bool = false @CloudStorage("numberOfItems") var numberOfItems: Int = 0 @CloudStorage("orientation") var orientation: String?
See also the example app in the repository.
For what should this be used?
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 documentation 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.
Check out the CloudStorage repository.