Added an option for ClipboardPaste button to disable ClipboardMonitor

CHANGELOG.md

@@ -12,8 +12,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `enableClipboardPaste` flag in `QuillToolbarClipboardButton` to determine if the button defaults to `null,` which will use `ClipboardMonitor`, which checks every second if the clipboard has content to paste [#2427](https://github.com/singerdmx/flutter-quill/pull/2427).
 - Croatian (hr) language translation.
 
+### Changed
+
+- Prevent `ClipboardMonitor` from doing multiple simultaneous clipboard checks to improve performance [#2427](https://github.com/singerdmx/flutter-quill/pull/2427) which is used when the clipboard paste button (`QuillToolbarClipboardButton`) is enabled in the toolbar.
+
 ## [11.0.0-dev.18] - 2025-01-06
 
 ### Changed

lib/src/toolbar/buttons/clipboard_button.dart

@@ -16,22 +16,38 @@ class ClipboardMonitor {
   bool get canPaste => _canPaste;
   Timer? _timer;
 
+  bool _isCheckingClipboard = false;
+
   void monitorClipboard(bool add, void Function() listener) {
     if (kIsWeb) return;
+
     if (add) {
       _timer = Timer.periodic(
-          const Duration(seconds: 1), (timer) => _update(listener));
+        const Duration(seconds: 1),
+        (timer) => _update(listener),
+      );
     } else {
       _timer?.cancel();
     }
   }
 
   Future<void> _update(void Function() listener) async {
+    // If the clipboard is already being checked, return early.
+    if (_isCheckingClipboard) {
+      return;
+    }
+
+    _isCheckingClipboard = true;
+
     final clipboardService = ClipboardServiceProvider.instance;
+
     if (await clipboardService.hasClipboardContent) {
       _canPaste = true;
+
       listener();
     }
+
+    _isCheckingClipboard = false;
   }
 }
 
@@ -49,15 +65,15 @@ class QuillToolbarClipboardButton extends QuillToolbarToggleStyleBaseButton {
 
   final ClipboardAction clipboardAction;
 
-  final ClipboardMonitor _monitor = ClipboardMonitor();
-
   @override
   State<StatefulWidget> createState() => QuillToolbarClipboardButtonState();
 }
 
 class QuillToolbarClipboardButtonState
     extends QuillToolbarToggleStyleBaseButtonState<
         QuillToolbarClipboardButton> {
+  final ClipboardMonitor _monitor = ClipboardMonitor();
+
   @override
   bool get currentStateValue {
     switch (widget.clipboardAction) {
@@ -66,23 +82,54 @@ class QuillToolbarClipboardButtonState
       case ClipboardAction.copy:
         return !controller.selection.isCollapsed;
       case ClipboardAction.paste:
-        return !controller.readOnly && (kIsWeb || widget._monitor.canPaste);
+        return !controller.readOnly &&
+            (kIsWeb ||
+                (widget.options.enableClipboardPaste ?? _monitor.canPaste));
     }
   }
 
   void _listenClipboardStatus() => didChangeEditingValue();
 
+  @override
+  void didUpdateWidget(QuillToolbarClipboardButton oldWidget) {
+    super.didUpdateWidget(oldWidget);
+
+    // Default didUpdateWidget handler, otherwise simple flag change didn't stop the monitor.
+    if (oldWidget.controller != controller) {
+      oldWidget.controller.removeListener(didChangeEditingValue);
+      removeExtraListener(oldWidget);
+      controller.addListener(didChangeEditingValue);
+      addExtraListener();
+      currentValue = currentStateValue;
+    }
+    // The controller didn't change, but enableClipboardPaste did.
+    else if (widget.clipboardAction == ClipboardAction.paste) {
+      final isTimerActive = _monitor._timer?.isActive ?? false;
+
+      // Enable clipboard monitoring if not active and should be monitored.
+      if (shouldUseClipboardMonitor && !isTimerActive) {
+        _monitor.monitorClipboard(true, _listenClipboardStatus);
+      }
+      // Disable clipboard monitoring if active and should not be monitored.
+      else if (!shouldUseClipboardMonitor && isTimerActive) {
+        _monitor.monitorClipboard(false, _listenClipboardStatus);
+      }
+
+      currentValue = currentStateValue;
+    }
+  }
+
   @override
   void addExtraListener() {
-    if (widget.clipboardAction == ClipboardAction.paste) {
-      widget._monitor.monitorClipboard(true, _listenClipboardStatus);
+    if (shouldUseClipboardMonitor) {
+      _monitor.monitorClipboard(true, _listenClipboardStatus);
     }
   }
 
   @override
   void removeExtraListener(covariant QuillToolbarClipboardButton oldWidget) {
-    if (widget.clipboardAction == ClipboardAction.paste) {
-      oldWidget._monitor.monitorClipboard(false, _listenClipboardStatus);
+    if (shouldUseClipboardMonitor) {
+      _monitor.monitorClipboard(false, _listenClipboardStatus);
     }
   }
 
@@ -100,6 +147,11 @@ class QuillToolbarClipboardButtonState
         ClipboardAction.paste => Icons.paste_outlined,
       };
 
+  bool get shouldUseClipboardMonitor {
+    return widget.clipboardAction == ClipboardAction.paste &&
+        widget.options.enableClipboardPaste == null;
+  }
+
   void _onPressed() {
     switch (widget.clipboardAction) {
       case ClipboardAction.cut:
@@ -131,16 +183,17 @@ class QuillToolbarClipboardButtonState
     }
 
     return UtilityWidgets.maybeTooltip(
-        message: tooltip,
-        child: QuillToolbarIconButton(
-          icon: Icon(
-            iconData,
-            size: iconSize * iconButtonFactor,
-          ),
-          isSelected: false,
-          onPressed: currentValue ? _onPressed : null,
-          afterPressed: afterButtonPressed,
-          iconTheme: iconTheme,
-        ));
+      message: tooltip,
+      child: QuillToolbarIconButton(
+        icon: Icon(
+          iconData,
+          size: iconSize * iconButtonFactor,
+        ),
+        isSelected: false,
+        onPressed: currentValue ? _onPressed : null,
+        afterPressed: afterButtonPressed,
+        iconTheme: iconTheme,
+      ),
+    );
   }
 }

lib/src/toolbar/config/base_button_options.dart

@@ -41,6 +41,7 @@ class QuillToolbarBaseButtonOptions<T, I> {
     this.afterButtonPressed,
     this.tooltip,
     this.iconTheme,
+    this.enableClipboardPaste,
     this.childBuilder,
   });
 
@@ -65,6 +66,13 @@ class QuillToolbarBaseButtonOptions<T, I> {
   /// Use custom theme
   final QuillIconTheme? iconTheme;
 
+  /// Determines if the paste button is enabled. The button is disabled and cannot be clicked if set to `false`.
+  ///
+  /// Defaults to [ClipboardMonitor] in case of `null`, which checks if the clipboard has content to paste every second and only then enables the button, indicating to the user that they can paste something.
+  ///
+  /// Set it to `true` to enable it even if the clipboard has no content to paste, which will do nothing on a press.
+  final bool? enableClipboardPaste;
+
   /// If you want to display a different widget based using a builder
   final QuillToolbarButtonOptionsChildBuilder<T, I> childBuilder;
 }

lib/src/toolbar/config/buttons/toggle_style_options.dart

@@ -29,5 +29,6 @@ class QuillToolbarToggleStyleButtonOptions
     super.afterButtonPressed,
     super.iconTheme,
     super.childBuilder,
+    super.enableClipboardPaste,
   });
 }