liquid_pull_to_refresh 1.1.1

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 95

Liquid Pull To Refresh
#

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


Platform Pub Package Build Status License: MIT Donate

Table of contents #

Installing #

1. Depend on it #

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

dependencies:
  liquid_pull_to_refresh: ^1.1.1

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:

LiquidPullToRefresh(
        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
notificationPredicateScrollNotificationPredicateA check that specifies whether a ScrollNotification should be handled by this widget.null
scrollControllerScrollControllerControls the ScrollView child.null

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.

See Contributing.md.

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 ☕

License #

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

1.1.1 #

  • Fixed the DiagnosticsNode error with error reporting that occurs with newer versions of Flutter.

1.1.0 #

  • Added new parameter scrollController that can be added to control the ScrollView child.

1.0.2 #

1.0.1 #

  • Fixed dart analysis issue.

1.0.0 #

  • Initial Release.

example/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

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


dependencies:
  liquid_pull_to_refresh: ^1.1.1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:liquid_pull_to_refresh/liquid_pull_to_refresh.dart';
  
Version Uploaded Documentation Archive
1.1.1 Jun 1, 2019 Go to the documentation of liquid_pull_to_refresh 1.1.1 Download liquid_pull_to_refresh 1.1.1 archive
1.1.0 Jan 30, 2019 Go to the documentation of liquid_pull_to_refresh 1.1.0 Download liquid_pull_to_refresh 1.1.0 archive
1.0.2 Dec 25, 2018 Go to the documentation of liquid_pull_to_refresh 1.0.2 Download liquid_pull_to_refresh 1.0.2 archive
1.0.1 Dec 25, 2018 Go to the documentation of liquid_pull_to_refresh 1.0.1 Download liquid_pull_to_refresh 1.0.1 archive
1.0.0 Dec 25, 2018 Go to the documentation of liquid_pull_to_refresh 1.0.0 Download liquid_pull_to_refresh 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
92
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
95
Overall:
Weighted score of the above. [more]
95
Learn more about scoring.

We analyzed this package on Jun 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.3.2
  • pana: 0.12.18
  • Flutter: 1.5.4-hotfix.2

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance issues and suggestions

Support latest dependencies. (-5 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test