riverpod_paging_utils 0.3.0

A Flutter package that provides utilities for implementing pagination with Riverpod. It includes a generic PagingHelperView widget and mixins for page-based, offset-based, and cursor-based pagination.

Riverpod Paging Utils

A Flutter package that provides utilities for implementing pagination with Riverpod. It includes a generic PagingHelperView widget and mixins for page-based, offset-based, and cursor-based pagination.

Features

• PagingHelperView: A generic widget that simplifies the implementation of pagination in Flutter apps.
• PagePagingNotifierMixin: A mixin for implementing page-based pagination logic.
• OffsetPagingNotifierMixin: A mixin for implementing offset-based pagination logic.
• CursorPagingNotifierMixin: A mixin for implementing cursor-based pagination logic.

Getting Started

Installation

Add the following dependency to your pubspec.yaml file:

dependencies:
  riverpod_paging_utils: ^0.1.0

Then, run flutter pub get to install the package.

Usage

Here's a simple example of how to use the PagingHelperView widget with a Riverpod provider that uses the CursorPagingNotifierMixin:

@riverpod
class SampleNotifier extends _$SampleNotifier with CursorPagingNotifierMixin {
  @override
  Future<CursorPagingData<SampleItem>> build() => fetch(cursor: null);

  @override
  Future<CursorPagingData<SampleItem>> fetch({required String? cursor}) async {
    // Fetch paginated data from your data source
    // ...
  }
}

class SamplePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Sample Page'),
      ),
      body: PagingHelperView(
        provider: sampleNotifierProvider,
        contentBuilder: (data, endItemView) => ListView.builder(
          itemCount: data.items.length + (endItemView != null ? 1 : 0),
          itemBuilder: (context, index) {
            if (endItemView != null && index == data.items.length) {
              return endItemView;
            }
            return ListTile(
              title: Text(data.items[index].name),
              subtitle: Text(data.items[index].id),
            );
          },
        ),
      ),
    );
  }
}