FlowRedux

Introduction to FlowRedux

FlowRedux is a powerful tool designed to simplify the creation of asynchronous state machines using Kotlin Multiplatform. With the use of Domain Specific Language (DSL) and coroutines, managing complex state transitions becomes straightforward and efficient.

Key Features

• Kotlin Multiplatform: FlowRedux supports a wide range of platforms including JVM/Android, iOS, watchOS, tvOS, macOS, Linux, and Windows. Future plans include support for JavaScript.

• DSL for State Management: The use of DSL allows for easy specification of state transitions and actions, making the code more readable and maintainable.

• Coroutines for Async Operations: By utilizing Kotlin's coroutines, FlowRedux ensures that asynchronous operations are easy to manage and integrate into state transitions.

Usage Example

To illustrate how FlowRedux works, let's consider a basic state machine implementation.

1. Define States and Actions: Start by defining the states and actions your application will handle. For instance, you might have a Loading state, a ContentState with a list of items, and an Error state for handling exceptions.

2. State Machine Implementation: Using FlowReduxStateMachine, you create a state machine with an initial state. Specify the behavior for each state using the spec function, detailing what should happen upon entering a state or when an action occurs.

3. Coroutine Integration: Launch coroutines to handle state collection and action dispatching. This integration ensures that your UI can react to state changes promptly.

4. ViewModel Integration: In an Android application, integrate FlowRedux with an AndroidX ViewModel to manage UI-related data in a lifecycle-conscious way. Collected states can be observed and actions dispatched within the ViewModel scope.

Dependencies

FlowRedux is available through various dependencies:

• Core Library: flowredux includes the core functionalities along with the DSL for defining state machines.

• Compose Extension: For applications using Jetpack Compose, the compose artifact provides extensions that simplify working with FlowReduxStateMachine.

Installation

For the JVM/Android platform, you can include the following dependencies:

implementation 'com.freeletics.flowredux:flowredux-jvm:<latest-version>'
implementation 'com.freeletics.flowredux:compose:<latest-version>'

For Multiplatform projects:

implementation 'com.freeletics.flowredux:flowredux:<latest-version>'

Snapshot Version

To use the latest snapshot version directly from the main branch, add the snapshot repository URL to your project:

allprojects {
    repositories {
        // Your repositories.
        // ...
        maven {
            url "https://oss.sonatype.org/content/repositories/snapshots/"
        }
    }
}

Then specify the snapshot version like:

implementation 'com.freeletics.flowredux:flowredux:1.2.1-SNAPSHOT'

This provides a comprehensive introduction to using FlowRedux for managing state in applications, leveraging Kotlin’s powerful features for cleaner and more efficient code.