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 liefert eine Promise, die mit einer Kopie der textuellen Inhalte der Systemzwischenablage 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

Eine Promise, die mit einem String aufgelöst wird, der die textuellen Inhalte der Zwischenablage enthält.

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

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 nicht in der Lage ist, eine textuelle Darstellung bereitzustellen.

Sicherheitsüberlegungen

Das Lesen aus der Zwischenablage kann nur in einem sicheren Kontext erfolgen.

Zusätzliche Sicherheitsanforderungen sind im Abschnitt Sicherheitsüberlegungen des API-Übersichtsthemas behandelt.

Beispiele

Dieses Beispiel ruft die textuellen Inhalte der Zwischenablage ab und fügt den zurückgegebenen Text in die Inhalte 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