Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

Navigator.clipboard — acesso assíncrono à área de transferência

Navigator.clipboard disponibiliza um objeto Clipboard para ler e escrever de forma assíncrona na área de transferência do sistema. Requer um contexto seguro e o acesso está sujeito às restrições do navegador.

Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxe

navigator.clipboard
const text = await navigator.clipboard.readText();
await navigator.clipboard.writeText(text)

Navigator.clipboard, acessível através de navigator.clipboard, é uma propriedade só de leitura que devolve o mesmo objeto Clipboard em leituras repetidas. Não guarda texto diretamente: readText() devolve uma Promise com o texto, enquanto writeText(text) devolve uma Promise que é cumprida sem valor após a escrita. read() e write() tratam dados representados por ClipboardItem.

Esta é uma Web API, não uma funcionalidade de ECMAScript; a presença de Node 24 num repositório não comprova o suporte nos navegadores. São necessários um contexto seguro e um documento ativo com foco. As permissões e os requisitos de ativação do utilizador dependem do navegador: inicia a escrita diretamente ao clicar e trata as rejeições, incluindo NotAllowedError. Detetar um método não garante o acesso.

Ao contrário de ClipboardEvent.clipboardData, associado aos eventos de cópia e colagem, esta interface é assíncrona. A área de transferência pode conter dados sensíveis; lê-a apenas para uma finalidade claramente definida e avisa antes de substituir o seu conteúdo.

Exemplos

<!doctype html>
<html lang="en">
<head><meta charset="utf-8"><title>Navigator clipboard write</title></head>
<body>
  <button type="button">Copy sample text</button>
  <p role="status"></p>
  <script>
    const button = document.querySelector('button');
    const status = document.querySelector('[role="status"]');
    const clipboard = navigator.clipboard;
    const canAttemptWrite = window.isSecureContext &&
      typeof clipboard?.writeText === 'function';

    status.textContent = canAttemptWrite
      ? 'Click to request a clipboard write.'
      : 'Clipboard write is unavailable in this document.';
    button.disabled = !canAttemptWrite;
    console.log(status.textContent);

    button.addEventListener('click', async () => {
      try {
        await clipboard.writeText('CKTIS');
        status.textContent = 'Sample text copied.';
      } catch (error) {
        status.textContent = 'Clipboard write failed: ' + error.name;
      }
    });
  </script>
</body>
</html>

Resultado

Before interaction, the page reports whether a user-initiated clipboard write can be attempted. If it can, clicking the button reports either success or the browser's error name.

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes