smart_pagination 2.1.1
smart_pagination: ^2.1.1 copied to clipboard
Powerful Flutter pagination library with built-in BLoC state management, 6+ view types (ListView, GridView, PageView, StaggeredGrid, ReorderableListView, Column, Row, Custom), advanced error handling [...]
Changelog #
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
2.1.1 - 2025-12-18 #
Added #
Keyboard Navigation for SmartSearchDropdown ⌨️
Full keyboard navigation support for the search dropdown with focus state persistence.
Keyboard Shortcuts:
| Key | Action |
|---|---|
↓ Arrow Down |
Move focus to next item / Open overlay |
↑ Arrow Up |
Move focus to previous item / Open overlay |
Enter |
Select the focused item |
Escape |
Close the overlay |
Home |
Move focus to first item |
End |
Move focus to last item |
Page Down |
Move focus 5 items down |
Page Up |
Move focus 5 items up |
Key Features:
- Focus Persistence: Focus position is preserved when overlay is closed and reopened
- Visual Feedback: Focused item is highlighted with configurable decoration
- Auto-Scroll: List automatically scrolls to keep focused item visible
- Mouse Hover: Hovering over an item also updates focus
- Smooth Animations: Focus transitions with 100ms animation
New Controller Methods:
// Navigation
controller.moveToNextItem();
controller.moveToPreviousItem();
controller.moveToFirstItem();
controller.moveToLastItem();
controller.setFocusedIndex(index);
controller.clearItemFocus();
// Selection
controller.selectFocusedItem();
// Properties
controller.focusedIndex; // Current focused index (-1 if none)
controller.focusedItem; // Current focused item (null if none)
controller.hasItemFocus; // Whether an item is focused
Usage Example:
SmartSearchDropdown<Product>.withProvider(
// ... other properties
searchConfig: SmartSearchConfig(
clearOnClose: false, // Keep focus when closing
),
)
2.0.0 - 2025-12-18 #
Added #
SmartSearchBox - Search with Overlay Dropdown 🔍
New powerful search component that connects to SmartPaginationCubit for searching with an auto-positioning overlay dropdown.
New Classes:
SmartSearchBox<T>- Search input widget connected to pagination cubitSmartSearchOverlay<T>- Combines search box with overlay dropdownSmartSearchDropdown<T>- Convenient all-in-one search dropdown widgetSmartSearchController<T>- Controller for managing search stateSmartSearchConfig- Configuration for search behavior (debounce, min length, etc.)SmartSearchOverlayConfig- Configuration for overlay appearance and positioningOverlayPosition- Enum for overlay positioning (auto, top, bottom, left, right)OverlayPositioner- Utility for calculating optimal overlay position
Key Features:
- Auto-Positioning: Overlay automatically positions itself in the best available space
- Cubit Integration: Directly connected to SmartPaginationCubit for data fetching
- Debounced Search: Configurable delay to prevent excessive API calls
- Flexible Placement: Position overlay top, bottom, left, right, or auto
- Customizable: Full control over search box and overlay appearance
- Animations: Smooth show/hide animations with configurable duration
SmartSearchDropdown Constructors:
.withProvider()- Creates internal cubit with data provider.withCubit()- Uses externally managed cubit
Usage Examples #
// Simple search dropdown with provider
SmartSearchDropdown<Product>.withProvider(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future((request) async {
return await api.searchProducts(request.searchQuery ?? '');
}),
searchRequestBuilder: (query) => PaginationRequest(
page: 1,
pageSize: 20,
searchQuery: query,
),
itemBuilder: (context, product) => ListTile(
title: Text(product.name),
subtitle: Text('\$${product.price}'),
),
onItemSelected: (product) {
Navigator.pop(context, product);
},
)
// With external cubit
final searchCubit = SmartPaginationCubit<Product>(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future(searchProducts),
);
SmartSearchDropdown<Product>.withCubit(
cubit: searchCubit,
searchRequestBuilder: (query) => PaginationRequest(
page: 1,
pageSize: 20,
searchQuery: query,
),
itemBuilder: (context, product) => ListTile(
title: Text(product.name),
),
onItemSelected: (product) => print('Selected: ${product.name}'),
overlayConfig: SmartSearchOverlayConfig(
position: OverlayPosition.bottom, // Force bottom position
maxHeight: 400,
borderRadius: 12,
elevation: 8,
),
)
// Using SmartSearchBox and SmartSearchOverlay separately
final controller = SmartSearchController<Product>(
cubit: productsCubit,
searchRequestBuilder: (query) => PaginationRequest(
page: 1,
pageSize: 20,
searchQuery: query,
),
config: SmartSearchConfig(
debounceDelay: Duration(milliseconds: 500),
minSearchLength: 2,
),
);
// Place search box in app bar
AppBar(
title: SmartSearchBox<Product>(
controller: controller,
decoration: InputDecoration(hintText: 'Search...'),
),
)
// Place overlay anywhere in your layout
SmartSearchOverlay<Product>(
controller: controller,
itemBuilder: (context, product) => ProductTile(product),
onItemSelected: selectProduct,
)
0.1.4 - 2025-12-18 #
Added #
Sorting & Orders Feature 📊
New powerful sorting functionality that allows programmatic control over item ordering:
Sorted Insertion (Performance Fix) ⚡
Item insertion methods now respect the active sort order by inserting items directly at the correct sorted position using binary search. This prevents visual flickering that occurred when items were added then re-sorted.
Improved Methods:
insertEmit()- Inserts items at correct sorted positioninsertAllEmit()- Uses efficient merge algorithm for batch insertionsaddOrUpdateEmit()- Positions new items correctly; repositions updated items if sort field changedupdateItemEmit()- Repositions item if sort field changesupdateWhereEmit()- Batch repositions multiple updated items efficiently
Benefits:
- No Visual Flickering: Items appear directly in their final position
- Efficient Algorithm: Binary search for single insertions, merge sort for batches
- Automatic: Works transparently when sort order is active
- Backward Compatible: Falls back to index-based insertion when no sorting is active
New Classes:
SortOrder<T>- Defines how items should be sortedSortOrderCollection<T>- Manages multiple sort orders with an active selectionSortDirection- Enum for ascending/descending direction
Cubit Constructor Parameter:
orders: SortOrderCollection<T>?- Set initial sorting configuration
New Cubit Methods:
setActiveOrder(String orderId)- Change the active sort orderresetOrder()- Reset to default sort orderclearOrder()- Remove sorting (show original order)addSortOrder(SortOrder<T> order)- Add a new sort order dynamicallyremoveSortOrder(String orderId)- Remove a sort ordersortBy(ItemComparator<T> comparator)- One-time sort with custom comparatorsetOrders(SortOrderCollection<T>? orders)- Replace entire orders collection
New Cubit Properties:
orders- Get current sort order collectionactiveOrder- Get currently active sort orderactiveOrderId- Get ID of active sort orderavailableOrders- Get list of all available sort orders
State Updates:
SmartPaginationLoaded.activeOrderId- Track current sort order in state
Usage Examples #
// Define sort orders
final orders = SortOrderCollection<Product>(
orders: [
SortOrder.byField(
id: 'name',
label: 'Name (A-Z)',
fieldSelector: (p) => p.name,
direction: SortDirection.ascending,
),
SortOrder.byField(
id: 'price_low',
label: 'Price: Low to High',
fieldSelector: (p) => p.price,
direction: SortDirection.ascending,
),
SortOrder.byField(
id: 'price_high',
label: 'Price: High to Low',
fieldSelector: (p) => p.price,
direction: SortDirection.descending,
),
SortOrder<Product>(
id: 'custom',
label: 'Custom Sort',
comparator: (a, b) => a.rating.compareTo(b.rating),
),
],
defaultOrderId: 'name',
);
// Create cubit with orders
final cubit = SmartPaginationCubit<Product>(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future(fetchProducts),
orders: orders,
);
// Change sort order programmatically
cubit.setActiveOrder('price_low'); // Sort by price ascending
cubit.setActiveOrder('price_high'); // Sort by price descending
cubit.resetOrder(); // Reset to default (name)
cubit.clearOrder(); // Remove sorting
// Add new sort order dynamically
cubit.addSortOrder(SortOrder.byField(
id: 'newest',
label: 'Newest First',
fieldSelector: (p) => p.createdAt,
direction: SortDirection.descending,
));
// One-time custom sort
cubit.sortBy((a, b) => a.stock.compareTo(b.stock));
// Access current order in state
if (state is SmartPaginationLoaded<Product>) {
print('Current sort: ${state.activeOrderId}');
}
0.1.3 - 2025-12-17 #
Added #
Specialized Widget Classes 🎯
New dedicated widget classes for each view type, providing cleaner and more intuitive API:
New Widget Classes:
SmartPaginationListView- Paginated ListView widgetSmartPaginationGridView- Paginated GridView widgetSmartPaginationColumn- Paginated non-scrollable Column layoutSmartPaginationRow- Paginated non-scrollable Row layoutSmartPaginationPageView- Paginated PageView widgetSmartPaginationStaggeredGridView- Paginated Pinterest-style masonry layoutSmartPaginationReorderableListView- Paginated drag-and-drop reorderable list
Each widget class provides:
.withProvider()constructor - Creates cubit internally with data provider.withCubit()constructor - Uses externally managed cubit
Benefits:
- Clearer Intent: Each widget class explicitly states its layout type
- Better IDE Support: Autocomplete shows relevant parameters for each view type
- Reduced Confusion: No need to specify
itemBuilderTypeparameter - Same Functionality: All features from
SmartPaginationare available
Usage Examples #
// Before (using SmartPagination with named constructors)
SmartPagination.listViewWithProvider(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future(fetchProducts),
itemBuilder: (context, items, index) => ProductTile(items[index]),
)
// After (using specialized widget class)
SmartPaginationListView.withProvider(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future(fetchProducts),
itemBuilder: (context, items, index) => ProductTile(items[index]),
)
// GridView example
SmartPaginationGridView.withProvider(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future(fetchProducts),
gridDelegate: SliverGridDelegateWithFixedCrossAxisCount(crossAxisCount: 2),
itemBuilder: (context, items, index) => ProductCard(items[index]),
)
// External cubit example
final cubit = SmartPaginationCubit<Product>(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future(fetchProducts),
dataAge: Duration(minutes: 5),
);
SmartPaginationListView.withCubit(
cubit: cubit,
itemBuilder: (context, items, index) => ProductTile(items[index]),
)
Note #
The original SmartPagination class with named constructors remains available for backward compatibility. Both approaches work identically - choose the style that best fits your preferences.
0.1.2 - 2025-12-17 #
Added #
Data Age & Automatic Expiration ⏰
New feature for automatic data invalidation and refresh when using cubit as a global variable:
New Parameters:
dataAge: Duration?- Configure how long data remains valid after fetching
New Properties on SmartPaginationCubit:
dataAge- Get the configured data age durationlastFetchTime- Get the timestamp of the last successful data fetchisDataExpired- Check if data has expired based on the configured dataAgecheckAndResetIfExpired()- Check expiration and reset if expired (returnstrueif reset)
New Properties on SmartPaginationLoaded State:
fetchedAt: DateTime?- Timestamp when data was initially fetcheddataExpiredAt: DateTime?- Timestamp when data will expire (null if no expiration)
Automatic Behavior:
- When
fetchPaginatedList()is called, it automatically checks if data has expired - If expired, the cubit resets to initial state and triggers a fresh data load
- Perfect for global cubits that persist across screen navigations
- Timer refreshes on any data interaction: insert, update, remove, load more
- This ensures active users don't experience unexpected data resets
Usage Example #
// Create a global cubit with 5-minute data age
final productsCubit = SmartPaginationCubit<Product>(
request: PaginationRequest(page: 1, pageSize: 20),
provider: PaginationProvider.future(fetchProducts),
dataAge: Duration(minutes: 5), // Data expires after 5 minutes
);
// When re-entering the screen, data is automatically refreshed if expired
// Or manually check expiration:
if (productsCubit.isDataExpired) {
print('Data is stale, will refresh on next fetch');
}
// Access expiration info from state
if (state is SmartPaginationLoaded<Product>) {
print('Data fetched at: ${state.fetchedAt}');
print('Data expires at: ${state.dataExpiredAt}');
}
0.1.1 - 2025-12-17 #
Added #
Cubit Data Operations 🎛️
New programmatic data operations accessible from anywhere in your app via the cubit:
Insert Operations:
insertEmit(item, {index})- Insert a single item at specified index (default: 0)insertAllEmit(items, {index})- Insert multiple items at specified index
Remove Operations:
removeItemEmit(item)- Remove an item by reference, returnstrueif foundremoveAtEmit(index)- Remove item at index, returns the removed item ornullremoveWhereEmit(test)- Remove all items matching predicate, returns count removed
Update Operations:
updateItemEmit(matcher, updater)- Update first matching item, returnstrueif updatedupdateWhereEmit(matcher, updater)- Update all matching items, returns count updated
Other Operations:
clearItems()- Clear all items from the listreload()- Reload data from the beginning (alias forrefreshPaginatedList)setItems(items)- Set the list to a completely new set of itemscurrentItems- Getter to access current list of items (read-only)
Example App
- Data Operations Screen - New example demonstrating all cubit data operations:
- Interactive buttons to test each operation
- Long-press to remove items
- Visual feedback for all operations
Usage Examples #
// Get the cubit reference
final cubit = SmartPaginationCubit<Product>(...);
// Insert operations
cubit.insertEmit(newProduct);
cubit.insertEmit(newProduct, index: 5);
cubit.insertAllEmit([product1, product2, product3]);
// Remove operations
cubit.removeItemEmit(productToRemove);
cubit.removeAtEmit(0); // Remove first item
cubit.removeWhereEmit((item) => item.price > 100); // Remove expensive items
// Update operations
cubit.updateItemEmit(
(item) => item.id == '123',
(item) => item.copyWith(price: item.price * 0.9), // Apply discount
);
cubit.updateWhereEmit(
(item) => item.category == 'sale',
(item) => item.copyWith(price: item.price * 0.8),
);
// Other operations
cubit.clearItems();
cubit.reload();
cubit.setItems(customProductList);
// Access current items
final items = cubit.currentItems;
print('Total items: ${items.length}');
0.1.0 - 2025-12-01 #
Added #
- New Constructor:
SmartPagination.columnandSmartPagination.columnWithCubitfor non-scrollable column layouts. - External Cubit Support: Added
...WithCubitnamed constructors for all view types (listViewWithCubit,gridViewWithCubit,pageViewWithCubit,staggeredGridViewWithCubit,rowWithCubit) to easily use externally created Cubits. - Exposed Parameters: Added missing parameters to all convenience constructors:
scrollController: For external scroll control.cacheExtent: For viewport caching customization.invisibleItemsThreshold: For configuring smart preloading.- State Builders:
firstPageLoadingBuilder,firstPageErrorBuilder,firstPageEmptyBuilder,loadMoreLoadingBuilder,loadMoreErrorBuilder,loadMoreNoMoreItemsBuilder.
Breaking Changes ⚠️ #
-
Constructor Renaming:
SmartPagination(...)is nowSmartPagination.withProvider(...).SmartPagination.cubit(...)is nowSmartPagination.withCubit(...).- All named constructors now have explicit suffixes:
listView->listViewWithProvider/listViewWithCubitgridView->gridViewWithProvider/gridViewWithCubitpageView->pageViewWithProvider/pageViewWithCubitstaggeredGridView->staggeredGridViewWithProvider/staggeredGridViewWithCubitcolumn->columnWithProvider/columnWithCubitrow->rowWithProvider/rowWithCubitreorderableListView->reorderableListViewWithProvider/reorderableListViewWithCubit
-
Removed Convenience Widgets:
SmartPaginatedListViewandSmartPaginatedGridViewhave been removed. UseSmartPaginationdirectly. -
API Unification:
childBuilderis renamed toitemBuilder.itemBuildersignature changed from(context, item, index)to(context, items, index). You must now access the item usingitems[index].
-
Configuration:
- Use
itemBuilderType: PaginateBuilderType.gridViewfor grid layouts. - Use
itemBuilderType: PaginateBuilderType.listView(default) for list layouts.
- Use
Changed #
- Updated all example screens to use the new constructor names.
- Improved API clarity by explicitly distinguishing between
Provider(internal Cubit creation) andCubit(external Cubit injection) usage. - Updated
SmartPaginationto be the single entry point for all pagination types. - Updated
emptyWidget,loadingWidget, andbottomLoaderto acceptWidgetdirectly. - Updated
separatorto acceptWidgetdirectly.
0.0.6 - 2025-11-30 #
Added #
- Documentation preparation for pub.dev publication
- Comprehensive example screens section in README (28 screens documented)
- Screenshot infrastructure with placeholder guides
- Screenshots directory structure (
basic/,streams/,advanced/,errors/)
Changed #
- Enhanced README.md for pub.dev with professional presentation
- Added "Why Smart Pagination?" section highlighting key benefits
- Added comprehensive Table of Contents
- Reorganized content with clear visual separators
- Added detailed documentation for all 28 example screens
- Added Features Comparison table vs other libraries
- Added Use Cases section (E-commerce, Social Media, Content Apps, etc.)
- Added Learning Resources section
- Enhanced API Reference section
- Added Best Practices section with code examples
- Total: 2,100+ lines of comprehensive documentation
- Updated pubspec.yaml description for better pub.dev visibility
- Highlights: BLoC state management, 6+ view types, advanced error handling
- Emphasizes: Zero boilerplate, type-safe, well-tested (60+ tests)
Documentation #
- Created
screenshots/README.md- Complete guide for capturing screenshots - Created category-specific guides (
PLACEHOLDER.mdfiles) - Added instructions for Flutter DevTools, command line, and automation
- Included image optimization guide and Git LFS setup
0.0.5 - 2025-11-02 #
Added #
Unified Provider Pattern 🔄
- PaginationProvider Sealed Class: Type-safe unified provider pattern
PaginationProvider.future()for REST API paginationPaginationProvider.stream()for real-time updatesPaginationProvider.mergeStreams()for combining multiple streams- Single provider parameter replaces separate
dataProviderandstreamProvider - Pattern matching with switch expressions for type safety
- Legacy typedefs maintained for backward compatibility
Merged Streams Support 🔀
- MergedStreamPaginationProvider: Merge multiple data streams
- Combines streams into a single unified stream
- Emits data whenever any source stream emits
- Perfect for aggregating data from multiple sources
- Automatic stream lifecycle management
- Example Implementation: Merged streams demo screen
- Real-time updates from 3 different streams
- Visual indicators for each stream source
Stream Examples 📡
- Single Stream Example: Real-time product list with live price updates
- Products update every 3 seconds
- Visual indicators for streaming data
- Multi Stream Example: Multiple streams with different update rates
- Three stream sources with different intervals (3s, 4s, 5s)
- Tab navigation between streams
- Dynamic stream switching
- Color-coded badges
Advanced Error Handling 🛡️
- CustomErrorBuilder: 6 pre-built error widget styles
CustomErrorBuilder.material()- Full-screen Material Design errorCustomErrorBuilder.compact()- Inline compact errorCustomErrorBuilder.card()- Elevated card-style errorCustomErrorBuilder.minimal()- Simple text-based errorCustomErrorBuilder.snackbar()- Bottom notification errorCustomErrorBuilder.custom()- Fully custom error builder
- Error State Separation: Different UI for first page vs load more errors
firstPageErrorBuilder- Full-screen error for initial loadloadMoreErrorBuilder- Compact error for pagination
- Error Recovery Strategies: 5 recovery patterns demonstrated
- Cached data fallback
- Partial data display
- Alternative source switching
- User-initiated recovery
- Graceful degradation
Error Examples (7 New Screens) 🐛
- Basic Error Handling - Simple retry with progressive counter
- Network Errors - Different error types (timeout, 404, 500, 401)
- Retry Patterns - Manual, auto, exponential backoff, limited retries
- Custom Error Widgets - All 6 error widget styles demonstrated
- Error Recovery - 4 recovery strategies (cached, partial, alternative, user)
- Graceful Degradation - 3 degradation strategies (offline, placeholders, limited)
- Load More Errors - 3 load-more patterns (compact, inline, silent)
Error Images Infrastructure 🎨
- ErrorImages Helper Class: Easy image integration with fallback icons
- 12 pre-configured image methods (general, network, 404, 500, timeout, etc.)
- Automatic fallback to icons if images fail to load
- Customizable width, height, and fallback colors
- Documentation:
docs/ERROR_IMAGES_SETUP.md- Free illustration sources guide (unDraw, Storyset, DrawKit)
- Download helper script
- Image specifications and optimization
- Troubleshooting guide
Changed #
API Improvements
- SmartPagination: Updated to unified
PaginationProvider<T>parameter- Removed separate
dataProviderandstreamProvider - Single
providerparameter accepts both Future and Stream - Added
retryConfigparameter support - Cleaner, more intuitive API
- Removed separate
- Convenience Widgets: Updated to unified provider pattern
SmartPaginatedListViewusesproviderparameterSmartPaginatedGridViewusesproviderparameter- Added error builder parameters (
firstPageErrorBuilder,loadMoreErrorBuilder)
Documentation Updates
- Updated README.md for unified provider pattern
- Added comprehensive error handling documentation
- Updated all code examples to use
PaginationProvider - Added error handling guide:
docs/ERROR_HANDLING.md
Removed #
DualPagination (Grouped Pagination) - Complete Removal
- Removed all DualPagination functionality to simplify library focus
- Deleted
lib/dual_pagination/directory - Removed DualPagination tests and examples
- Updated documentation to remove DualPagination references
Migration Guide #
From v0.0.4 (dataProvider/streamProvider) to v0.0.5 (unified provider):
// Before (v0.0.4)
SmartPagination<Product>(
dataProvider: (request) => apiService.fetchProducts(request),
...
)
// After (v0.0.5)
SmartPagination<Product>(
provider: PaginationProvider.future(
(request) => apiService.fetchProducts(request),
),
...
)
For Stream-based pagination:
// Before
SmartPagination<Product>(
streamProvider: (request) => apiService.productsStream(request),
...
)
// After
SmartPagination<Product>(
provider: PaginationProvider.stream(
(request) => apiService.productsStream(request),
),
...
)
Benefits #
- Type Safety: Sealed classes ensure compile-time checking
- Cleaner API: Single provider instead of two parameters
- Better Intent: Clear distinction between Future and Stream
- Production-Ready: Advanced error handling out of the box
- Well Tested: 60+ unit tests
0.0.4 - 2025-10-31 #
Added #
Convenience Widgets 🛠️
- SmartPaginatedListView: Simplified ListView pagination widget
- Cleaner API with direct
childBuilder - Optional
separatorBuilder,emptyBuilder,errorBuilder - Built-in retry configuration support
- 40-60% less boilerplate code
- Cleaner API with direct
- SmartPaginatedGridView: Simplified GridView pagination widget
- Dedicated
gridDelegateconfiguration - Direct
childBuilderfor grid items - Full pagination features with less code
- Dedicated
- DualPaginatedListView: Simplified grouped ListView pagination
- Easy group-based pagination
- Simplified
groupKeyGenerator - Direct
groupHeaderBuilderandchildBuilder
Example App 🎨
- Complete Example Application with 5 demonstration screens:
- Basic ListView - Simple paginated product list
- GridView - Product grid with pagination
- Retry Demo - Automatic retry on errors
- Filter & Search - Real-time filtering with search
- Grouped Messages - Messages grouped by date
- Mock API Service: Network delay simulation, error simulation
- Example Models: Product and Message with JSON serialization
Enhanced #
- Developer Experience: 40-60% reduction in boilerplate code
- Example-Driven Learning: Complete runnable examples
- Better API Design: More intuitive method names
0.0.3 - 2025-10-31 #
Added #
Comprehensive Test Suite 🧪
- 60+ Unit Tests covering all core functionality
- Data Model Tests: PaginationMeta (12 tests), PaginationRequest (8 tests)
- Error Handling Tests: RetryConfig, RetryHandler, PaginationException
- Cubit Tests: SmartPaginationCubit (14 tests), DualPaginationCubit (12 tests)
- Test Infrastructure: Test models, factories, proper organization
Testing Coverage #
- ✅ PaginationMeta (100%)
- ✅ PaginationRequest (100%)
- ✅ RetryConfig (100%)
- ✅ RetryHandler (95%)
- ✅ PaginationException classes (100%)
- ✅ SmartPaginationCubit (85%)
- ✅ DualPaginationCubit (80%)
Dependencies #
- Added
bloc_test: ^9.1.5for BLoC testing - Added
mocktail: ^1.0.1for mocking
0.0.2 - 2025-10-31 #
Added #
Dual Pagination (Grouped Pagination)
- DualPaginationCubit<Key, T>: Managing grouped state
- Flexible Grouping: Custom
KeyGeneratorfunction - Group Headers: Customizable group header builder
- Real-time Updates: Stream support for grouped data
Retry Mechanism & Error Handling
- RetryConfig: Configurable retry behavior with exponential backoff
- Max attempts (default: 3)
- Initial delay (default: 1s)
- Max delay (default: 10s)
- Custom retry conditions
- Timeout Handling: Built-in timeout support (default: 30s)
- Custom Exceptions:
PaginationTimeoutExceptionPaginationNetworkExceptionPaginationParseExceptionPaginationRetryExhaustedException
- RetryHandler Utility: Automatic retry execution with logging
Enhanced #
- Improved error logging with retry attempt information
- Exponential backoff prevents API rate limiting
0.0.1 - 2025-10-31 #
Added #
Core Features
- Initial release of Smart Pagination library
- SmartPagination widget with multiple layout support:
- ListView with separators
- GridView with configurable delegates
- PageView for swipeable content
- StaggeredGridView for masonry layouts
- Column/Row layouts
State Management
- SmartPaginationCubit: BLoC pattern implementation
- Three state types:
Initial,Loaded,Error - PaginationMeta: Metadata tracking
- PaginationRequest: Pagination configuration
Advanced Features
- Cursor-based and offset-based pagination
- Stream provider for real-time updates
- Memory management with
maxPagesInMemory - Filter, refresh, and order listeners
- Custom list builder for transformations
beforeBuildhook for pre-render transformations
Controller
- SmartPaginationController: Scroll capabilities
- Programmatic scrolling:
scrollToIndex(),scrollToItem()
UI Components
BottomLoader- pagination loading indicatorInitialLoader- initial loading stateEmptyDisplay- empty state widgetErrorDisplay- error state widget
Developer Experience
- Type-safe generic support
- Custom error handling with callbacks
- Comprehensive in-code documentation
- Multiple named constructors
Dependencies #
flutter_bloc: ^9.1.1- State managementflutter_staggered_grid_view: ^0.7.0- Staggered layoutslogger: ^2.6.2- Logging supportprovider: ^6.1.5+1- Listener managementscrollview_observer: ^1.26.2- Scroll observation
Documentation #
- Comprehensive README.md with examples
- API reference and best practices
- Contributing guidelines
- Library-level documentation
Future Releases #
Planned Features #
- ❌ Widget and integration tests
- ❌ Code coverage reporting
- ❌ Pull-to-refresh built-in widget support
- ❌ Performance benchmarks
- ❌ Video tutorials
- ❌ CI/CD pipeline
- ❌ pub.dev publication
For more information, visit the GitHub repository.