square/workflow-kotlin
Workflow Kotlin
Workflow-kotlin is a cross-platform state management and UI binding framework for Kotlin that models application navigation, background tasks, and screen rendering through composable, hierarchical state machines. The architecture drives application behavior by flowing immutable data downward to declarative user interfaces and routing user interactions upward through named event handlers.
The library includes multiplatform target support for compiling shared code across operating systems, along with asynchronous operation execution that handles background tasks safely outside render passes. It integrates with reactive stream primitives, bridges view-based containers with declarative screens, and manages navigation structure directly within presenter state.
Additional capabilities cover workflow execution visualization and trace recording, performance measurement, automated testing utilities for business logic and rendering, and build tooling that generates startup baseline profiles.
Features
- Composable State Machine Definitions - Models application state and behavior by combining incoming configuration and private state into renderable view models with embedded event handlers.
- Application State Machines - Models complex application logic and screen navigation as immutable state machines.
- Unidirectional Data Flow - Drives application behavior through an immutable data flow where data moves downward to the interface and events flow upward.
- Cross-Platform Navigation State - Manages navigation, background tasks, and reactive rendering through nested state machines.
- Hosting - Executes workflows directly from composable functions by subscribing to reactive state and managing snapshot persistence and lifecycle bindings.
- Cross-Platform App Development - Builds multiplatform applications from a shared codebase for consistent business logic.
- Declarative UI State Bindings - Connects data models and user interaction callbacks directly to underlying mobile user interface elements across operating systems.
- Asynchronous Operation Execution - Executes background tasks and reactive data streams safely outside render passes.
- Multiplatform Code Sharing - Compiles core state machine logic across operating systems using shared multiplatform code.
- Multiplatform Build Targets - Configures multiplatform targets through build properties to build and test cross-platform code for mobile and desktop environments.
- Kotlin Framework Libraries - Provides a Kotlin framework for building composable state machines and unidirectional UI flows.
- Programmatic Workflow Logic - Drives application state programmatically across platforms by executing composable state machine logic.
- Hierarchical State Machines - Runs multiple state machines in a tree structure where parent components delegate rendering and pass down configuration to child components.
- Architectural State Machines - Models modular application logic and navigation as immutable state machines.
- Declarative UI Libraries - Connects reactive state machines directly to native mobile and desktop UI components.
- Declarative Native Renderers - Draws native application screens using declarative component functions that update automatically whenever state machine transitions occur.
- Navigation State Modeling - Treats navigation structure as an integrated component of presenter state using recursive workflows to handle complex screen hierarchies.
- Declarative UI Development - Renders native screens using declarative component functions that update on state changes.
- Debugging and Inspection - Visualizes state machine execution trees with frame-by-frame event navigation.
- Workflow Execution Monitors - Displays hierarchical state machine execution trees with color-coded nodes and frame-by-frame event navigation for debugging application flow.
- Workflow Runtime Testing Utilities - Verifies individual render passes with mock dependencies and executes multi-step asynchronous runtime behaviors.
- Live Stream Visualizers - Streams real-time execution data from connected devices for active session inspection.
- Workflow Progress Monitoring - Records runtime metrics and workflow session bookkeeping to enable tracing of state machine executions and performance.
- UI Previewers - Renders screen factories with visual placeholders to enable direct IDE previewing.
- Third-Party Library Integration - Bridges state machines into reactive streams by consuming third-party event pipelines.
- Business Logic Testing - Verifies application correctness and state machine workflows using targeted unit tests that isolate core functionality.
- Performance Measurement - Captures performance flows and operations to generate baseline profiles and track optimizations.
- Test Execution Recording and Replay - Saves and loads execution trace data to retrace past application sessions.
- Mixed UI Interoperability - Bridges classic view-based containers and composable screens in both directions so either paradigm can nest the other seamlessly.
- Interaction and Event Handling - Processes user interactions and triggers state transitions using named event handlers and actions that ensure stable updates.
