tabs.toggleReaderMode()

Wechselt den Lesemodus für den angegebenen Tab.

Diese Funktion schaltet den Lesemodus für den angegebenen Tab um. Sie nimmt eine Tab-ID als Parameter: Wenn dieser weggelassen wird, wird der aktuell aktive Tab umgeschaltet.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Der Lesemodus, auch als Leseansicht bekannt, ist eine Browserfunktion, die es dem Benutzer erleichtert, sich auf einen Artikel zu konzentrieren, indem:

  • nicht wesentliche Seitenelemente wie Seitenleisten, Fußzeilen und Werbung ausgeblendet werden
  • die Textgröße, der Kontrast und das Layout der Seite für bessere Lesbarkeit geändert werden.

Der Lesemodus ist insbesondere für Artikel nützlich: also Seiten, die einen Textinhalt als Hauptmerkmal haben. Seiten, die keinen erkennbaren Artikel haben, kommen nicht für die Anzeige im Lesemodus in Frage. Um herauszufinden, ob eine Seite ein Artikel ist, überprüfen Sie die isArticle-Eigenschaft von tabs.Tab.

Um herauszufinden, ob ein Tab bereits im Lesemodus ist, überprüfen Sie die isInReaderMode-Eigenschaft von tabs.Tab. Um zu verfolgen, wann Tabs in den oder aus dem Lesemodus wechseln, müssen Sie den aktuellen Zustand aller Tabs im Auge behalten und überprüfen, wann sich isInReaderMode ändert:

js
function handleUpdated(tabId, changeInfo, tabInfo) {
  if (changeInfo.status === "complete") {
    console.log(`Tab ${tabId} reader mode: ${tabInfo.isInReaderMode}`);
  }
}

browser.tabs.onUpdated.addListener(handleUpdated);

Syntax

js
let toggling = browser.tabs.toggleReaderMode(
  tabId            // optional integer
)

Parameter

tabId Optional

integer. Die ID des Tabs, der im Lesemodus angezeigt werden soll. Standardmäßig wird der ausgewählte Tab des aktuellen Fensters verwendet.

Rückgabewert

Ein Promise, das ohne Argumente erfüllt wird, wenn der Tab aktualisiert wurde. Wenn ein Fehler auftritt (zum Beispiel, weil die Seite kein Artikel war), wird das Promise mit einer Fehlermeldung abgelehnt.

Beispiele

Dieser Code schaltet jede neue Seite in den Lesemodus, wenn diese dafür geeignet ist:

js
function switchToReaderMode(tabId, changeInfo, tabInfo) {
  if (changeInfo.isArticle) {
    browser.tabs.toggleReaderMode(tabId);
  }
}

browser.tabs.onUpdated.addListener(switchToReaderMode);

Browser-Kompatibilität

BCD tables only load in the browser