Clipboard: readText()-Methode

Baseline 2024
Newly available

Since June 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Die readText()-Methode der Clipboard-Schnittstelle gibt ein Promise zurück, das mit einer Kopie des Textinhalts der System-Zwischenablage erfüllt wird.

Hinweis: Um nicht-textuelle Inhalte aus der Zwischenablage zu lesen, verwenden Sie stattdessen die read()-Methode. Sie können Text in die Zwischenablage schreiben, indem Sie die writeText()-Methode verwenden.

Syntax

js
readText()

Parameter

Keine.

Rückgabewert

Ein Promise, das mit einem String erfüllt wird, der den Textinhalt der Zwischenablage enthält.

Gibt einen leeren String zurück, wenn die Zwischenablage leer ist, keinen Text enthält oder keine Textdarstellung unter den Objekten, die den Inhalt der Zwischenablage repräsentieren, enthält.

Ausnahmen

NotAllowedError DOMException

Wird ausgelöst, wenn der Zugriff zum Lesen der Zwischenablage nicht erlaubt ist.

NotFoundError DOMException

Wird ausgelöst, wenn die Zwischenablage angibt, dass sie Daten enthält, die als Text dargestellt werden können, aber keine Textdarstellung bereitstellen kann.

Sicherheitsüberlegungen

Lesen von der Zwischenablage kann nur in einem sicheren Kontext erfolgen.

Zusätzliche Sicherheitsanforderungen werden im Abschnitt Sicherheitsüberlegungen des API-Überblicks behandelt.

Beispiele

Dieses Beispiel ruft den Textinhalt der Zwischenablage ab und fügt den zurückgegebenen Text in den Inhalt eines ausgewählten Elements ein.

js
const destination = document.getElementById("outbox");
destinationImage.addEventListener("click", () => {
  navigator.clipboard
    .readText()
    .then((clipText) => (destination.innerText = clipText));
});

Spezifikationen

Specification
Clipboard API and events
# dom-clipboard-readtext

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch