workflow

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.

This project is currently in development and the API subject to breaking changes without notice. Follow Square's engineering blog, The Corner, to see when this project becomes stable.

While the API is not yet stable, this code is in heavy production use in Android and iOS apps with millions of users.

Using Workflows in your project

Swift Package Manager

If you are developing your own package, be sure that Workflow is included in dependencies in Package.swift:

dependencies: [
    .package(url: "git@github.com:square/workflow-swift.git", from: "1.0.0-rc.1")
]

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: git@github.com:square/workflow-swift.git.

CocoaPods

If you use CocoaPods to manage your dependencies, simply add Workflow and WorkflowUI to your Podfile:

pod 'Workflow'
pod 'WorkflowUI'

Resources

Documentation

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

Copyright 2019 Square Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

square / workflow-swift

readme