https://github.com/seosh817/easy_debounce_throttle
An easy-to-use flutter package that provides debounce and throttle with Stream and WidgetBuilder.
https://github.com/seosh817/easy_debounce_throttle
debounce flutter-package throttle
Last synced: 3 months ago
JSON representation
An easy-to-use flutter package that provides debounce and throttle with Stream and WidgetBuilder.
- Host: GitHub
- URL: https://github.com/seosh817/easy_debounce_throttle
- Owner: seosh817
- License: mit
- Created: 2022-08-03T07:28:27.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T15:10:09.000Z (over 3 years ago)
- Last Synced: 2025-10-23T07:28:30.699Z (8 months ago)
- Topics: debounce, flutter-package, throttle
- Language: Dart
- Homepage: https://pub.dev/packages/easy_debounce_throttle
- Size: 21.4 MB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Easy Debounce Throttle
An easy-to-use flutter package that provides debounce and throttle with Stream and WidgetBuilder.
## Usage
If you want to subscribe to debounce, throttle events with Stream, use `EasyDebounce`, `EasyThrottle`
you should call the `close()` method to avoid memory leak
### EasyDebounce
```dart
final EasyDebounce _easyDebounce = EasyDebounce(delay: const Duration(milliseconds: 1000));
final TextEditingController _textController = TextEditingController();
@override
void initState() {
super.initState();
_textController.addListener(() {
_easyDebounce.debounce(_textController.text);
});
_easyDebounce.listen((data) {
setState(() {
_debounceText = '$data';
});
});
}
@override
void dispose() {
_easyDebounce.close();
super.dispose();
}
```
### EasyThrottle
```dart
final EasyThrottle _easyThrottle = EasyThrottle(delay: const Duration(milliseconds: 1000));
final TextEditingController _textController = TextEditingController();
@override
void initState() {
super.initState();
_textController.addListener(() {
_easyThrottle.throttle(_textController.text);
});
_easyThrottle.listen((data) {
setState(() {
_throttleText = '$data';
});
});
}
@override
void dispose() {
_easyThrottle.close();
super.dispose();
}
```
If you want to receive debounce and throttle events from methods such as `onPressed` callbacks with `WidgetBuilder`, use `EasyDebounceBuilder` and `EasyThrottleBuilder`.
`EasyDebounceBuilder` and `EasyThrottleBuilder` internally disposes the stream, so there is no need to call the `close()` method.
### EasyDebounceBuilder
```dart
EasyDebounceBuilder(
delay: const Duration(milliseconds: 1000),
builder: (context, debounce) {
return TextButton(
onPressed: () => debounce(() => _increaseDebounceCount()),
// onPressed: () {
// debounce(() {
// _increaseDebounceCount();
// });
// },
child: Text(
'increase debounce count',
style: kNotoSansBold14.copyWith(color: Colors.white),
));
}),
```
### EasyThrottleBuilder
```dart
EasyThrottleBuilder(
delay: const Duration(milliseconds: 1000),
builder: (context, throttle) {
return TextButton(
onPressed: () => throttle(() => _increaseThrottleCount()),
// onPressed: () {
// throttle(() {
// _increaseThrottleCount();
// });
// },
child: Text(
'increase throttle count',
style: kNotoSansBold14.copyWith(color: Colors.white),
));
}),
```
## Examples
An example can be found in the example directory of this repository.
A list of detailed examples can be found in this [Examples Repository](https://github.com/seosh817/easy_debounce_throttle/tree/master/example)
| EasyDebounce | EasyThrottle |
|---|---|
|
| 
|
| EasyDebounceBuilder | EasyThrottleBuilder |
|---|---|
|
| 
|
## Installing
### 1. Depend on it
Add this to your package's `pubspec.yaml` file:
```yaml
dependencies:
easy_debounce_throttle: ^1.0.0
```
or
```
$ flutter pub add easy_debounce_throttle
```
### 2. Install it
You can install packages from the command line:
```
$ flutter pub get
```
### 3. Import it
Now in your `Dart` code, you can use:
```dart
import 'package:easy_debounce_throttle/easy_debounce_throttle.dart';
```
## License
```
MIT License
Copyright (c) 2022 seosh817
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```