vgonda / workflow

A Swift and Kotlin library for making composable state machines, and UIs driven by those state machines.

Square Workflow

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

See the square/workflow-swift repository.

Kotlin

See the square/workflow-kotlin repository.

Resources

• Square Workflow – Droidcon NYC 2019 (slides)
• SF Android GDG @ Square 2019 - Hello Workflow (live coding)
• Android Dialogs 5-part Coding Series
  • 1, 2, 3, 4, 5
• Reactive Workflows a Year Later – Droidcon NYC 2018
• The Reactive Workflow Pattern – Fragmented Podcast
• The Reactive Workflow Pattern Update – Droidcon SF 2017
• The Rx Workflow Pattern – Droidcon NYC 2017 (slides)

Support & Contact

Workflow maintainers hang out in the #squarelibraries channel on the Kotlin 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.