Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markbattistella/defaultskit
DefaultsKit is a Swift package that provides a clean and type-safe way to manage UserDefaults keys and values.
https://github.com/markbattistella/defaultskit
hacktoberfest ios ipados macos swift tvos watchos
Last synced: 9 days ago
JSON representation
DefaultsKit is a Swift package that provides a clean and type-safe way to manage UserDefaults keys and values.
- Host: GitHub
- URL: https://github.com/markbattistella/defaultskit
- Owner: markbattistella
- License: mit
- Created: 2024-05-11T06:05:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-04T06:16:31.000Z (21 days ago)
- Last Synced: 2024-12-04T07:25:04.802Z (21 days ago)
- Topics: hacktoberfest, ios, ipados, macos, swift, tvos, watchos
- Language: Swift
- Homepage: https://swiftpackageindex.com/markbattistella/DefaultsKit/documentation
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DefaultsKit
`DefaultsKit` is a Swift package that provides a clean and type-safe way to manage `UserDefaults` keys and values. It introduces extensible protocols for keys and convenient property wrappers for storing, retrieving, and managing preferences using a consistent prefix strategy.
## Features
- **Type-safe `UserDefaults` Keys:** Use enums conforming to `UserDefaultsKeyRepresentable` to define keys with automatic prefix handling.
- Property Wrappers:
- `@DefaultsPersisted`: A powerful property wrapper for any `Codable` type with built-in support for primitives and optionals
- `@AppStorage:` Enhanced SwiftUI integration with type-safe keys for common types
- **Prefix Management:** Supports internal bundle identifiers or custom prefixes via the `UserDefaultsKeyRepresentable` protocol.
- **Utility Functions:** Includes methods for setting, getting, printing, and deleting `UserDefaults` entries
- **`Codable` Support:** Automatic encoding/decoding for complex types
## Installation
Add `DefaultsKit` to your Swift project using Swift Package Manager.
```swift
dependencies: [
.package(url: "https://github.com/markbattistella/DefaultsKit", from: "1.0.0")
]
```
## Usage
### Defining Keys
Define keys by conforming your enums to `UserDefaultsKeyRepresentable`:
```swift
enum UserDefaultsKey: String, UserDefaultsKeyRepresentable {
case userPreference
case appTheme
case userProfile
}
```
### Using DefaultsPersisted
The `@DefaultsPersisted` property wrapper supports any `Codable` type:
```swift
// For primitive types
@DefaultsPersisted(UserDefaultsKey.userPreference)
var isEnabled: Bool = false
// For custom types
@DefaultsPersisted(UserDefaultsKey.userProfile)
var profile: UserProfile = UserProfile(name: "John", age: 30)
// For optional values
@DefaultsPersisted(UserDefaultsKey.lastLoginDate)
var lastLogin: Date?
```
### AppStorage Integration
Use type-safe keys with SwiftUI's `@AppStorage`:
```swift
struct ContentView: View {
@AppStorage(UserDefaultsKey.userPreference)
var isEnabled: Bool = false
var body: some View {
Toggle("Enable Feature", isOn: $isEnabled)
}
}
```
### Direct UserDefaults Access
Use the extended `UserDefaults` methods:
```swift
// Setting values
UserDefaults.standard.set(true, for: UserDefaultsKey.userPreference)
// Getting values
let preference = UserDefaults.standard.bool(for: UserDefaultsKey.userPreference)
// Encoding complex objects
try? UserDefaults.standard.encode(profile, for: UserDefaultsKey.userProfile)
// Decoding complex objects
let savedProfile: UserProfile? = try? UserDefaults.standard.decode(for: UserDefaultsKey.userProfile)
```
## Managing Defaults
### Registering defaults
```swift
// Register defaults
UserDefaults.standard.register(
defaults: [
UserDefaultsKey.appTheme: "light",
UserDefaultsKey.userPreference: true
]
)
```
### Helper methods
```swift
// Print all values from the UserDefaultsKey enum
UserDefaults.printAllKeys(from: UserDefaultsKey.self)
// Delete all values in the UserDefaultsKey enum
UserDefaults.deleteAllKeys(from: UserDefaultsKey.self)
```
Using it this way allows you to segregate different `UserDefaultsKeyRepresentable` enums, and print or delete them.
## License
`DefaultsKit` is available under the MIT license. See the LICENSE file for more information.