Flutter下拉刷新插件liquid_pull_refresh的使用

Liquid Pull Refresh

一个美丽且可自定义的带有图像或小部件的加载指示器。

安装

1. 依赖于它

在你的 pubspec.yaml 文件中添加以下内容：

dependencies:
  liquid_pull_refresh: ^<latest-version>

2. 安装它

你可以通过命令行安装包：

使用 pub：

$ pub get

使用 Flutter：

$ flutter packages get

3. 导入它

现在在你的 Dart 代码中，你可以使用：

import 'package:liquid_pull_refresh/liquid_pull_refresh.dart';

使用

要在你的 Flutter 应用中添加这个自定义刷新指示器，你只需要将 ListView 或 GridView 包裹在 LiquidPullRefresh 中。同时，你需要提供 onRefresh 参数的值，这是一个刷新回调函数。

注意 - LiquidPullRefresh 只能用于垂直滚动视图。

例如：

LiquidPullRefresh(
  backgroundColor: widget.loaderColor,
  color: widget.backgroundColor,
  heightLoader: 150,
  springAnimationDurationInMilliseconds: 400,
  showChildOpacityTransition: false,
  key: widget.refreshIndicatorLiquidKey, // 如果需要可以添加 key
  onRefresh: widget.onRefresh, // 刷新回调
  child: widget.childAdapter, // 滚动视图
);

如果你不希望子组件的透明度过渡，可以设置 showChildOpacityTransition: false。以下是两种形式的预览：

showChildOpacityTransition: true	showChildOpacityTransition: false

文档

LiquidPullToRefresh 类

有关编辑包代码的帮助，请查看 Flutter 文档。

许可证

Liquid-Pull-To-Refresh 采用 MIT 许可证。

示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 liquid_pull_refresh 插件：

import 'dart:async';
import 'dart:math';

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

void main() => runApp(const MyApp());

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Liquid Pull Refresh'),
    );
  }
}

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

  final String? title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final GlobalKey<ScaffoldState> _scaffoldKey = GlobalKey<ScaffoldState>();
  final GlobalKey<LiquidPullRefreshState> _refreshIndicatorKey =
      GlobalKey<LiquidPullRefreshState>();

  static int refreshNum = 10; // 刷新时变化的数字
  Stream<int> counterStream =
      Stream<int>.periodic(const Duration(seconds: 3), (x) => refreshNum);

  ScrollController? _scrollController;

  @override
  void initState() {
    super.initState();
    _scrollController = ScrollController();
  }

  static final List<String> _items = <String>[
    'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N'
  ];

  Future<void> _handleRefresh() {
    final Completer<void> completer = Completer<void>();
    Timer(const Duration(seconds: 3), () {
      completer.complete();
    });
    setState(() {
      refreshNum = Random().nextInt(100);
    });
    return completer.future.then<void>((_) {
      ScaffoldMessenger.of(_scaffoldKey.currentState!.context).showSnackBar(
        SnackBar(
          content: const Text('Refresh complete'),
          action: SnackBarAction(
            label: 'RETRY',
            onPressed: () {
              _refreshIndicatorKey.currentState!.show();
            },
          ),
        ),
      );
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      key: _scaffoldKey,
      appBar: AppBar(
        title: Stack(
          children: <Widget>[
            const Align(
              alignment: Alignment(-1.0, 0.0),
              child: Icon(Icons.reorder),
            ),
            Align(
              alignment: const Alignment(-0.3, 0.0),
              child: Text(widget.title!),
            ),
          ],
        ),
      ),
      body: LiquidPullRefresh(
        key: _refreshIndicatorKey,
        onRefresh: _handleRefresh,
        showChildOpacityTransition: false,
        child: StreamBuilder<int>(
          stream: counterStream,
          builder: (context, snapshot) {
            return ListView.builder(
              padding: kMaterialListPadding,
              itemCount: _items.length,
              controller: _scrollController,
              itemBuilder: (BuildContext context, int index) {
                final String item = _items[index];
                return ListTile(
                  isThreeLine: true,
                  leading: CircleAvatar(child: Text(item)),
                  title: Text('This item represents $item.'),
                  subtitle: Text(
                      'Even more additional list item information appears on line three. ${snapshot.data}'),
                );
              },
            );
          },
        ),
      ),
    );
  }
}

这个示例代码创建了一个简单的 Flutter 应用，其中包含一个带有 LiquidPullRefresh 的 ListView。当用户下拉刷新时，会触发 _handleRefresh 方法，更新列表项并显示一个 SnackBar 提示刷新完成。