Skip to content
A Swift and Kotlin library for making composable state machines, and UIs driven by those state machines.
Kotlin Swift Ruby Other
Branch: master
Clone or download

Latest commit

Latest commit 607a004 May 24, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.buildscript Github Workflow to release Workflow version Apr 14, 2020
.github Explicitly pass gradle home path for caching. May 19, 2020
.hooks Minor sample cleanups May 21, 2020
docs Update docs and template for ViewEnvironment Mar 4, 2020
kotlin Upgrade to Kotlin 1.3.72 and AGP 4.0.0-rc01 May 22, 2020
swift Merge pull request #1121 from kingreza/reza/add-test-tic-tac-toe May 25, 2020
.gen_config.yml Adding Alert Screen to Workflow May 7, 2020
.gitignore Update mkdocs config with new Kotlin UI module structure. Mar 19, 2020
.markdownlint.rb Add linting for our documentation and fix existing errors. Jul 24, 2019
.swift-version Swiftformat May 6, 2020
.swiftformat Excluding specific files from swiftformat May 7, 2020
CHANGELOG.md Update CHANGELOG.md May 20, 2020
CODE_OF_CONDUCT.md Add linting for our documentation and fix existing errors. Jul 24, 2019
CONTRIBUTING.md Add linting for our documentation and fix existing errors. Jul 24, 2019
Development.podspec Add tests for tic tac toe workflows May 24, 2020
Gemfile Update gems Apr 21, 2020
Gemfile.lock Update gems Apr 21, 2020
LICENSE Initial commit Nov 16, 2018
Package.swift Swiftformat May 6, 2020
README.md Add README link to compose repo. May 19, 2020
RELEASING.md Add pip requirements file, update scripts Apr 14, 2020
Workflow.podspec Fix missing libswiftos.dylib May 20, 2020
WorkflowSwiftUI.podspec Finish releasing v0.28.0. May 12, 2020
WorkflowTesting.podspec Fix missing libswiftos.dylib in WorkflowTesting and WorkflowUI May 20, 2020
WorkflowUI.podspec Fix missing libswiftos.dylib in WorkflowTesting and WorkflowUI May 20, 2020
deploy_website.sh Add pip requirements file, update scripts Apr 14, 2020
lint_docs.sh Embed the Swift API docs in the regular site. Jul 30, 2019
mkdocs.yml Fix Gradle config to generate correct multi-module dokka docs. Apr 1, 2020
requirements.txt Add pip requirements file, update scripts Apr 14, 2020

README.md

workflow

GitHub license CocoaPods compatible Maven Central

A unidirectional data flow library for Kotlin and Swift, 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.

<iframe title="vimeo-player" src="https://player.vimeo.com/video/362741019" width="640" height="360" frameborder="0" allowfullscreen></iframe>

Using Workflows in your project

Swift

Swift CI

Swift Package Manager

SwiftPM compatible

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.git", from: "0.21.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.git.

Cocoapods

CocoaPods compatible

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

pod 'Workflow'
pod 'WorkflowUI'

Kotlin

Kotlin CI Maven Central Kotlinlang slack

Quick Start

To get started with a fresh, barebones, Workflow-based Android app, we've created a template repository – just click "Use this template" to create a new repository with a simple but runnable app: github.com/square/workflow-android-template

Maven Artifacts

Artifacts are hosted on Maven Central. If you're using Gradle, ensure mavenCentral() appears in your repositories block, and then add dependencies on the following artifacts:

Maven Coordinates Depend on this if…
com.squareup.workflow:workflow-core-jvm:x.y.z You are writing a library module/project that uses Workflows, but you don't need to interact with the runtime from the outside.
com.squareup.workflow:workflow-rx2:x.y.z You need to interact with RxJava2 from your Workflows.
com.squareup.workflow:workflow-testing-jvm:x.y.z You are writing tests. This should only be included as a test dependency.
com.squareup.workflow:workflow-ui-core-android:x.y.z You're writing an Android app that uses Workflows.
com.squareup.workflow:workflow-ui-modal-android:x.y.z Your Android app uses modals (popups).
com.squareup.workflow:workflow-ui-backstack-android:x.y.z Your android app uses backstacks.

Lower-level Artifacts

Most code shouldn't need to depend on these directly. They should generally only be used to build higher-level integrations with UI frameworks.

Maven Coordinates Depend on this if…
com.squareup.workflow:workflow-runtime-jvm:x.y.z You need to interact directly with the runtime, i.e. streams of renderings and outputs.
com.squareup.workflow:workflow-ui-core-jvm:x.y.z You are writing workflow-ui-android for another UI framework. Defines the core types used by that artifact.

Jetpack Compose support

Jetpack Compose is the new (under-development, pre-release) UI toolkit for Android. It is comparable to SwiftUI for iOS. The main UI artifacts in this repository support standard Android Views, but various types of Compose integrations are provided in the sidecar repository square/workflow-kotlin-compose. See that repo for usage info and documentation.

Resources

Support & Contact

Workflow maintainers hang out in the #squarelibraries channel on the Kotlin Slack and the #square-libraries-wtf channel on the Android Study Group Slack.

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.
You can’t perform that action at this time.