Flutter Infinite Scroll Pagination Hook

paging_controller_hook.dart

import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:infinite_scroll_pagination/infinite_scroll_pagination.dart';

typedef PaginatedDataFunction = Function({required int currentPage});

usePagingController<T>(PaginatedDataFunction paginatedDataFunction,
    {List<Object?>? keys}) {
  return use(_PagingControllerHook<T>(paginatedDataFunction, keys));
}

class _PagingControllerHook<T> extends Hook<PagingController> {
  final PaginatedDataFunction paginatedDataFunction;

  const _PagingControllerHook(
    this.paginatedDataFunction, [
    List<Object?>? keys,
  ]) : super(keys: keys);

  @override
  _PagingControllerHookState createState() {
    return _PagingControllerHookState<T>(paginatedDataFunction);
  }
}

class _PagingControllerHookState<T>
    extends HookState<PagingController, _PagingControllerHook> {
  final PaginatedDataFunction paginatedDataFunction;
  late final PagingController _controller;

  _PagingControllerHookState(this.paginatedDataFunction);

  @override
  void initHook() {
    super.initHook();

    _controller = PagingController<int, T>(firstPageKey: 1);

    _controller.addPageRequestListener((pageKey) async {
      try {
        final newItems = await paginatedDataFunction(currentPage: pageKey);
        final isLastPage = newItems.length < 10;
        if (isLastPage) {
          _controller.appendLastPage(newItems);
        } else {
          final nextPageKey = pageKey + 1;
          _controller.appendPage(newItems, nextPageKey);
        }
      } catch (error) {
        _controller.error = error;
      }
    });
  }

  @override
  PagingController build(BuildContext context) => _controller;

  @override
  void dispose() {
    _controller.dispose();
    super.dispose();
  }

  @override
  String get debugLabel => 'usePagingController';
}