Easy Refresh

https://pub.dev/packages/easy_refresh
Admin
Easy Refresh is a Flutter widget that provides pull-down refresh and pull-up load functionality with...
Tokens:6,520
Snippets:104
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install easy_refresh via CLI

Source: https://pub.dev/packages/easy_refresh/install

Use this command in your terminal to add the package to your Flutter project.

```bash
$ flutter pub add easy_refresh
```

--------------------------------

### Implement Skating Indicators with EasyRefresh

Source: https://pub.dev/packages/easy_refresh_skating/example

This example demonstrates how to integrate SkatingHeader and SkatingFooter from the easy_refresh_skating package into an EasyRefresh widget. It includes basic refresh and load more logic with simulated network delays.

```dart
import 'package:easy_refresh_skating/easy_refresh_skating.dart';
import 'package:flutter/material.dart';
import 'package:easy_refresh/easy_refresh.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Skating',
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  int _count = 10;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Skating'),
      ),
      body: EasyRefresh(
        header: const SkatingHeader(),
        footer: const SkatingFooter(),
        onRefresh: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count = 10;
          });
        },
        onLoad: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count += 5;
          });
        },
        child: ListView.builder(
          itemBuilder: (context, index) {
            return Card(
              child: Container(
                alignment: Alignment.center,
                height: 80,
                child: Text('${index + 1}'),
              ),
            );
          },
          itemCount: _count,
        ),
      ),
    );
  }
}

```

--------------------------------

### Flutter App with EasyRefresh and Bubbles Indicators

Source: https://pub.dev/packages/easy_refresh_bubbles/example

This is a complete Flutter application example demonstrating the usage of EasyRefresh with BubblesHeader and BubblesFooter. It includes basic refresh and load more functionality with simulated network delays. Ensure the 'easy_refresh_bubbles' and 'easy_refresh' packages are added to your pubspec.yaml.

```dart
import 'package:easy_refresh_bubbles/easy_refresh_bubbles.dart';
import 'package:flutter/material.dart';
import 'package:easy_refresh/easy_refresh.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Bubbles',
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  int _count = 10;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Bubbles'),
      ),
      body: EasyRefresh(
        header: const BubblesHeader(),
        footer: const BubblesFooter(),
        onRefresh: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count = 10;
          });
        },
        onLoad: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count += 5;
          });
        },
        child: ListView.builder(
          itemBuilder: (context, index) {
            return Card(
              child: Container(
                alignment: Alignment.center,
                height: 80,
                child: Text('${index + 1}'),
              ),
            );
          },
          itemCount: _count,
        ),
      ),
    );
  }
}

```

--------------------------------

### easy_refresh_squats Dependency in pubspec.yaml

Source: https://pub.dev/packages/easy_refresh_squats/install

This is an example of how the easy_refresh_squats dependency will appear in your pubspec.yaml file after running `flutter pub add`.

```yaml
dependencies:
  easy_refresh_squats: ^1.0.3
```

--------------------------------

### Implement SpaceHeader and SpaceFooter with EasyRefresh

Source: https://pub.dev/packages/easy_refresh_space

Use SpaceHeader and SpaceFooter as the header and footer for the EasyRefresh widget. This example shows basic usage with refresh and load callbacks.

```dart
EasyRefresh(
  header: SpaceHeader(),
  footer: SpaceFooter(),
  onRefresh: () async {},
  onLoad: () async {},
  child: ListView(),
)

```

--------------------------------

### Add easy_refresh_halloween to pubspec.yaml

Source: https://pub.dev/packages/easy_refresh_halloween/install

This is an example of how the easy_refresh_halloween dependency will appear in your pubspec.yaml file after running the `flutter pub add` command.

```yaml
dependencies:
  easy_refresh_halloween: ^1.0.3
```

--------------------------------

### Add dependencies for easy_refresh_squats

Source: https://pub.dev/packages/easy_refresh_squats

Include the required packages in your pubspec.yaml file.

```yaml
dependencies:
  flutter_easyre_fresh: version
  easy_refresh_squats: version
```

--------------------------------

### Customizing Header and Footer

Source: https://pub.dev/packages/easy_refresh

Setting specific header/footer styles or configuring global defaults.

```dart
  EasyRefresh(
    header: MaterialHeader(),
    footer: MaterialFooter(),
    child: ListView(),
    ....
  );
  // Global
  EasyRefresh.defaultHeaderBuilder = () => ClassicHeader();
  EasyRefresh.defaultFooterBuilder = () => ClassicFooter();
```

--------------------------------

### Configure pubspec.yaml

Source: https://pub.dev/packages/easy_refresh/install

Manually add the dependency to your project's pubspec.yaml file.

```yaml
dependencies:
  easy_refresh: ^3.5.0
```

--------------------------------

### Add dependencies for easy_refresh_skating

Source: https://pub.dev/packages/easy_refresh_skating

Include the required packages in your pubspec.yaml file to enable the skating indicator functionality.

```yaml
dependencies:
  flutter_easyre_fresh: version
  easy_refresh_skating: version
```

--------------------------------

### Implement SquatsHeader and SquatsFooter

Source: https://pub.dev/packages/easy_refresh_squats

Use SquatsHeader and SquatsFooter within the EasyRefresh widget to enable the animation.

```dart
EasyRefresh(
  header: SquatsHeader(),
  footer: SquatsFooter(),
  onRefresh: () async {},
  onLoad: () async {},
  child: ListView(),
)
```

--------------------------------

### Add dependency via CLI

Source: https://pub.dev/packages/easy_refresh_space/install

Use the Flutter CLI to add the package to your project.

```bash
$ flutter pub add easy_refresh_space
```

--------------------------------

### Importing Companion Packages

Source: https://pub.dev/packages/easy_refresh

Required imports when using the easy_paging package alongside easy_refresh.

```dart
import 'package:easy_paging/easy_paging.dart';
import 'package:easy_refresh/easy_refresh.dart';
```

--------------------------------

### Add dependency via command line

Source: https://pub.dev/packages/easy_refresh_skating/install

Use this command to add the package to your Flutter project via the terminal.

```bash
$ flutter pub add easy_refresh_skating
```

--------------------------------

### Using EasyRefreshController

Source: https://pub.dev/packages/easy_refresh

Manually controlling refresh and load states using an EasyRefreshController.

```dart
  EasyRefreshController _controller = EasyRefreshController(
    controlFinishRefresh: true,
    controlFinishLoad: true,
  );
  ....
  EasyRefresh(
    controller: _controller,
    onRefresh: () async {
      ....
      _controller.finishRefresh();
      _controller.resetFooter();
    },
    onLoad: () async {
      ....
      _controller.finishLoad(IndicatorResult.noMore);
    },
    ....
  );
  ....
  _controller.callRefresh();
  _controller.callLoad();
```

--------------------------------

### Implement SquatsHeader and SquatsFooter in EasyRefresh

Source: https://pub.dev/packages/easy_refresh_squats/example

Integrate the SquatsHeader and SquatsFooter widgets into an EasyRefresh component to provide animated refresh and load indicators.

```dart
import 'package:easy_refresh_squats/easy_refresh_squats.dart';
import 'package:flutter/material.dart';
import 'package:easy_refresh/easy_refresh.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Squats',
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  int _count = 10;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Squats'),
      ),
      body: EasyRefresh(
        header: const SquatsHeader(),
        footer: const SquatsFooter(),
        onRefresh: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count = 10;
          });
        },
        onLoad: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count += 5;
          });
        },
        child: ListView.builder(
          itemBuilder: (context, index) {
            return Card(
              child: Container(
                alignment: Alignment.center,
                height: 80,
                child: Text('${index + 1}'),
              ),
            );
          },
          itemCount: _count,
        ),
      ),
    );
  }
}
```

--------------------------------

### Implement SpaceHeader and SpaceFooter in EasyRefresh

Source: https://pub.dev/packages/easy_refresh_space/example

Demonstrates the integration of SpaceHeader and SpaceFooter within an EasyRefresh widget to provide animated pull-to-refresh and load-more functionality.

```dart
import 'package:easy_refresh_space/easy_refresh_space.dart';
import 'package:flutter/material.dart';
import 'package:easy_refresh/easy_refresh.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Space',
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  int _count = 10;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Space'),
      ),
      body: EasyRefresh(
        header: const SpaceHeader(),
        footer: const SpaceFooter(),
        onRefresh: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count = 10;
          });
        },
        onLoad: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count += 5;
          });
        },
        child: ListView.builder(
          itemBuilder: (context, index) {
            return Card(
              child: Container(
                alignment: Alignment.center,
                height: 80,
                child: Text('${index + 1}'),
              ),
            );
          },
          itemCount: _count,
        ),
      ),
    );
  }
}
```

--------------------------------

### Import the package

Source: https://pub.dev/packages/easy_refresh_skating/install

Include this import statement in your Dart files to access the package functionality.

```dart
import 'package:easy_refresh_skating/easy_refresh_skating.dart';
```

--------------------------------

### Import package in Dart

Source: https://pub.dev/packages/easy_refresh_space/install

Import the library to access SpaceHeader and SpaceFooter components.

```dart
import 'package:easy_refresh_space/easy_refresh_space.dart';
```

--------------------------------

### Implement SkatingHeader and SkatingFooter

Source: https://pub.dev/packages/easy_refresh_skating

Use SkatingHeader and SkatingFooter within an EasyRefresh widget to add the skating animation to your refresh and load actions.

```dart
EasyRefresh(
  header: SkatingHeader(),
  footer: SkatingFooter(),
  onRefresh: () async {},
  onLoad: () async {},
  child: ListView(),
)
```

--------------------------------

### Import easy_refresh_squats Package in Dart

Source: https://pub.dev/packages/easy_refresh_squats/install

Import the easy_refresh_squats package into your Dart code to use its features. This import statement makes the package's classes and functions available.

```dart
import 'package:easy_refresh_squats/easy_refresh_squats.dart';
```

--------------------------------

### Default EasyRefresh Implementation

Source: https://pub.dev/packages/easy_refresh

Basic usage of the EasyRefresh widget with a ListView child.

```dart
  EasyRefresh(
    onRefresh: () async {
      ....
    },
    onLoad: () async {
      ....
    },
    child: ListView(),
  );
```

--------------------------------

### Locating Indicators

Source: https://pub.dev/packages/easy_refresh

Positioning headers and footers using locators within a CustomScrollView.

```dart
  EasyRefresh(
    header: Header(
      position: IndicatorPosition.locator,
    ),
    footer: Footer(
      position: IndicatorPosition.locator,
    ),
    onRefresh: () async {
      ....
    },
    onLoad: () async {
      ....
      return IndicatorResult.noMore;
    },
    child: CustomScrollView(
      slivers: [
        SliverAppBar(),
        const HeaderLocator.sliver(),
        ...
        const FooterLocator.sliver(),
      ],
    ),
  );
```

--------------------------------

### Import easy_refresh in Dart

Source: https://pub.dev/packages/easy_refresh/install

Include this import statement at the top of your Dart files to access the package functionality.

```dart
import 'package:easy_refresh/easy_refresh.dart';
```

--------------------------------

### Add dependency to pubspec.yaml

Source: https://pub.dev/packages/easy_refresh_space/install

Manually add the package dependency to your pubspec.yaml file.

```yaml
dependencies:
  easy_refresh_space: ^1.0.3
```

--------------------------------

### EasyRefresh Builder Constructor

Source: https://pub.dev/packages/easy_refresh

Use the builder constructor for more control over the scrollable child's physics.

```dart
  EasyRefresh.builder(
    onRefresh: () async {
      ....
      return IndicatorResult.success;
    },
    onLoad: () async {
      ....
    },
    childBuilder: (context, physics) {
      return ListView(
        physics: physics,
      );
    },
  );
```

--------------------------------

### Add easy_refresh_bubbles to pubspec.yaml

Source: https://pub.dev/packages/easy_refresh_bubbles

Add these dependencies to your pubspec.yaml file to use the easy_refresh_bubbles package along with flutter_easyrefresh.

```yaml
dependencies:
  flutter_easyre_fresh: version
  easy_refresh_bubbles: version

```

--------------------------------

### Add easy_refresh_squats Dependency

Source: https://pub.dev/packages/easy_refresh_squats/install

Use this command to add the easy_refresh_squats package as a dependency in your Flutter project. This command automatically updates your pubspec.yaml file.

```bash
$ flutter pub add easy_refresh_squats
```

--------------------------------

### NestedScrollView Integration

Source: https://pub.dev/packages/easy_refresh

Implementing EasyRefresh with NestedScrollView using the builder constructor.

```dart
  EasyRefresh.builder(
    header: MaterialHeader(
      clamping: true,
    ),
    onRefresh: () async {
      ....
    },
    onLoad: () async {
      ....
    },
    childBuilder: (context, physics) {
      return NestedScrollView(
        physics: physics,
        body: ListView(
          physics: physics,
        );
      );
    },
  );
  // or
  EasyRefresh.builder(
    header: MaterialHeader(
      clamping: true,
      position: IndicatorPosition.locator,
    ),
    onRefresh: () async {
      ....
    },
    onLoad: () async {
      ....
    },
    childBuilder: (context, physics) {
      return NestedScrollView(
        physics: physics,
        headerSliverBuilder: (context, innerBoxIsScrolled) {
          return [
            const HeaderLocator.sliver(clearExtent: false),
            ....
          ];
        },
        body: ListView(
          physics: physics,
        );
      );
    },
  );
```

--------------------------------

### Implement Halloween Headers and Footers with EasyRefresh

Source: https://pub.dev/packages/easy_refresh_halloween

Integrate HalloweenHeader and HalloweenFooter into your EasyRefresh widget for a Halloween-themed pull-to-refresh and load-more experience. Ensure you have defined onRefresh and onLoad callbacks.

```dart
EasyRefresh(
  header: HalloweenHeader(),
  footer: HalloweenFooter(),
  onRefresh: () async {},
  onLoad: () async {},
  child: ListView(),
)

```

--------------------------------

### Add dependency to pubspec.yaml

Source: https://pub.dev/packages/easy_refresh_skating/install

Manually add this line to your project's pubspec.yaml file to include the package.

```yaml
dependencies:
  easy_refresh_skating: ^1.0.3
```

--------------------------------

### Add easy_refresh_space to pubspec.yaml

Source: https://pub.dev/packages/easy_refresh_space

Include the easy_refresh_space and flutter_easyre_fresh packages in your project's dependencies.

```yaml
dependencies:
  flutter_easyre_fresh: version
  easy_refresh_space: version

```

--------------------------------

### Basic EasyRefresh with Bubbles Indicators

Source: https://pub.dev/packages/easy_refresh_bubbles

Integrate BubblesHeader and BubblesFooter into your EasyRefresh widget for pull-to-refresh and load-more functionality with custom animations.

```dart
EasyRefresh(
  header: BubblesHeader(),
  footer: BubblesFooter(),
  onRefresh: () async {},
  onLoad: () async {},
  child: ListView(),
)

```

--------------------------------

### Add easy_refresh_halloween Dependency

Source: https://pub.dev/packages/easy_refresh_halloween/install

Run this command in your Flutter project to add the easy_refresh_halloween package as a dependency. This command automatically updates your pubspec.yaml file.

```bash
$ flutter pub add easy_refresh_halloween
```

--------------------------------

### Add easy_refresh_halloween to Dependencies

Source: https://pub.dev/packages/easy_refresh_halloween

Include the easy_refresh_halloween package in your pubspec.yaml file to use its Halloween-themed indicators.

```yaml
dependencies:
  flutter_easyre_fresh: version
  easy_refresh_halloween: version

```

--------------------------------

### Implement Halloween Refresh Indicators in Flutter

Source: https://pub.dev/packages/easy_refresh_halloween/example

Demonstrates how to integrate HalloweenHeader and HalloweenFooter into an EasyRefresh widget within a Flutter application.

```dart
import 'package:easy_refresh_halloween/easy_refresh_halloween.dart';
import 'package:flutter/material.dart';
import 'package:easy_refresh/easy_refresh.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Halloween',
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  int _count = 10;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Halloween'),
      ),
      body: EasyRefresh(
        header: const HalloweenHeader(),
        footer: const HalloweenFooter(),
        onRefresh: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count = 10;
          });
        },
        onLoad: () async {
          await Future.delayed(const Duration(seconds: 4));
          if (!mounted) {
            return;
          }
          setState(() {
            _count += 5;
          });
        },
        child: ListView.builder(
          itemBuilder: (context, index) {
            return Card(
              child: Container(
                alignment: Alignment.center,
                height: 80,
                child: Text('${index + 1}'),
              ),
            );
          },
          itemCount: _count,
        ),
      ),
    );
  }
}
```

--------------------------------

### Import easy_refresh_halloween in Dart

Source: https://pub.dev/packages/easy_refresh_halloween/install

Import the package into your Dart code to use its features. This line should be placed at the top of your Dart file.

```dart
import 'package:easy_refresh_halloween/easy_refresh_halloween.dart';
```

--------------------------------

### Identify deprecated Rive state machine input usage

Source: https://pub.dev/packages/easy_refresh_bubbles/score

This snippet highlights the use of the deprecated 'number' method for state machine inputs in the package's source code.

```dart
   ╷
73 │     _numDragInput = _riveController!.stateMachine.number('numDrag');
   │                                                   ^^^^^^
   ╵
```

```dart
   ╷
74 │     _numLoadInput = _riveController!.stateMachine.number('numLoad');
   │                                                   ^^^^^^
   ╵
```

--------------------------------

### Accessing Rive State Machine Trigger Input

Source: https://pub.dev/packages/easy_refresh_skating/score

This snippet shows the internal usage of the Rive state machine trigger input, which is currently deprecated in favor of Data Binding.

```dart
   ╷
71 │     _pullReleaseTrigger = _riveController!.stateMachine.trigger('pullRelease');
   │                                                         ^^^^^^^
   ╵
```

--------------------------------

### Accessing Rive State Machine Number Input

Source: https://pub.dev/packages/easy_refresh_skating/score

This snippet shows the internal usage of the Rive state machine number input, which is currently deprecated in favor of Data Binding.

```dart
   ╷
70 │     _pullAmountInput = _riveController!.stateMachine.number('pullAmount');
   │                                                      ^^^^^^
   ╵
```
Tokens:
Raw