Spec-Zone.ru › Web Extensions

tabs.toggleReaderMode()

Переключает режим чтения для заданного вкладки.

Эта функция переключает режим чтения для данной вкладки. Она принимает идентификатор вкладки в качестве параметра: если он опущен, переключается текущая активная вкладка.

Это асинхронная функция, которая возвращает Promise.

Режим чтения, также известный как режим просмотра статьи, — это функция браузера, которая облегчает пользователю сосредоточение на статье путём:

  • скрытия неважных элементов страницы, таких как боковые панели, подвалы и объявления
  • изменения размера текста, контрастности и макета страницы для лучшей читаемости.

Режим чтения полезен в основном для статей: то есть для страниц, содержащих в основном текстовое содержимое. Страницы, у которых нет четко идентифицируемой статьи, не подходят для отображения в режиме чтения. Чтобы определить, является ли страница статьёй, проверьте свойство isArticle объекта tabs.Tab.

Чтобы узнать, находится ли вкладка уже в режиме чтения, проверьте свойство isInReaderMode объекта tabs.Tab. Чтобы отслеживать изменения состояния вкладок в режим чтения или из него, вам необходимо отслеживать текущее состояние всех вкладок и проверять, когда isInReaderMode изменяется:

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

browser.tabs.onUpdated.addListener(handleUpdated);

Синтаксис

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

Параметры

tabId Необязательно

integer. Идентификатор вкладки, которую нужно отобразить в режиме чтения. По умолчанию используется выбранная вкладка текущего окна.

Возвращаемое значение

A Promise, который будет выполнен без аргументов, когда вкладка будет обновлена. Если произойдёт какая-либо ошибка (например, потому что страница не была статьёй), обещание будет отклонено с сообщением об ошибке.

Примеры

Этот код переключает каждую новую страницу в режим чтения, если эта страница подходит для него:

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

browser.tabs.onUpdated.addListener(switchToReaderMode);

Совместимость с браузерами

Рабочие столы Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari на IOS Samsung Internet
toggleReaderMode Нет Нет 58 ? Нет Нет ? ? Нет ? Нет ?

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/toggleReaderMode

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API