Skip to main content

flutter_queue_it 1.0.0 copy "flutter_queue_it: ^1.0.0" to clipboard
flutter_queue_it: ^1.0.0 copied to clipboard

Flutter integration for QueueIt. Provides widgets that rebuild, or call you back, when the queue is updated.

example/example.md

flutter_queue_it example #

This app processes "uploads" two at a time and lists them with their status:

// lib/main.dart
import 'package:flutter_queue_it/flutter_queue_it.dart';
import 'package:material_ui/material_ui.dart';

void main() => runApp(const MaterialApp(home: UploadsPage()));

class UploadsPage extends StatefulWidget {
  const UploadsPage({super.key});

  @override
  State<UploadsPage> createState() => _UploadsPageState();
}

class _UploadsPageState extends State<UploadsPage> {
  /// Keep the queue in your `State`, so it survives rebuilds
  final _queue = QueueIt<String>(
    parallel: 2,
    itemHandler: (item) async {
      /// Fake upload time
      await Future<void>.delayed(const Duration(seconds: 1));
    },
  );
  var _count = 0;

  @override
  void dispose() {
    /// The widgets never dispose of the queue, so do it here
    _queue.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Uploads')),
      body: QueueItWidget<String>(
        queue: _queue,
        builder: (context, snapshot) {
          /// `builder` will be called each time the queue updates
          final items = _queue.items().toList();
          return Column(
            children: [
              /// The progress of the current batch: the uploads added since the
              /// queue last ran out of work
              if (_queue.isProcessing)
                LinearProgressIndicator(
                  value: _queue.currentBatchItems.progress,
                ),
              Expanded(
                child: ListView.builder(
                  itemCount: items.length,
                  itemBuilder: (context, index) {
                    final item = items[index];
                    return ListTile(
                      title: Text(item.data),
                      subtitle: Text('Item status: ${item.status.name}'),
                    );
                  },
                ),
              ),
            ],
          );
        },
      ),
      floatingActionButton: FloatingActionButton(
        /// Add an item and start the queue. The queue stops by itself once every
        /// item is processed, and starting it while it's running does nothing
        onPressed: () => _queue
          ..add('photo_${++_count}.jpg')
          ..start(),
        tooltip: 'Add upload',
        child: const Icon(Icons.add),
      ),
    );
  }
}

It gets its Material widgets from the material_ui package, which needs Flutter 3.47 or later. On older versions, skip it and import package:flutter/material.dart instead.

For a bigger example, check out the photo uploader: three uploads at a time, with progress, retries, cancel and pause.

3
likes
160
points
802
downloads
screenshot

Documentation

API reference

Publisher

verified publishersharpsan.dev

Weekly Downloads

Flutter integration for QueueIt. Provides widgets that rebuild, or call you back, when the queue is updated.

Repository (GitHub)
View/report issues

Topics

#queue #widget #concurrency #async #retry

License

MIT (license)

Dependencies

flutter, queue_it

More

Packages that depend on flutter_queue_it