electron-clipboard-listener
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Electron Clipboard Listener

Electron helper to listen for when user copies new text to clipboard

Usage

Basic Setup

import {
  ListeningClipboard,
  ListeningClipboardEvents,
} from "electron-clipboard-listener";

ListeningClipboard.startWatching();
ListeningClipboard.on(ListeningClipboardEvents.TEXT_UPDATED, (newText) => {
  console.log("Here you will get the new copied text", newText);
});

Start listening for new clipboard events

ListeningClipboard.startWatching();
Parameter Type Description
interval number Optional. Interval between polling for new text in clipboard. Defaults to 750ms

Get updated clipboard text

ListeningClipboard.startWatching(event, callback);
Parameter Type Description
event ListeningClipboardEvents Required. Type of event to listen for, currently supports 'text' only
callback (newText:string) => void Required. Callback function to get the new copied text

Contributing

Contributions are of course welcome.

Optimizations

This currently works by simply polling and comparing previous clipboard text with current, it would be so much better if this could tap into a native event.

Acknowledgements

  • Inspired by
  • Main Motivation for creating this: Better performance, less 'extra' data/processing, fixing a critical bug where if a user copys more than 1 image the old package crashes.

Readme

Keywords

Package Sidebar

Install

npm i electron-clipboard-listener

Weekly Downloads

0

Version

1.0.0

License

ISC

Unpacked Size

4.24 kB

Total Files

4

Last publish

Collaborators

  • jaseowens