clipboard

Realiza las operaciones de copiar y pegar en el portapapeles del sistema.

Process: Main, Renderer (non-sandboxed only)

[!IMPORTANT] If you want to call this API from a renderer process with context isolation enabled, place the API call in your preload script and expose it using the contextBridge API.

En Linux, también hay un portapapeles selección. Para manipularlo necesita pasar selección a cada método:

const { clipboard } = require('electron')

clipboard.writeText('Example string', 'selection')
console.log(clipboard.readText('selection'))

Métodos

El módulo portapapeles tiene los siguientes métodos:

[!NOTE] Experimental APIs are marked as such and could be removed in future.

clipboard.readText([type])

• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Devuelve string - El contenido en el portapapeles como texto sin formato.

const { clipboard } = require('electron')

clipboard.writeText('hello i am a bit of text!')

const text = clipboard.readText()
console.log(text)
// hello i am a bit of text!'

clipboard.writeText(texto[, type])

• texto cadena
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Escribe el texto en el portapapeles como texto sin formato.

const { clipboard } = require('electron')

const text = 'hello i am a bit of text!'
clipboard.writeText(text)

clipboard.readHTML([type])

• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Devuelve string - El contenido en el portapapeles como marcado.

const { clipboard } = require('electron')

clipboard.writeHTML('<b>Hi</b>')
const html = clipboard.readHTML()

console.log(html)
// <meta charset='utf-8'><b>Hi</b>

clipboard.writeHTML(markup[, type])

• markup cadena
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Escribe markup en el portapapeles.

const { clipboard } = require('electron')

clipboard.writeHTML('<b>Hi</b>')

clipboard.readImage([type])

• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Returns NativeImage - The image content in the clipboard.

clipboard.writeImage(image[, type])

• image NativeImage
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Escribe image en el portapapeles.

clipboard.readRTF([type])

• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Devuelve string - El contenido in el portapapeles como RTF.

const { clipboard } = require('electron')

clipboard.writeRTF('{\\rtf1\\ansi{\\fonttbl\\f0\\fswiss Helvetica;}\\f0\\pard\nThis is some {\\b bold} text.\\par\n}')

const rtf = clipboard.readRTF()
console.log(rtf)
// {\\rtf1\\ansi{\\fonttbl\\f0\\fswiss Helvetica;}\\f0\\pard\nThis is some {\\b bold} text.\\par\n}

clipboard.writeRTF(text[, type])

• texto cadena
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Escribe el text en el portapapeles en RTF.

const { clipboard } = require('electron')

const rtf = '{\\rtf1\\ansi{\\fonttbl\\f0\\fswiss Helvetica;}\\f0\\pard\nThis is some {\\b bold} text.\\par\n}'
clipboard.writeRTF(rtf)

clipboard.readBookmark() macOS Windows

Devuelve Objecto:

• title string
• url string

Devuelve un Objeto que contiene las claves title y url que representan el marcador en el portapapeles. Los valores title y url serán cadenas vacías cuando el marcador no está disponible. The title value will always be empty on Windows.

clipboard.writeBookmark(title, url[, type]) macOS Windows

• title string - Unused on Windows
• url string
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Writes the title (macOS only) and url into the clipboard as a bookmark.

[!NOTE] Most apps on Windows don't support pasting bookmarks into them so you can use clipboard.write to write both a bookmark and fallback text to the clipboard.

const { clipboard } = require('electron')

clipboard.writeBookmark('Electron Homepage', 'https://electronjs.org')

clipboard.readFindText() macOS

Devuelve string - El texto en el portapapeles de búsqueda, el cual es el portapapeles que contiene información sobre el estado actual del panel de búsqueda de la aplicación.

Este método usa IPC síncrono cuando se llama desde el renderer process. El valor almacenado en el cache es re leído desde portapapeles de búsqueda cada vez que la aplicación se activa.

clipboard.writeFindText(text) macOS

• texto cadena

Escribe el text portapapeles de búsqueda ( portapapeles que contiene información sobre el estado actual del panel de búsqueda de la aplicación) como texto plano. Este método usa IPC síncrono cuando se llama desde el renderer process.

clipboard.clear([type])

• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Borra el contenido del portapapeles.

clipboard.availableFormats([type])

• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Devuelve string[] - Un arreglo de formatos soportados para el portapapeles type.

const { clipboard } = require('electron')

const formats = clipboard.availableFormats()
console.log(formats)
// [ 'text/plain', 'text/html' ]

clipboard.has(format[, type]) Experimental

• formato cadena
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Devuelve boolean: si el portapapeles admite el formato especificado.

const { clipboard } = require('electron')

const hasFormat = clipboard.has('public/utf8-plain-text')
console.log(hasFormat)
// 'true' or 'false'

clipboard.read(format) Experimental

• formato cadena

Devuelve string - Lee el tipo de formato del portapapeles.

format should contain valid ASCII characters and have / separator. a/c, a/bc are valid formats while /abc, abc/, a/, /a, a are not valid.

clipboard.readBuffer(format) Experimental

• formato cadena

Devuelve Buffer - Lee el formato del portapapeles.

const { clipboard } = require('electron')

const buffer = Buffer.from('this is binary', 'utf8')
clipboard.writeBuffer('public/utf8-plain-text', buffer)

const ret = clipboard.readBuffer('public/utf8-plain-text')

console.log(buffer.equals(ret))
// true

clipboard.writeBuffer(format, buffer[, type]) Experimental

• formato cadena
• buffer Buffer
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Escribe el buffer en el portapapeles como formato.

const { clipboard } = require('electron')

const buffer = Buffer.from('writeBuffer', 'utf8')
clipboard.writeBuffer('public/utf8-plain-text', buffer)

clipboard.write(data[, type])

• data Object
  • text cadena (opcional)
  • html cadena (opcional)
  • image NativeImage (optional)
  • rtf cadena (opcional)
  • bookmark string (opcional) - El título de la URL en text.
• type string (opcional) - Puede ser selection o clipboard; por defecto es 'clipboard'. selection solo está disponible en Linux.

Escribe datos en el portapapeles.

const { clipboard } = require('electron')

clipboard.write({
  text: 'test',
  html: '<b>Hi</b>',
  rtf: '{\\rtf1\\utf8 text}',
  bookmark: 'a title'
})

console.log(clipboard.readText())
// 'test'

console.log(clipboard.readHTML())
// <meta charset='utf-8'><b>Hi</b>

console.log(clipboard.readRTF())
// '{\\rtf1\\utf8 text}'

console.log(clipboard.readBookmark())
// { title: 'a title', url: 'test' }