Flutter分页控制插件pagination_controller的使用

pagination_controller 插件为 Flutter 应用程序提供了抽象且可重用的分页逻辑。它支持不同的分页方法，如基于偏移量和基于页数的分页。此外，它还集成了 ScrollController，以便在用户滚动时自动加载新数据。

特性

• 支持不同的分页方法：OffsetPagination、PagePagination。
• 基于 Mixin 的分页处理：允许轻松集成到 Cubit 和 Flutter 状态管理方法中。
• 错误和空状态处理：轻松管理错误、空列表和数据检索成功等不同状态。
• 可定制化：允许使用不同的项目类型、分页策略和错误类型。

安装

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  pagination_controller: ^0.0.1

然后运行 flutter pub get 来安装包。

使用

示例：使用 Cubit 进行分页

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

class TemplateData {
  final int index;

  const TemplateData(this.index);
}

List<TemplateData> _testDataList =
    List<TemplateData>.generate(30, (index) => TemplateData(index));

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

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

  @override
  State<MainApp> createState() => _MainAppState();
}

class _MainAppState extends State<MainApp> {
  final controller =
      CubitPaginationController<TemplateData, OffsetPagination, String>(
    firstPagePointer: const OffsetPagination(offset: 0),
    getPageFunc: (pagination) {
      return Future.delayed(
          const Duration(seconds: 2),
          () => SuccessPaginationResult(
                itemList: _testDataList
                    .skip(pagination.offset)
                    .take(pagination.limit)
                    .toList(),
                pagination: pagination,
              ));
    },
  );

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Pagination Example')),
        body: SafeArea(
          child: RefreshIndicator(
            onRefresh: () async => controller.getFirst(),
            child: SingleChildScrollView(
              controller: controller.scrollController,
              child: CubitPaginatedListBuilder<TemplateData, OffsetPagination, String>(
                controller: controller,
                dataBuilder: (context, state, isProcessing) => Column(
                  crossAxisAlignment: CrossAxisAlignment.center,
                  children: [
                    ...state.itemList.map(
                      (e) => Container(
                        alignment: Alignment.center,
                        padding: const EdgeInsets.symmetric(vertical: 40),
                        child: Text(e.index.toString()),
                      ),
                    ),
                    if (isProcessing) const CircularProgressIndicator(),
                  ],
                ),
                emptyBuilder: (context, emptyState, isProcessing) => Container(
                  alignment: Alignment.center,
                  padding: const EdgeInsets.symmetric(vertical: 40),
                  child: const Text('No items available'),
                ),
                errorBuilder: (context, errorState, isProcessing) => Container(
                  alignment: Alignment.center,
                  padding: const EdgeInsets.symmetric(vertical: 40),
                  child: const Text('An error occurred'),
                ),
              ),
            ),
          ),
        ),
      ),
    );
  }
}

示例：使用 ScrollController 进行分页

final flutterController = FlutterPaginationController<ItemType, PagePagination, ErrorType>(
  firstPagePointer: PagePagination(page: 1),
  getPageFunc: (pagination) async {
    // Fetch data from an API or database
  },
);

// 使用 flutterController 与任何可滚动的部件，例如 ListView