liquid_pull_to_refresh 3.0.0
liquid_pull_to_refresh: ^3.0.0 copied to clipboard

A beautiful and custom refresh indicator with some cool animations and transitions for flutter.

Liquid Pull To Refresh

A beautiful and custom refresh indicator for flutter highly inspired from Ramotion Pull Down to Refresh.

Table of contents #

Installing #

1. Depend on it #

Add this to your package's pubspec.yaml file:

  liquid_pull_to_refresh: ^3.0.0

2. Install it #

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter packages get

3. Import it #

Now in your Dart code, you can use:

import 'package:liquid_pull_to_refresh/liquid_pull_to_refresh.dart';

Usage #

For adding this custom refresh indicator in your flutter app, you have to simply wrap ListView or GridView inside LiquidPullToRefresh. Also you have provide the value of onRefresh parameter which is a refresh callback.

Note - LiquidPullToRefresh can only be used with a vertical scroll view.

For example:

        key: _refreshIndicatorKey,	// key if you want to add
        onRefresh: _handleRefresh,	// refresh callback
        child: ListView(),		// scroll view

If you do not want the opacity transition of child then set showChildOpacityTransition: false. Preview regarding the both form of this widget is follows :-

showChildOpacityTransition: true showChildOpacityTransition: false

Documentation #

LiquidPullToRefresh Class #

Dart attributeDatatypeDescriptionDefault Value
childScrollViewThe widget below this widget in the tree.@required
onRefreshRefreshCallbackA function that's called when the refreshing of page takes place.@required
heightdoubleThe distance from the child's top or bottom edge to where the box will settle after the spring effect.100.0
springAnimationDurationInMillisecondsintDuration in milliseconds of springy effect that occurs when we leave dragging after full drag.1000
borderWidthdoubleBorder width of progressing circle in Progressing Indicator.2.0
showChildOpacityTransitionboolWhether to show child opacity transition or not.true
colorColorThe progress indicator's foreground color.ThemeData.accentColor
backgroundColorColorThe progress indicator's background color.ThemeData.canvasColor
animSpeedFactordoubleControls the speed of the animation after refresh. Used to fasten the ending animation.1.0

For help on editing package code, view the flutter documentation.

Bugs or Requests #

If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull request are also welcome.


Donate #

If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕

Contributors #

Thanks goes to these wonderful people (emoji key):



Anthony Taormina




Puttipong Wongrak


Aayush Malhotra



📦 🚧

This project follows the all-contributors specification. Contributions of any kind welcome! See

License #

Liquid-Pull-To-Refresh is licensed under MIT license. View license.

pub points


A beautiful and custom refresh indicator with some cool animations and transitions for flutter.

Repository (GitHub)
View/report issues


API reference






Packages that depend on liquid_pull_to_refresh