Skip to main content
Home

A Tauri clipboard plugin with text, files, html, RTF, and image support. Clipboard content update monitoring is also supported.

This package works with BrowsersIt is unknown whether this package works with Node.js, Deno, Bun
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Bun
This package works with Browsers
JSR Score
41%
Published
a year ago (2.1.6)
v
AVAILABLE_TYPES_COMMAND
No documentation available
T
AvailableTypes
No documentation available
f
clear
No documentation available
v
CLEAR_COMMAND
No documentation available
v
CLIPBOARD_MONITOR_STATUS_UPDATE_EVENT
No documentation available
v
ClipboardBinaryChangedPayloadSchema
No documentation available
v
ClipboardChangedFilesPayloadSchema
No documentation available
T
ClipboardChangedPayload
No documentation available
v
ClipboardChangedPayloadSchema
No documentation available
f
convertIntArrToUint8Array
No documentation available
f
convertUint8ArrayToBlob
No documentation available
N
default
No documentation available
v
default.AVAILABLE_TYPES_COMMAND
No documentation available
T
f
default.clear
No documentation available
v
default.CLEAR_COMMAND
No documentation available
v
v
v
default.ClipboardChangedFilesPayloadSchema
No documentation available
T
default.ClipboardChangedPayload
No documentation available
v
default.ClipboardChangedPayloadSchema
No documentation available
f
default.convertIntArrToUint8Array
No documentation available
f
default.convertUint8ArrayToBlob
No documentation available
v
default.FILES_CHANGED
No documentation available
f
default.getAvailableTypes
No documentation available
v
default.HAS_FILES_COMMAND
No documentation available
v
default.HAS_HTML_COMMAND
No documentation available
v
default.HAS_IMAGE_COMMAND
No documentation available
v
default.HAS_RTF_COMMAND
No documentation available
v
default.HAS_TEXT_COMMAND
No documentation available
f
default.hasFiles
No documentation available
f
default.hasHTML
No documentation available
f
default.hasImage
No documentation available
f
default.hasRTF
No documentation available
f
default.hasText
No documentation available
v
default.HTML_CHANGED
No documentation available
v
default.IMAGE_BINARY_CHANGED
No documentation available
v
default.IMAGE_CHANGED
No documentation available
v
default.IS_MONITOR_RUNNING_COMMAND
No documentation available
f
default.isMonitorRunning

Used to check the status of clipboard monitor

f
default.listenToClipboard

Listen to "plugin:clipboard://clipboard-monitor/update" from Tauri core. The corresponding clipboard type event will be emitted when there is clipboard update.

f
default.listenToMonitorStatusUpdate

Listen to monitor status update. Instead of calling isMonitorRunning to get status of monitor, "plugin:clipboard://clipboard-monitor/status" event is emitted from Tauri core when monitor status updates.

v
default.MONITOR_UPDATE_EVENT
No documentation available
f
default.onClipboardUpdate

This listen to clipboard monitor update event, and trigger the callback function. However from this event we don't know whether it's text or image, no real data is returned. Use with listenToClipboard function.

f
default.onFilesUpdate
No documentation available
f
default.onHTMLUpdate
No documentation available
f
default.onImageBinaryUpdate
No documentation available
f
default.onImageUpdate
No documentation available
f
default.onRTFUpdate
No documentation available
f
default.onSomethingUpdate

Listen to clipboard update event and get the updated types in a callback. This listener tells you what types of data are updated. This relies on listenToClipboard() who emits events this function listens to. You can run listenToClipboard() or startListening() before calling this function. When HTML is copied, this will be passed to callback: {files: false, image: false, html: true, rtf: false, text: true}

f
default.onTextUpdate
No documentation available
v
default.READ_FILES_COMMAND
No documentation available
v
default.READ_FILES_URIS_COMMAND
No documentation available
v
default.READ_HTML_COMMAND
No documentation available
v
default.READ_IMAGE_BASE64_COMMAND
No documentation available
v
default.READ_IMAGE_BINARY_COMMAND
No documentation available
v
default.READ_RTF_COMMAND
No documentation available
v
default.READ_TEXT_COMMAND
No documentation available
f
default.readFiles
No documentation available
f
default.readFilesURIs
No documentation available
f
default.readHtml
No documentation available
f
default.readImageBase64

read clipboard image

f
default.readImageBinary

Read clipboard image, get the data in binary format int_array (Array) is received from Tauri core, Uint8Array and Blob are transformed from int_array

f
default.readImageObjectURL

Here is the transformation flow, read clipboard image as Array (int_array) -> int_array -> Uint8Array -> Blob -> ObjectURL There are many layers which could make this function slow for large images.

f
default.readRtf
No documentation available
f
default.readText
No documentation available
v
default.RTF_CHANGED
No documentation available
v
default.SOMETHING_CHANGED
No documentation available
v
default.START_MONITOR_COMMAND
No documentation available
f
default.startListening
No documentation available
f
default.startMonitor

Start running mointor thread in Tauri core. This feature is added in v0.5.x. Before v0.5.x, the monitor is started during setup when app starts. After v0.5.x, this function must be called first to start monitor. After monitor is started, events "plugin:clipboard://clipboard-monitor/update" will be emitted when there is clipboard update. "plugin:clipboard://clipboard-monitor/status" event is also emitted when monitor status updates Still have to listen to these events.

v
default.STOP_MONITOR_COMMAND
No documentation available
f
default.stopMonitor

Stop clipboard monitor thread.

v
default.TEXT_CHANGED
No documentation available
v
default.WRITE_FILES_COMMAND
No documentation available
v
default.WRITE_FILES_URIS_COMMAND
No documentation available
v
default.WRITE_HTML_AND_TEXT_COMMAND
No documentation available
v
default.WRITE_HTML_COMMAND
No documentation available
v
default.WRITE_IMAGE_BASE64_COMMAND
No documentation available
v
default.WRITE_IMAGE_BINARY_COMMAND
No documentation available
v
default.WRITE_RTF_COMMAND
No documentation available
v
default.WRITE_TEXT_COMMAND
No documentation available
f
default.writeFiles
No documentation available
f
default.writeFilesURIs
No documentation available
f
default.writeHtml
No documentation available
f
default.writeHtmlAndText

Write html and text to clipboard. writeHtml API only writes html, readText will return nothing. This API writes both html and text, so readText will return the text.

f
default.writeImageBase64

write image to clipboard

f
default.writeImageBinary
No documentation available
f
default.writeRtf
No documentation available
f
default.writeText
No documentation available
v
FILES_CHANGED
No documentation available
f
getAvailableTypes
No documentation available
v
HAS_FILES_COMMAND
No documentation available
v
HAS_HTML_COMMAND
No documentation available
v
HAS_IMAGE_COMMAND
No documentation available
v
HAS_RTF_COMMAND
No documentation available
v
HAS_TEXT_COMMAND
No documentation available
f
hasFiles
No documentation available
f
hasHTML
No documentation available
f
hasImage
No documentation available
f
hasRTF
No documentation available
f
hasText
No documentation available
v
HTML_CHANGED
No documentation available
v
IMAGE_BINARY_CHANGED
No documentation available
v
IMAGE_CHANGED
No documentation available
v
IS_MONITOR_RUNNING_COMMAND
No documentation available
f
isMonitorRunning

Used to check the status of clipboard monitor

f
listenToClipboard

Listen to "plugin:clipboard://clipboard-monitor/update" from Tauri core. The corresponding clipboard type event will be emitted when there is clipboard update.

f
listenToMonitorStatusUpdate

Listen to monitor status update. Instead of calling isMonitorRunning to get status of monitor, "plugin:clipboard://clipboard-monitor/status" event is emitted from Tauri core when monitor status updates.

v
MONITOR_UPDATE_EVENT
No documentation available
f
onClipboardUpdate

This listen to clipboard monitor update event, and trigger the callback function. However from this event we don't know whether it's text or image, no real data is returned. Use with listenToClipboard function.

f
onFilesUpdate
No documentation available
f
onHTMLUpdate
No documentation available
f
onImageBinaryUpdate
No documentation available
f
onImageUpdate
No documentation available
f
onRTFUpdate
No documentation available
f
onSomethingUpdate

Listen to clipboard update event and get the updated types in a callback. This listener tells you what types of data are updated. This relies on listenToClipboard() who emits events this function listens to. You can run listenToClipboard() or startListening() before calling this function. When HTML is copied, this will be passed to callback: {files: false, image: false, html: true, rtf: false, text: true}

f
onTextUpdate
No documentation available
v
READ_FILES_COMMAND
No documentation available
v
READ_FILES_URIS_COMMAND
No documentation available
v
READ_HTML_COMMAND
No documentation available
v
READ_IMAGE_BASE64_COMMAND
No documentation available
v
READ_IMAGE_BINARY_COMMAND
No documentation available
v
READ_RTF_COMMAND
No documentation available
v
READ_TEXT_COMMAND
No documentation available
f
readFiles
No documentation available
f
readFilesURIs
No documentation available
f
readHtml
No documentation available
f
readImageBase64

read clipboard image

f
readImageBinary

Read clipboard image, get the data in binary format int_array (Array) is received from Tauri core, Uint8Array and Blob are transformed from int_array

f
readImageObjectURL

Here is the transformation flow, read clipboard image as Array (int_array) -> int_array -> Uint8Array -> Blob -> ObjectURL There are many layers which could make this function slow for large images.

f
readRtf
No documentation available
f
readText
No documentation available
v
RTF_CHANGED
No documentation available
v
SOMETHING_CHANGED
No documentation available
v
START_MONITOR_COMMAND
No documentation available
f
startListening
No documentation available
f
startMonitor

Start running mointor thread in Tauri core. This feature is added in v0.5.x. Before v0.5.x, the monitor is started during setup when app starts. After v0.5.x, this function must be called first to start monitor. After monitor is started, events "plugin:clipboard://clipboard-monitor/update" will be emitted when there is clipboard update. "plugin:clipboard://clipboard-monitor/status" event is also emitted when monitor status updates Still have to listen to these events.

v
STOP_MONITOR_COMMAND
No documentation available
f
stopMonitor

Stop clipboard monitor thread.

v
TEXT_CHANGED
No documentation available
T
v
WRITE_FILES_COMMAND
No documentation available
v
WRITE_FILES_URIS_COMMAND
No documentation available
v
WRITE_HTML_AND_TEXT_COMMAND
No documentation available
v
WRITE_HTML_COMMAND
No documentation available
v
WRITE_IMAGE_BASE64_COMMAND
No documentation available
v
WRITE_IMAGE_BINARY_COMMAND
No documentation available
v
WRITE_RTF_COMMAND
No documentation available
v
WRITE_TEXT_COMMAND
No documentation available
f
writeFiles
No documentation available
f
writeFilesURIs
No documentation available
f
writeHtml
No documentation available
f
writeHtmlAndText

Write html and text to clipboard. writeHtml API only writes html, readText will return nothing. This API writes both html and text, so readText will return the text.

f
writeImageBase64

write image to clipboard

f
writeImageBinary
No documentation available
f
writeRtf
No documentation available
f
writeText
No documentation available
f
default.startBruteForceImageMonitor
No documentation available
f
default.startBruteForceTextMonitor
No documentation available
f
startBruteForceImageMonitor
No documentation available
f
startBruteForceTextMonitor
No documentation available

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.