custom_refresh_indicator 0.2.0

  • Readme
  • Changelog
  • Example
  • Installing
  • new61

Flutter Custom Refresh Indicator #

This package adds CustomRefreshIndicator widget that make it easy to implement custom refresh indicator.

Examples: #

Use of SimpleIndicatorContainer with Icon as child LINK

simple_indicator

Envelope indicator #

letter_indicator

Blur indicator #

blur_indicator

Getting started #

CustomRefreshIndicator #

CustomRefreshIndicator is not the same as theRefreshIndicator widget. It has an absolute minimum functionality that allows you to create and set your own custom indicators.

Arguments #

Argumenttypedefault valuerequired
childWidget---true
onRefreshFuture<void> Function()---true
indicatorBuilderWidget Function(BuildContext, CustomRefreshIndicatorData)---true
dragingToIdleDurationDurationDuration(milliseconds: 300)false
armedToLoadingDurationDurationDuration(milliseconds: 200)false
loadingToIdleDurationDurationDuration(milliseconds: 100)false
leadingGlowVisibleboolfalsefalse
trailingGlowVisiblebooltruefalse

CustomRefreshIndicatorData #

Object containig data provided by CustomRefreshIndicator.

Props #

proptype
valuedouble
directionAxisDirection
scrollingDirectionScrollDirection
indicatorStateCustomRefreshIndicatorState

CustomRefreshIndicatorState #

Enum which describes state of CustomRefreshIndicator.

idle #

CustomRefreshIndicator is idle (There is no action)

(CustomRefreshIndicatorData.value == 0)

draging #

Whether user is draging CustomRefreshIndicator ending the scroll WILL NOT result in onRefresh call

(CustomRefreshIndicatorData.value < 1)

armed #

CustomRefreshIndicator is armed ending the scroll WILL result in:

  • CustomRefreshIndicator.onRefresh call
  • change of status to loading
  • decreasing CustomRefreshIndicatorData.value to 1 in duration specified by CustomRefreshIndicator.armedToLoadingDuration)

(CustomRefreshIndicatorData.value >= 1)

hiding #

CustomRefreshIndicator is hiding indicator when onRefresh future is resolved or indicator was canceled (scroll ended when [CustomRefreshIndicatorState] was equal to dragging so value was less than 1 or the user started scrolling through the list)

(CustomRefreshIndicatorData.value decreases to 0 in duration specified by CustomRefreshIndicator.dragingToIdleDuration)

loading #

CustomRefreshIndicator is awaiting on onRefresh call result. When onRefresh will resolve CustomRefreshIndicator will change state from loading to hiding and decrease CustomRefreshIndicatorData.value from 1 to 0 in duration specified by CustomRefreshIndicator.loadingToIdleDuration

(CustomRefreshIndicatorData.value == 1)

[0.1.1]

[0.1.0] - Initial version.

  • Added basic CustomRefreshIndicator widget with CustomRefreshIndicatorData class.
  • Added SimpleIndicatorContainer widget which simulate default RefreshIndicator container
  • Added examples:
    • inbox
    • simple
    • blur

[0.2.0] - Added support for BouncingScrollPhysics.

  • Added support for BouncingScrollPhysics - ios default sroll physics
  • Improved readme

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:
  custom_refresh_indicator: ^0.2.0

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:custom_refresh_indicator/custom_refresh_indicator.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
22
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
61
Learn more about scoring.

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

  • Dart: 2.6.0
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.6

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test