Skip to main content

clipboard

Read from and write to the system clipboard via the async Clipboard API.

Import: @rtorcato/browser-common/clipboard

📖 MDN: Clipboard API · 📊 caniuse: async clipboard

Requires a secure context (HTTPS, or localhost in dev). Writing is generally allowed from a user gesture; reading may prompt for permission.

Example​

import {
  isClipboardApiAvailable,
  copyToClipboard,
  readFromClipboard,
} from '@rtorcato/browser-common/clipboard'

if (isClipboardApiAvailable()) {
  await copyToClipboard('Copied from the app')
  const text = await readFromClipboard()
  console.log(text)
}

Exports​

  • isClipboardApiAvailable() — feature check
  • copyToClipboard(text) — write a string to the clipboard
  • copyElementTextToClipboard(element) — copy an element's text content
  • readFromClipboard() — read the clipboard's text

See the API reference for full signatures.