sequential_flow 1.0.0

A Flutter library for building declarative, step-by-step flows with comprehensive state management and customizable navigation behavior.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.0.0

Added

• Initial release of Sequential Flow library
• Core Components:
  • FlowStep<T> class for defining individual flow steps
  • FlowController<T> for managing flow state and navigation
  • SequentialFlow<T> widget for orchestrating flow execution
• Navigation Control:
  • ActionOnPressBack enum with 8 different back navigation behaviors
  • Custom back action support with customBackAction callback
  • Step-specific navigation configuration
• State Management:
  • In-memory data storage with setData(), getData(), and getAllData()
  • Flow state tracking (loading, completed, error, cancelled, waiting confirmation)
  • Step history for proper back navigation
• Error Handling:
  • Automatic error catching and state management
  • Retry functionality with controller.retry()
  • Custom error UI builders
• User Confirmation:
  • requiresConfirmation widget builder for step confirmation
  • Flow pause/resume functionality
  • Custom confirmation dialogs
• Customizable UI:
  • onStepLoading builder for loading states
  • onStepError builder for error states
  • onStepFinish builder for completion states
  • onStepCancel builder for cancellation states
  • onPressBack builder for custom back navigation UI
• Flow Control:
  • Auto-start configuration with autoStart parameter
  • Manual flow control with start(), cancel(), reset()
  • Step jumping with continueFlow(flowIndex: int)
• Type Safety:
  • Generic type support for step identifiers
  • Compile-time type checking for step enums
• Documentation:
  • Comprehensive API documentation
  • Complete usage examples
  • Real-world use case demonstrations

Features

• Memory Efficient: Data cleared automatically on reset
• Flutter Integration: Full integration with Flutter's widget lifecycle
• Accessibility Support: Compatible with screen readers and semantic labels
• Performance Optimized: Efficient handling of 50+ steps
• Platform Support: iOS, Android, Web, Desktop compatibility
• State Management Agnostic: Works with Provider, Bloc, Riverpod, GetX

Examples Included

• Payment processing flow with error recovery
• User enrollment with email verification
• App initialization with permission handling
• Online exam with time management and auto-save

Technical Specifications

• Minimum Flutter Version: 3.0.0
• Dart SDK: >=2.17.0 <4.0.0
• Dependencies: Flutter SDK only (no external dependencies)
• Package Size: Lightweight implementation
• Test Coverage: Comprehensive test suite included

API Reference

• FlowStep<T> constructor with required and optional parameters
• FlowController<T> with complete state management API
• SequentialFlow<T> widget with customizable builders
• ActionOnPressBack enum with all navigation options

[Unreleased]

Planned Features

• Conditional Flows: Built-in support for branching logic
• Parallel Steps: Execute multiple steps simultaneously
• Persistence Layer: Optional data persistence between app sessions
• Analytics Integration: Built-in flow analytics and tracking
• Step Templates: Pre-built step templates for common use cases
• Visual Flow Builder: Design-time flow visualization tools
• Advanced Validation: Built-in validation framework for step data
• Localization Support: Multi-language flow content support

Under Consideration

• Flow Composition: Ability to compose multiple flows
• Step Dependency Management: Define dependencies between steps
• Custom Animations: Configurable transitions between steps
• Flow Debugging Tools: Development-time debugging utilities
• Performance Metrics: Built-in performance monitoring
• Cloud Integration: Optional cloud-based flow synchronization