Workflow for Swift
A unidirectional data flow library for Swift and Kotlin, emphasizing:
- Strong support for state-machine driven UI and navigation.
- Composition and scaling.
- Effortless separation of business and UI concerns.
Using Workflows in your project
The minimum supported versions are iOS 17.1, macOS 14, watchOS 10, Mac Catalyst 17, and tvOS 17.
Swift Package Manager
If you are developing your own package, be sure that Workflow is included in dependencies
in Package.swift:
dependencies: [
.package(url: "https://github.com/square/workflow-swift", from: "3.11.0")
]
In Xcode 11+, add Workflow directly as a dependency to your project with
File > Swift Packages > Add Package Dependency.... Provide the git URL when prompted: [email protected]:square/workflow-swift.git.
Resources
Local Development
This project uses Mise and Tuist to generate a project for local development. Follow the steps below for the recommended setup for zsh.
# install mise
brew install mise
# add mise activation line to your zshrc
echo 'eval "$(mise activate zsh)"' >> ~/.zshrc
# load mise into your shell
source ~/.zshrc
# install dependencies
mise install
# only necessary for first setup or after changing dependencies
tuist install --path Samples
# generates and opens the Xcode project
tuist generate --path Samples
Releasing and Deploying
See RELEASING.md.
License
