Flutter进度对话框插件flutter_future_progress_dialog的使用

flutter_future_progress_dialog

在等待Future完成的过程中显示带有动画的进度对话框，并在完成后返回该Future的结果。

特性

开始使用

安装库

flutter pub add flutter_future_progress_dialog

导入库

import 'package:flutter_future_progress_dialog/flutter_future_progress_dialog.dart';

使用方法

可以在这里找到完整的示例。

以下是一个简短的例子，展示如何使用showProgressDialog。

基本用法

在您的函数中调用showProgressDialog。传递context和future参数。然后处理结果。

您还可以使用showCupertinoProgressDialog来显示带有Cupertino样式的对话框，或使用showAdaptiveProgressDialog来显示与主机操作系统匹配的对话框。

Future<String> myFuture() async {
  await Future.delayed(const Duration(seconds: 2));
  return 'my string';
}

Future<void> yourFunction(BuildContext context) async {
  final result = await showProgressDialog(
    context: context,
    future: () => myFuture(),
  );
  if (!mounted) {
    return;
  }
  switch (result) {
    case ResultError(error: final error):
      await showDialog(
        context: context,
        builder: (context) {
          return AlertDialog(
            content: Text(
              '$error',
              textAlign: TextAlign.center,
            ),
            actions: [
              TextButton(
                onPressed: () {
                  Navigator.of(context).pop();
                },
                child: const Text(
                  'OK',
                ),
              ),
            ],
          );
        },
      );
    case ResultOk<String>(value: final value):
      // value变量将持有'my string'值
      break;
  } 
}

自定义进度对话框

您可以传递一个builder来自定义进度对话框。

Future<Result<LongRunningTaskResult>> buttonCallback({
  required BuildContext context,
}) async {
  return await showProgressDialog(
    future: () => myLongRunningTask(),
    context: context,
    builder: (context) => AlertDialog(
      content: Text('I am loading now'),
    ),
  );
}

示例代码

以下是完整的示例代码：

import 'package:flutter/material.dart';
import 'package:flutter_future_progress_dialog/flutter_future_progress_dialog.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

enum DialogType { material, cupertino, adaptive }

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  Future<int> myFuture(int value) async {
    await Future.delayed(const Duration(seconds: 2));
    if (value >= 3) {
      throw 'Something went wrong';
    }
    return value + 1;
  }

  Future<void> _onIncrementCounter({required BuildContext context, required DialogType dialogType}) async {
    final result = switch (dialogType) {
      DialogType.cupertino => await showCupertinoProgressDialog(
          context: context,
          future: () => myFuture(_counter),
        ),
      DialogType.material => await showProgressDialog(
          context: context,
          future: () => myFuture(_counter),
        ),
      DialogType.adaptive => await showAdaptiveProgressDialog(
          context: context,
          future: () => myFuture(_counter),
        ),
    };
    if (!mounted) {
      return;
    }
    switch (result) {
      case ResultOk<int>(value: final value):
        setState(() {
          _counter = value;
        });
        break;
      case ResultError(error: final error):
        await showDialog(
          context: context,
          builder: (context) {
            return AlertDialog(
              content: Text(
                '$error',
                textAlign: TextAlign.center,
              ),
              actions: [
                TextButton(
                  onPressed: () {
                    Navigator.of(context).pop();
                    setState(() {
                      _counter = 0;
                    });
                  },
                  child: const Text(
                    'OK',
                  ),
                )
              ],
            );
          },
        );
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text('Your Future will return result here', style: Theme.of(context).textTheme.bodyLarge),
            const SizedBox(height: 4),
            Text('counter: $_counter', style: Theme.of(context).textTheme.headlineSmall),
            const SizedBox(height: 16),
            Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: [
                TextButton(
                  onPressed: () => _onIncrementCounter(
                    context: context,
                    dialogType: DialogType.material,
                  ),
                  child: const Text('Material'),
                ),
                TextButton(
                  onPressed: () => _onIncrementCounter(
                    context: context,
                    dialogType: DialogType.cupertino,
                  ),
                  child: const Text('Cupertino'),
                ),
                TextButton(
                  onPressed: () => _onIncrementCounter(
                    context: context,
                    dialogType: DialogType.adaptive,
                  ),
                  child: const Text('Adaptive'),
                ),
              ],
            ),
          ],
        ),
      ),
    );
  }
}