AppState

AppState is a Swift 6 library designed to simplify the management of application state in a thread-safe, type-safe, and SwiftUI-friendly way. It provides a set of tools to centralize and synchronize state across your application, as well as inject dependencies into various parts of your app.

Requirements

• iOS: 15.0+
• watchOS: 8.0+
• macOS: 11.0+
• tvOS: 15.0+
• visionOS: 1.0+
• Swift: 6.0+
• Xcode: 16.0+

Non-Apple Platform Support: Linux & Windows

🍎 Features marked with this symbol are specific to Apple platforms, as they rely on Apple technologies such as iCloud and the Keychain.

Key Features

AppState includes several powerful features to help manage state and dependencies:

• State: Centralized state management that allows you to encapsulate and broadcast changes across the app.
• StoredState: Persistent state using UserDefaults, ideal for saving small amounts of data between app launches.
• FileState: Persistent state stored using FileManager, useful for storing larger amounts of data securely on disk.
• 🍎 SyncState: Synchronize state across multiple devices using iCloud, ensuring consistency in user preferences and settings.
• 🍎 SecureState: Store sensitive data securely using the Keychain, protecting user information such as tokens or passwords.
• Dependency Management: Inject dependencies like network services or database clients across your app for better modularity and testing.
• Slicing: Access specific parts of a state or dependency for granular control without needing to manage the entire application state.
• Constants: Access read-only slices of your state when you need immutable values.
• Observed Dependencies: Observe ObservableObject dependencies so your views update when they change.

Getting Started

To integrate AppState into your Swift project, you’ll need to use the Swift Package Manager. Follow the Installation Guide for detailed instructions on setting up AppState.

After installation, refer to the Usage Overview for a quick introduction on how to manage state and inject dependencies into your project.

Quick Example

Below is a minimal example showing how to define a piece of state and access it from a SwiftUI view:

import AppState
import SwiftUI

private extension Application {
    var counter: State<Int> {
        state(initial: 0)
    }
}

struct ContentView: View {
    @AppState(\.counter) var counter: Int

    var body: some View {
        VStack {
            Text("Count: \(counter)")
            Button("Increment") { counter += 1 }
        }
    }
}

This snippet demonstrates defining a state value in an Application extension and using the @AppState property wrapper to bind it inside a view.

Documentation

Here’s a detailed breakdown of AppState's documentation:

• Installation Guide: How to add AppState to your project using Swift Package Manager.
• Usage Overview: An overview of key features with example implementations.

Detailed Usage Guides:

• State and Dependency Management: Centralize state and inject dependencies throughout your app.
• Slicing State: Access and modify specific parts of the state.
• StoredState Usage Guide: How to persist lightweight data using StoredState.
• FileState Usage Guide: Learn how to persist larger amounts of data securely on disk.
• Keychain SecureState Usage: Store sensitive data securely using the Keychain.
• iCloud Syncing with SyncState: Keep state synchronized across devices using iCloud.
• FAQ: Answers to common questions when using AppState.
• Constant Usage Guide: Access read-only values from your state.
• ObservedDependency Usage Guide: Work with ObservableObject dependencies in your views.
• Advanced Usage: Techniques like just‑in‑time creation and preloading dependencies.
• Best Practices: Tips for structuring your app’s state effectively.
• Migration Considerations: Guidance when updating persisted models.

Contributing

We welcome contributions! Please check out our Contributing Guide for how to get involved.

Next Steps

With AppState installed, you can start exploring its key features by checking out the Usage Overview and more detailed guides. Get started with managing state and dependencies effectively in your Swift projects! For more advanced usage techniques, like Just-In-Time creation and preloading dependencies, see the Advanced Usage Guide. You can also review the Constant and ObservedDependency guides for additional features.