listutils 0.1.1

Infinite scrolling list view with multiple data source mode support using adapters. Also supports header, footer widgets.

MOVED TO listview_utils!!!

ListUtils

Additional utils for flutter List component

Getting Started

Add those lines to pubspec.yaml file and run flutter pub get.

dependencies:
  listutils: ^0.0.3

Check out Installing tab for more details.

Import listutils package to your application by adding this line:

import 'package:listutils/listutils.dart';

This will import required classes to use listutils.

Properties

CustomListView(
  // Items fetched per request (default: 30)
  pageSize: 30,

  // Header widget (default: null)
  header: Container(...),

  // Footer widget (default: null)
  footer: Container(...),

  // The widget that displayed if the list is empty (default: null)
  empty: Text('List is empty'),

  // Item provider adapter (default: null)
  adapter: ListAdapter(
    fetchItems: (int offset, int limit) {
      return ListItems([ ... ]);
    },
  ),

  // A callback function to build list items (required)
  itemBuilder: (BuildContext context, int index, dynamic item) {
    // If items provided by adapter the `item` argument will be matching element
    return ListTile(
      title: Text(item['title']),
    );
  },

  // Static list of items
  children: <Widget>[
    ...
  ],

  // Item count
  itemCount: 45,

  // A callback function called when required to load more items
  onLoadMore: () async {
    ...
  },

  // A callback function called when pull to refresh is triggered
  onRefresh: () async {
    ...
  },

  // Enable / disable pull to refresh (default: false)
  disableRefresh: false,
),

Adapters

Listutils currently only supports network adapter. Or you could write your own adapter by implementing BaseListAdapter mixin or using ListAdapter class.

Here's simple network adapter code using jsonplaceholder data.

NetworkListAdapter(
  url: 'https://jsonplaceholder.typicode.com/posts',
  limitParam: '_limit',
  offsetParam: '_start',
),

Example

CustomListView(
  loadingBuilder: CustomListLoading.defaultBuilder,
  itemBuilder: (context, index, item) {
    return ListTile(
      title: Text(item['title']),
    );
  },
  adapter: NetworkListAdapter(
    url: 'https://jsonplaceholder.typicode.com/posts',
    limitParam: '_limit',
    offsetParam: '_start',
  ),
);