easy_load_more 0.1.0

Simple & easy to use flutter load more that supports ListView & SliverList.

easy_load_more

easy_load_more is a simple, easy to use, and customizeable load more that supports ListView & SliverList.

Or try the demo on DartPad

Get started

Depend on it

Add this to your package's pubspec.yaml file:

easy_load_more: ^0.1.0

Install it

You can install packages from the command line:

$ flutter pub get

Alternatively, your editor might support flutter pub get.

Import it

Now in your Dart code, you can use:

import 'package:easy_load_more/easy_load_more.dart';

How to use

  @override
  Widget build(BuildContext context) {
    return Container(
      padding: const EdgeInsets.all(20.0),
      color: Colors.blue[50],
      child: RefreshIndicator(
        onRefresh: _refresh,
        child: EasyLoadMore(
          isFinished: count >= 60,
          onLoadMore: _loadMore,
          runOnEmptyResult: false,
          child: ListView.separated(
            separatorBuilder: ((context, index) => const SizedBox(
                  height: 20.0,
                )),
            itemBuilder: (BuildContext context, int index) {
              return Container(
                height: 100.0,
                alignment: Alignment.center,
                decoration: BoxDecoration(
                  color: Colors.blue[100],
                  borderRadius: const BorderRadius.all(
                    Radius.circular(15.0),
                  ),
                ),
                child: Text(
                  list[index].toString(),
                  style: TextStyle(
                    color: Colors.blue[700],
                    fontSize: 20.0,
                    fontWeight: FontWeight.w600,
                  ),
                ),
              );
            },
            itemCount: count,
          ),
        ),
      ),
    );
  }

  Future<bool> _loadMore() async {
    log("onLoadMore callback run");

    await Future.delayed(
      const Duration(
        seconds: 0,
        milliseconds: 2000,
      ),
    );

    _loadItems();
    return true;
  }

  Future<void> _refresh() async {
    await Future.delayed(
      const Duration(
        seconds: 0,
        milliseconds: 2000,
      ),
    );

    list.clear();
    _loadItems();
  }

  void _loadItems() {
    log("loading items");

    setState(() {
      list.addAll(List.generate(20, (i) => i + 1));
      log("data count = ${list.length}");
      log("----------");
    });
  }

More parameters:

const EasyLoadMore({
  Key? key,

  /// `Color` - (Optional) The loading widget's color.
  this.loadingWidgetColor;

  /// `double` - (Optional) The dimension's size of the loading widget.
  this.loadingWidgetSize;

  /// `double` - (Optional) The height of the loading widget's container/wrapper.
  this.loadingWidgetContainerHeight;

  /// `int` - (Optional) The loading animation delay.
  this.loadingAnimationDelay;

  /// `string` - (Optional) Idle status text to show when the widget is idle.
  this.idleStatusText,

  /// `string` - (Optional) Loading status text to show when the process is loading.
  this.loadingStatusText,

  /// `string` - (Optional) Loading status text to show when the processing is failed.
  this.failedStatusText,

  /// `string` - (Optional) Finished status text to show when there's no more items to load.
  this.finishedStatusText,

  /// `bool` - (Optional) Manually turn-off the next load more.
  /// Set this to `true` to set the load more as `finished` (no more items). Default is `false`.
  /// The use-case is when there's no more items to load, you might want `EasyLoadMore` to not running again.
  this.isFinished,

  /// `bool` - (Optional) - Whether or not to run the load more even though the result is empty/finished.
  this.runOnEmptyResult,

  /// `Future<bool> Function()` - (Optional) - Callback function to run during the load more process.
  /// To mark the status as success or delay, set the return to `true`.
  /// To mark the status as failed, set the return to `false`.
  this.onLoadMore,

  /// `Widget` - The child widget.
  /// Supported widgets: `ListView`, `ListView.builder`, & `ListView.separated`.
  required this.child,
}) : super(key: key);

Source

Source code and example of this library can be found in git:

$ git clone https://github.com/usefulteam/easy_load_more.git

License

MIT License

Credits

Thanks to OpenFlutter for the flutter_listview_loadmore package (APACHE 2.0 Licensed).

My package was based on it. You can also visit their package pub.dev page.