Flutter待确认按钮功能插件pending_button的使用

pending_button 是一个用于指示异步操作不同状态的基本按钮。它为用户提供加载状态以及操作结果的反馈。

安装

在 pubspec.yaml 文件中添加 pending_button 作为依赖：

dependencies:
  pending_button: 0.0.7

使用

首先，导入包：

import 'package:pending_button/pending_button.dart';

然后，添加 PendingButton 小部件并传递异步函数，无需等待该未来的结果：

PendingButton(
    asynFunction: myFunction,
    child: const Text('Save'),
),

Future<bool> myFunction() =>
    Future.delayed(const Duration(seconds: 2)).then(
        (value) {
          return true;
        },
    );

支持的不同类型按钮

• PendingButton
• PendingButton.outlined
• PendingButton.text
• PendingButton.icon

错误处理

当发生错误时，可以使用 onError 方法显示 snackbar 或 toast：

PendingButton(
    asynFunction: myFunction,
    onError: (Exception error) {
        ScaffoldMessenger.of(context).showSnackBar(
            SnackBar(
                content: Text(error.toString()),
            ),
        );
    },
    child: Text('Authentificate'),
),

Future<void> myFunction() =>
    Future.delayed(const Duration(seconds: 2)).then(
        (value) {
            throw Exception('Authentification fail');
        },
    );

成功响应

onSuccess 方法返回来自未来的响应数据：

PendingButton(
    asynFunction: myFunction,
    onSuccess: (result) {
        debugPrint(result.toString());
    },
    child: Text('Authentificate'),
),

操作前检查

beforeFunction 可以用来在执行主要函数之前检查条件，应返回布尔值：

PendingButton(
    asynFunction: myFunction,
    beforeFunction: () {
        if (password.length < 8) return false;
        if (login.isEmpty) return false;
        return true;
    },
    child: Text('Authentificate'),
),

装饰（可选）

不同的装饰属性可以根据需要进行设置：

示例 Demo

以下是一个完整的示例代码：

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

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

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late ThemeMode theme;

  @override
  void initState() {
    super.initState();
    theme = ThemeMode.light;
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Pending Button Demo',
      themeMode: theme,
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(
          seedColor: const Color(0xFF00b266),
          brightness: Brightness.light,
        ),
        useMaterial3: true,
      ),
      darkTheme: ThemeData(
        colorScheme: ColorScheme.fromSeed(
          seedColor: const Color(0xFF00b266),
          brightness: Brightness.dark,
        ),
        useMaterial3: true,
      ),
      home: HomePage(
        isDark: theme == ThemeMode.dark,
        callback: () {
          setState(() {
            theme = (theme == ThemeMode.dark) ? ThemeMode.light : ThemeMode.dark;
          });
        },
      ),
    );
  }
}

class HomePage extends StatelessWidget {
  final bool isDark;
  final VoidCallback callback;
  const HomePage({
    super.key,
    required this.isDark,
    required this.callback,
  });

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Pending button'),
        actions: [
          IconButton(
            icon: Icon(
              isDark ? Icons.light_mode_rounded : Icons.dark_mode_rounded,
            ),
            tooltip: 'Theme',
            onPressed: callback,
          ),
          const SizedBox(width: 30),
        ],
      ),
      body: Center(
        child: Column(
          children: [
            PendingButton(
              asynFunction: futureFunction,
              width: 200,
              borderRadius: 15.0,
              backgroundColor: Colors.blueAccent,
              onSuccess: (value) {
                debugPrint(value.toString());
              },
              child: const Text('Filled succes'),
            ),
            PendingButton(
              asynFunction: () {
                return futureFunction2(1, 1, 1, 1, 1, 1, 1, 1, 1);
              },
              width: 200,
              child: const Text('Filled with args'),
            ),
            const SizedBox(height: 10),
            PendingButton(
              asynFunction: futureErrorFunction,
              child: const Text('Short'),
            ),
            const SizedBox(height: 10),
            PendingButton(
              asynFunction: futureErrorFunction,
              child: Row(
                mainAxisSize: MainAxisSize.min,
                children: [
                  Icon(
                    Icons.login,
                    color: Theme.of(context).colorScheme.onPrimary,
                  ),
                  const SizedBox(width: 20),
                  const Text('Connexion'),
                ],
              ),
            ),
            const SizedBox(height: 10),
            PendingButton.outlined(
              asynFunction: futureErrorFunction,
              child: const Text('Oulined error'),
            ),
            const SizedBox(height: 10),
            PendingButton.outlined(
              asynFunction: futureErrorFunction,
              child: const Text('Oulined Success'),
            ),
            const SizedBox(height: 10),
            PendingButton.text(
              asynFunction: futureFunction,
              child: const Text('Text success'),
            ),
            const SizedBox(height: 10),
            PendingButton.text(
              asynFunction: futureErrorFunction,
              child: const Text('wrong password'),
            ),
            const SizedBox(height: 10),
            PendingButton.icon(
              asynFunction: futureFunction,
              child: const Icon(Icons.add),
            ),
            const SizedBox(height: 10),
            PendingButton.icon(
              asynFunction: myFunction,
              onError: (Exception error) {
                ScaffoldMessenger.of(context).showSnackBar(
                  SnackBar(
                    content: Text(error.toString()),
                  ),
                );
              },
              onSuccess: (result) {},
              child: const Icon(Icons.delete),
            ),
            PendingButton.icon(
              asynFunction: () {
                debugPrint('hello');
              },
              child: const Icon(Icons.add),
            ),
          ],
        ),
      ),
    );
  }

  Future<bool> futureFunction() =>
      Future.delayed(const Duration(seconds: 2)).then(
        (value) {
          return true;
        },
      );

  Future<bool> futureFunction2(int text1, int text2, int text3, int text4,
          int text5, int text6, int text7, int text8, int text9) =>
      Future.delayed(const Duration(seconds: 2)).then(
        (value) {
          throw const Failures(message: 'Authentification fail');
        },
      );

  Future<void> futureErrorFunction() =>
      Future.delayed(const Duration(seconds: 2)).then(
        (value) {
          throw const Failures(message: 'Authentification fail');
        },
      );

  Future<void> myFunction() => Future.delayed(const Duration(seconds: 2)).then(
        (value) {
          throw Exception('Authentification fail');
        },
      );
}

class Failures implements Exception {
  final String message;
  const Failures({required this.message});
}

以上代码展示了如何使用 pending_button 插件创建各种类型的按钮，并处理成功和失败的情况。