clean_bloc library
Wrapper for blocs to make them more testable and easier to use.
Classes
-
CleanBloc<
T> -
A
Bloc
which handles a remote call and emits the appropriate state -
CleanBuilder<
B extends BlocBase< CleanState< , T>T> > - A Flutter widget for building CleanBloc states.
-
CleanConsumer<
B extends BlocBase< CleanState< , T>T> > - A Flutter widget for handling CleanBloc state changes.
-
CleanCubit<
T> -
A
Cubit
which handles a remote call and emits the appropriate state - CleanEvent
- Base event for clean_bloc
- CleanEventInit
- Initial event
-
CleanListener<
B extends BlocBase< CleanState< , T>T> > - A Flutter widget for listening to CleanBloc state changes.
-
CleanState<
T> - Base state for clean_bloc
-
CleanStateError<
T> -
CleanStateInitial<
T> -
CleanStateLoading<
T> -
CleanStateSuccess<
T> - DefaultBuilders
- Default builders
- DefaultErrorView
- DefaultLoadingView
-
PaginatedCleanBloc<
T> -
A
Bloc
which handles paginated data. -
PaginatedCleanBuilder<
B extends BlocBase< PaginatedCleanState< , T>T> > - A Flutter widget for building PaginatedCleanBloc states.
-
PaginatedCleanConsumer<
B extends BlocBase< PaginatedCleanState< , T, E>T> > - A Flutter widget for building and listening to PaginatedCleanBloc state changes.
-
PaginatedCleanCubit<
T> -
A
Cubit
which handles paginated data. -
PaginatedCleanError<
T> - PaginatedCleanEvent
- Base event for paginated_clean_bloc
- PaginatedCleanEventInit
- Initial event
- PaginatedCleanEventLoadMore
- Load more event
-
PaginatedCleanInitial<
T> -
PaginatedCleanListener<
B extends BlocBase< PaginatedCleanState< , T>T> > - A Flutter widget for listening to PaginatedCleanBloc state changes.
-
PaginatedCleanLoading<
T> -
PaginatedCleanState<
T> - Base state for paginated_clean_bloc
-
PaginatedCleanSuccess<
T>
Mixins
-
CleanBlocMixin<
S> - CompleterMixin
- A mixin to complete a completer and get a future
- PaginationMixin
- A mixin to handle pagination
-
SafeEmitMixin<
S> - A mixin to safely emit a state
Functions
-
concurrent<
Event> () → EventTransformer< Event> - Process events concurrently.
-
debounceRestartable<
T> ([Duration duration = _debounceDuration]) → EventTransformer< T> - EventTransformer for debouncing events
-
droppable<
Event> () → EventTransformer< Event> - Process only one event and ignore (drop) any new events until the current event is done.
-
restartable<
Event> () → EventTransformer< Event> - Process only one event by cancelling any pending events and processing the new event immediately.
-
sequential<
Event> () → EventTransformer< Event> - Process events one at a time by maintaining a queue of added events and processing the events sequentially.
Typedefs
-
BlocCall<
T> = EitherResponse< T> Function() - CleanErrorBuilder = Widget Function(BuildContext context, BaseError error)
- default cubit/bloc error builder
-
CleanErrorHandler<
T> = CleanState< T> Function(BaseError error) - Error callback for cubit and bloc
- CleanLoadingBuilder = Widget Function(BuildContext context)
- default cubit/bloc loading builder
-
CleanSuccessBuilder<
T> = Widget Function(BuildContext context, T data) - default cubit/bloc success builder
-
CleanSuccessHandler<
T> = CleanState< T> Function(T data) - Success callback for cubit and bloc
-
DefaultBlocBuilder<
T> = Widget Function(BuildContext, CleanState< T> ) - default bloc builder
-
DefaultPaginatedBlocBuilder<
T> = Widget Function(BuildContext, PaginatedCleanState< T> ) - default paginated bloc builder
-
OnCleanSuccessListener<
T> = void Function(BuildContext context, T data) - Success callback
- OnErrorListener = void Function(BuildContext context, BaseError error)
- Error callback
- OnLoadingListener = void Function(BuildContext context)
- Loading callback
-
OnPaginatedSuccessListener<
T> = void Function(BuildContext context, List< T> data, bool isLoadingMore) - Paginated Success callback
-
PaginatedCleanErrorHandler<
T> = PaginatedCleanState< T> Function(BaseError error) - Error callback for paginated cubit and bloc
-
PaginatedCleanSuccessBuilder<
T> = Widget Function(BuildContext context, List< T> data, bool isLoadingMore) - default paginated cubit/bloc success builder
-
PaginatedCleanSuccessHandler<
T> = PaginatedCleanState< T> Function(PaginatedResponse<T> response) - Success callback for paginated cubit and bloc