onClipboardPaste property

  1. @experimental
Future<bool> Function()? onClipboardPaste
final

Callback to allow overriding the default clipboard paste handling.

A minimal example of removing the plain text if it exists in the system clipboard, otherwise fallback to the default handling:

onClipboardPaste: () async {
  final clipboardData = await Clipboard.getData(Clipboard.kTextPlain);
  if (clipboardData != null) {
    await Clipboard.setData(const ClipboardData(text: ''));
    // The paste operation was handled
    return true;
  }
  // Fallback to the default handling
  return false;
}

An example of disabling the clipboard paste:

onClipboardPaste: () async {
  return true;
}

Return true if the paste operation was handled or false to fallback to the default clipboard paste handling.

Implementation

@experimental
final Future<bool> Function()? onClipboardPaste;