42 lines
1.4 KiB
Dart
42 lines
1.4 KiB
Dart
/*
|
|
* Copyright (c) 2024-2025 Fabian Freund.
|
|
*
|
|
* This file is part of WebLibre
|
|
* (see https://weblibre.eu).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
import 'package:flutter_hooks/flutter_hooks.dart';
|
|
import 'package:weblibre/utils/debouncer.dart';
|
|
|
|
/// A hook that creates a [Debouncer] with automatic disposal.
|
|
///
|
|
/// The debouncer will be created once and automatically disposed when the
|
|
/// widget is unmounted.
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// final debouncer = useDebouncer(const Duration(milliseconds: 300));
|
|
///
|
|
/// // Use the debouncer
|
|
/// debouncer.eventOccured(() {
|
|
/// // Your debounced action
|
|
/// });
|
|
/// ```
|
|
Debouncer useDebouncer(Duration duration) {
|
|
final debouncer = useMemoized(() => Debouncer(duration));
|
|
useEffect(() => debouncer.dispose, [debouncer]);
|
|
return debouncer;
|
|
}
|