custom_loadmore 0.0.2

Package to assist load more, paging logic for your Flutter projects.

INTRODUCTION

The custom_loadmore component is a convenient flutter widget that make implementation load more feature more easier, it provide a flexible and easy to use interface and can integrate with any Flutter project. This give developer focus more on another aspect when development feature also provide ability to control the layout and appearance of UI.

Features

• Load more feature
• Layout modifies ability
• Handing build in ui function.

Installation

To use this in your project, you need follow these steps:

1. In your pubspec.yaml file add follow codes

dependencies:
  custom_loadmore: ^0.0.2

1. Run flutter pub get.

2. Make sure import this file when use this package.
   import 'package:custom_loadmore/custom_loadmore.dart'

Usage

A longer example can be found in the /example folder.

Modifying the Layout

To change the default layout behavior (the list view layout), follow these steps:

1. Create new class that extend CustomScrollableLayoutBuilderInjector<T>. Then override the buildMainContent method. This method return an CustomLoadMoreContent<T> that abstract the layout appearance.
2. Next you must create a specific implementation of CustomLoadMoreContent with scarify your demands by create a class that extend CustomLoadMoreContent. The abstract class provide you some necessary property to build your layout.

• items : The List<T> where you can get the items need to use when build the item widget in the list. Usually it data come from the call to the server.
• mainAxisDirection: provide you the scroll direction.
• scrollController: support you the ability to manuals the scroll behavior.
• streamController: help you more convenience to change the state of load more widget.
• state : supplies you the current state of the widget.
• widget: provide you to accessibility to widget configuration where you can get all build delegate and other properties.

1. Attach it new layout injector to CustomLoadMore.
   Here is example code that demonstrate these above step.

1.
class CustomScrollableListViewBuilderInjector<T>
    extends CustomScrollableLayoutBuilderInjector<T> {
  @override
  CustomLoadMoreContent<T> buildMainContent(
    BuildContext context,
    LoadMoreState state,
    List<T>? dataItems,
    ScrollController scrollController,
    StreamController<LoadMoreEvent> streamController,
  ) {
    return LoadMoreList<T>(
      widgetParent.key,
      state: state,
      mainAxisDirection: widgetParent.mainAxisDirection,
      items: dataItems,
      widget: widgetParent,
      scrollController: scrollController,
      streamController: streamController,
    );
  }
}

2.
class LoadMoreList<T> extends CustomLoadMoreContent<T>{
  const LoadMoreList(super.key,
      {required super.state,
      required super.mainAxisDirection,
      required super.items,
      required super.scrollController,
      required super.streamController,
      required super.widget});

  ///
   <!-- ...some other methods -->
  ///
  @override
  Widget build(BuildContext context){
    return yourWidgetLayout(content);
  }
}

3.
CustomLoadMore<T>(
    customScrollableLayoutBuilderInjector: YourNewLayoutInjector(),
    <!-- Some other properties -->
);