/paging_library

A Flutter package for paginating a list view

Primary LanguageDartMIT LicenseMIT

paging

A Flutter package for paginating a list view

pub package

Installation

Add this to your package's pubspec.yaml file

dependencies:
  ...
  paging: ^latest.version.here

Usage

First import paging.dart

  import 'package:paging/paging.dart';

Simple to use. You can pass a type <T> as a parameter to the widget, by default dynamic is assumed.

There are two required parameters:

  • pageBuilder: requires a Future of List<T> and gives you the current size of list
  • itemBuilder: requires a widget and gives you the item of type <T> to be displayed
  // mocking a network call
  Future<List<String>> pageData(int previousCount) async {
    await Future.delayed(Duration(seconds: 0, milliseconds: 2000));
    List<String> dummyList = List();
    if (previousCount < 30) {
      // stop loading after 30 items
      for (int i = previousCount; i < previousCount + _COUNT; i++) {
        dummyList.add('Item $i');
      }
    }
    return dummyList;
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Pagination List')),
      body: Pagination<String>(
        pageBuilder: (currentSize) => pageData(currentSize),
        itemBuilder: (index, item){
          return Container(
                    color: Colors.yellow,
                    height: 48,
                    child: Text(item),
                 );
        },
      ),
    );
  }

Screenshots

Getting Started

This project is a starting point for a Dart package, a library module containing code that can be shared easily across multiple Flutter or Dart projects.

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.