Package selection guidance compiled from public package information, community data, and project usage.
SwipeRefresh is a Flutter package that provides widgets to enable pull-down-to-refresh functionality in scrollable lists and other content. It enhances user experience by allowing users to refresh content with a natural gesture, commonly used in apps with dynamic data like feeds or lists. The package supports multiple platforms including Android, iOS, Web, macOS, Windows, and Linux, ensuring consistent behavior across devices. It integrates seamlessly with existing scroll views and offers customizable indicators and refresh triggers.
Use cases
Refreshing list data
Updating feed content
Loading new items on pull
Enhancing UX in scrollable views
Implementing pull-to-refresh in dashboards
Key features
Pull-down gesture support
Customizable refresh indicator
Cross-platform compatibility
Easy integration with ScrollViews
Configurable refresh trigger timing
Smooth animation during refresh
Suitable for
Developers building dynamic lists
Apps requiring real-time data updates
UX-focused mobile and web applications
Projects needing consistent refresh patterns across platforms
Teams prioritizing intuitive user interactions
Considerations
May require additional state management
Performance impact with heavy refresh logic
Limited customization for complex refresh animations
Not ideal for non-scrollable content
Depends on proper use within scrollable containers
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
Swipe Refresh
Overview
Widget for refresh by swipe.
:1234: Enabled on every platform - the package is fully written on Flutter side and enabled on every platform.
:recycle: Fully covered by tests - guaranteeing the result and expectations from this package.
:notebook_with_decorative_cover: End-to-end documentation - every aspect of implementation is documented, so there is full understanding.
:cow2: Support from the best Flutter experts - we are open to any enhancement ideas and contributions.
Refresh indicator widget with Material Design style.
SwipeRefresh.material(
stateStream: Stream<SwipeRefreshState>(),
onRefresh: _refresh,
padding: constEdgeInsets.symmetric(vertical: 10),
children: <Widget>[ ... ],
);
Future<void> _refresh() async {
// When all needed is done change state.
_controller.sink.add(SwipeRefreshState.hidden);
}
Cupertino
Refresh indicator widget with Cupertino Design style.
SwipeRefresh.cupertino(
stateStream: Stream<SwipeRefreshState>(),
onRefresh: _refresh,
padding: constEdgeInsets.symmetric(vertical: 10),
children: <Widget>[ ... ],
);
Future<void> _refresh() async {
// When all needed is done change state.
_controller.sink.add(SwipeRefreshState.hidden);
}
Adaptive
Refresh indicator widget with adaptive to platform style.
SwipeRefresh.adaptive(
stateStream: Stream<SwipeRefreshState>(),
onRefresh: _refresh,
padding: constEdgeInsets.symmetric(vertical: 10),
children: <Widget>[ ... ],
);
Future<void> _refresh() async {
// When all needed is done change state.
_controller.sink.add(SwipeRefreshState.hidden);
}
Builder
Refresh indicator widget with adaptive to platform style, and with SliverChildBuilderDelegate in childDelegate(so as not to create more child elements than are visible through Viewport).
At this moment, the current version of swipe_refresh is .
Changelog
All notable changes to this project will be documented in this file.
Issues
To report your issues, submit them directly in the Issues section.
Contribute
If you would like to contribute to the package (e.g. by improving the documentation, fixing a bug or adding a cool new feature), please read our contribution guide first and send us your pull request.
Your PRs are always welcome.
How to reach us
Please feel free to ask any questions about this package. Join our community chat on Telegram. We speak English and Russian.
