list_bloc 1.0.2

Dart native js
Flutter Android iOS web

A BLoC library for loading data from an api end-point with filtering and pagination.

A BLoC library for loading data from an api end-point with filtering and pagination.

The idea for this library is to convert the data loaded from an API into a BLoC to avoid boiler plate, but at the same time keeping things very simple and generic.

The base classes are DataBloc<T,F> with DataEvent<T,F> and DataState<T,F> where T is the type of the data element and F is a class for thr API filtering.

Then, ListBloc<T,F> extends DataBloc<List<T>,F to provide a shorthand for loading list of items.

Further, PaginatedBloc<T,F> extends DataBloc<ListPage<T,F> to provide pagination.

If you have an API instance that does not use filtering, you can replace the filter class with Object.

The three blocs are expecting to be initialized with a DataRepository, ListRepository or PaginatedRepository respectively, all of which should implement a Future load({F filter}) which is slightly different for List or Paginated bloc.

The filters can extend Object or any other class however built_value is quite useful for this as this allows re-building filters based on existing ones quite easily.

In order to generate the OffetLimitFilter run pub run build_runner build

Usage #

A simple usage example:

import 'packages:list_bloc.dart';

// Can be as complex as the API supports
class ItemFilter {
    enum fruits, vegetables;
}
class Item {
    int type;
    int value;
}
class ItemRepository implements ListRepository<Item, ItemFilter> {
    Future List<Item>load({ItemFilter filter}) async => await apiList(type: filter);
}


main() {
    final bloc = ListBloc<Item, ItemFilter>(ItemRepository());

    bloc.load(ItemFilter.fruits);
...
    BlocBuilder<ListBloc<Item, ItemFilter>, DataState<Item, ItemFilter>(
        bloc: bloc,
        builder: (context, state) {
            for(var item in state.data) {
                    ...
            }
        } 
}


TODO: [ ] PaginatedBloc example [ ] ListPage class explanation

Features and bugs #

Please file feature requests and bugs at the issue tracker.

0
likes
90
pub points
38%
popularity

Publisher

aahi.io

A BLoC library for loading data from an api end-point with filtering and pagination.

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

bloc, equatable

More

Packages that depend on list_bloc