README.md

SwiftUserDefaults

Table of Contents

1. Introduction
2. How to use
   • Custome Container
   • Supported Data
3. Storing Custome Data
   • Example 1 Enums
   • Example 2 Custom Array type
4. RemovingStoredObjects
5. Author

Introduction

This package is crafted for effortless integration and streamlined access to user defaults plus it supports the new privacy rules from WWDC23. Adding it to your project is straightforward: simply include the package link in the main app package like this:"

Alternatively, navigate to the top section labeled 'Files' and click on 'Add Package Dependency':

Next, paste the repository link into the search field and click on 'Add Package':

How to use

Utilizing this API is designed to be straightforward and as effortless as using the @AppStorage API But with more features. First this API is compile time safe and prevents any string typos. Simply declare your key in the DefaultKeys and then add the @UserDefaults to your varible as follows - that's all there is to it

@UserDefaults(\.previewShown) var previewShown = false // false is the default value

extension DefaultKeys {
   var previewShown: String { .init("previewShown") }
}

Note

You can also store optional values just like that:

@UserDefaults(\.previewShown) var previewShown: Bool?

Custome Container

You can also store your userDefaults in a custome container like so:

@UserDefaults(\.previewShown, .init(suiteName: "YourCustomeContainerName")) var previewShown = false

Supported Data

SwiftUserDefaults supports all of the standard NSUserDefaults types, like String, Int, Bool, Array and much more.

Here's a full table of built-in single value defaults:

Single value	Array
String	[String]
Int	[Int]
Double	[Double]
Bool	[Bool]
Data	[Data]
Date	[Date]
URL	[URL]
[String: Any]	[[String: Any]]

But you can also support custome data types 🚀

Storing Custome Data

Storing custom data types is straightforward; you only need to ensure that the custom data type conforms to DefaultsCustomDataType, as demonstrated below:

struct CustomeData: DefaultsCustomDataType {
 init()
}
@UserDefaults(\.customeData) var customeData = CustomeData()

DefaultsCustomDataType is a public protocol that conforms to the Codable protocol. It serves as a bridge, allowing the API to easily detect whether this data type needs to be encoded or not.

Example 1 Enums

Storing an Enum is straightforward; simply ensure that the Enum conforms to DefaultsCustomDataType, as shown below:

enum CustomeData: DefaultsCustomDataType {
case none
}
@UserDefaults(\.customeData) var customeData: CustomeData = .none

Example 2 Custom Array type

Storing custom Array types is even simpler just ensure that the Element type of the Array conforms to DefaultsCustomDataType, as demonstrated below:

struct CustomeData: DefaultsCustomDataType {
init()
}
@UserDefaults(\.customeData) var customeData: [CustomeData] = [CustomeData()]

RemovingStoredObjects

You can also remove the stored value for a specific key using the DefaultKeys.removeObject(at keyPath: KeyPath<DefaultKeys, String>, _ container: UserDefaults = .standard), as demonstrated below:

@UserDefaults(\.testKey) var test = 3
DefaultKeys.removeObject(\.testKey)
// if you use a custome container provide it to the funcation using this syntax, 
// DefaultKeys.removeObject(at keyPath: KeyPath<DefaultKeys, String>, _ container: UserDefaults = .standard)

Note

When you call test after removing the stored value, it will give the default value which is equal 3 in this case (which is not stored UserDefaults2 store). if it was an optional the output will be nil in this case.

if you want to delete all the values in the UserDefaults, you can use DefaultKeys.removeAllUserDefaultsObjects(for container: UserDefaults = .standard):

@UserDefaults(\.testKey) var test = 3
DefaultKeys.removeAllUserDefaultsObjects()
// if you use a custome container provide it to the funcation using this syntax, 
// DefaultKeys.removeAllUserDefaultsObjects(for container: UserDefaults = .standard)

And that's all there is to it! 🚀 Enjoy using this Swifty package.

Author

This pacakge was created by Eng.Omar Elsayed to help the iOS comuntity and make there life easir. To contact me email me at eng.omar.elsayed@hotmail.com