cypherpoet / swiftuireduxutils

A collection utilities for architecting SwiftUI apps in the Redux/Elm style of Reducers, Actions, Side Effects and Middlewares. Now updated for Swift Concurrency.

SwiftUI Redux Utils

A collection utilities for architecting SwiftUI apps in the Redux/Elm style of Reducers, Actions, Side Effects and Middlewares.

Installation

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/SwiftUIReduxUtils.

Swift Package Manager Projects

You can add CypherPoetSwiftUIReduxUtils as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(
            name: "CypherPoetSwiftUIReduxUtils",
            url: "https://github.com/CypherPoet/SwiftUIReduxUtils",
            .upToNextMinor(from: "0.5.0")
        ),
    ],
    //...
)

From there, refer to the SwiftUIReduxUtils "product" delivered by the CypherPoetSwiftUIReduxUtils "package" inside of any of your project's target dependencies:

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
            .product(
                name: "SwiftUIReduxUtils",
                package: "CypherPoetSwiftUIReduxUtils"
            ),
        ],
        ...
    ),
    ...
]

Then simply import SwiftUIReduxUtils wherever you’d like to use it.

Usage

The goal of these utilities is to serve as primitives for architecting SwiftUI apps in the Redux/Elm style of Reducers, Actions, Side Effects and Middlewares.

Version 0.2.2 had an example application that demonstrated this, but it's no longer functional after 0.3.0's concurrency refactor. That said, until I get a new example in place, it could still be useful to look through to some extent.

Contributing

There aren't many to-dos here at the moment, but feedback and suggestions are certainly not discouraged. Check out some of the issue templates for more info.

Developing

Requirements

• Xcode 13.0+

📜 Creating & Building Documentation

Documentation is built with Xcode's DocC. See Apple's guidance on how to build, run, and create DocC content.

For now, the best way to view the docs is to open the project in Xcode and run the Build Documentation command. At some point in the future, I'm hoping to leverage the tooling the develops for generating/hosting DocC documentation. (Please feel free to let me know if you have any ideas or tooling recommendations around this 🙂).

Acknowledgments

This project wouldn't be possible without several enlightening projects, articles, and tutorials by others in the Swift community who latched onto using these patterns in SwiftUI. Here are just a few of its main inspirations:

• Redux-like state container in SwiftUI by @mecid.
• Redux-like architecture with SwiftUI by @afterxleep.
• SwiftUI-Redux by @kitasuke.
• The Composable Architecture

License

CypherPoetSwiftUIReduxUtils is available under the MIT license. See the LICENSE file for more info.