workflow

Workflow is an application framework that provides architectural primitives.

Workflow is:

• Written in and used for Kotlin and Swift
• A unidirectional data flow library that uses immutable data within each Workflow.
  Data flows in a single direction from source to UI, and events in a single direction
  from the UI to the business logic.
• A library that supports writing business logic and complex UI navigation logic as
  state machines, thereby enabling confident reasoning about state and validation of
  correctness.
• Optimized for composability and scalability of features and screens.
• Corresponding UI frameworks that bind Rendering data classes for views
  (including event callbacks) to Mobile UI frameworks for Android and iOS.
• A corresponding testing framework that facilitates simple-to-write unit
  tests for all application business logic and helps ensure correctness.

1.0.0-rc is ready and the core is stable. There are still experimental / under construction areas of the API for UI integration however. These classes and functions are marked with @WorkflowUIExperimentalApi. They are suitable for production use (we've been shipping them for months at the very heart of our flagship app), but may require signature tweaks as we iterate a bit more on Dialog management, and configuring transition effects. If they do change, we will take care to minimize the impact via deprecation, etc.

Using Workflows in your project

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:

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.

Jetpack Compose support

Jetpack Compose is the new 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 under the compose folder.

You'll find workflow + compose info and documentation there.

Resources

• Wondering why to use Workflow? See
  "Why Workflow"
• There is a Glossary of Terms
• We have a User Guide
  describing core concepts.
• For Kotlin (and Android), there is a codelab style
  tutorial in the repo.
• For Swift (and iOS), there is also a Getting Started
  tutorial in the repo.
• There are also a number of
  Kotlin samples
  and Swift samples.

Support & Contact

Workflow discussion happens in the Workflow Community slack. Use this open invitation.

Workflow maintainers also hang out in the #squarelibraries channel on the Kotlin Slack.

Releasing and Deploying

See RELEASING.md.

License