Flutter加载进度覆盖层插件overlay_loading_progress的使用

overlay_loading_progress是一个用于Flutter的加载进度指示器插件，可以轻松地根据需求进行自定义。本文将介绍如何使用该插件，并提供完整的示例代码。

使用步骤

1. 添加依赖

首先，在pubspec.yaml文件中添加插件依赖：

dependencies:
  overlay_loading_progress: ^1.0.1

2. 导入包

在需要使用的Dart文件中导入该插件：

import 'package:overlay_loading_progress/overlay_loading_progress.dart';

3. 开始和停止加载指示器

使用OverlayLoadingProgress.start(context)方法开始加载指示器，并使用OverlayLoadingProgress.stop()方法停止加载指示器。

// 开始加载指示器
OverlayLoadingProgress.start(context);

// 停止加载指示器
OverlayLoadingProgress.stop();

完整示例

以下是一个完整的示例，展示了如何在按钮点击事件中启动和停止加载指示器。

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

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

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: onTapStartBtn,
              child: const Text('Start Loading Progress'),
            ),
            const SizedBox(height: 25),
            ElevatedButton(
              onPressed: onTapStartGifLoadingProgressBtn,
              child: const Text('Start Gif Loading Progress'),
            ),
            const SizedBox(height: 25),
            ElevatedButton(
              onPressed: onTapStartCustomLoadingProgressBtn,
              child: const Text('Start Custom Loading Progress'),
            ),
          ],
        ),
      ),
    );
  }

  // 普通加载指示器
  onTapStartBtn() async {
    OverlayLoadingProgress.start(context, barrierDismissible: false);
    await Future.delayed(const Duration(seconds: 5));
    OverlayLoadingProgress.stop();
  }

  // 使用GIF作为加载指示器
  onTapStartGifLoadingProgressBtn() async {
    OverlayLoadingProgress.start(
      context,
      gifOrImagePath: 'assets/loading.gif',
      loadingWidth: 50,
      barrierDismissible: true,
    );
    await Future.delayed(const Duration(seconds: 3));
    OverlayLoadingProgress.stop();
  }

  // 自定义加载指示器
  onTapStartCustomLoadingProgressBtn() async {
    OverlayLoadingProgress.start(
      context,
      gifOrImagePath: 'assets/loading.gif',
      barrierDismissible: true,
      widget: Container(
        height: 100,
        width: 100,
        color: Colors.black38,
        child: const Center(
          child: CircularProgressIndicator(),
        ),
      ),
    );
    await Future.delayed(const Duration(seconds: 8));
    OverlayLoadingProgress.stop();
  }
}