Spec-Zone.ru › Web Extensions

browserAction.setTitle()

Устанавливает заголовок действия браузера. Заголовок отображается в всплывающей подсказке над иконкой действия браузера. Вы можете передать tabId или windowId в качестве необязательного параметра — если вы это сделаете, заголовок будет изменён только для данного вкладки или данного окна. Вкладки или окна без конкретного заголовка унаследуют глобальный текст заголовка, который по умолчанию равен default_title или name, указанному в манифесте.

Синтаксис

browser.browserAction.setTitle(
  details // object
)

Параметры

details

object. Новый заголовок и, необязательно, идентификатор вкладки или окна, на которые он должен быть нацелен.

title

string или null. Строка, которую действие браузера должно отображать при наведении курсора.

Если title пустая строка, используемый заголовок будет именем расширения, но browserAction.getTitle по-прежнему вернёт пустую строку.

Если title равно null:

  • Если tabId указан, и у вкладки установлен специфичный для неё заголовок, тогда вкладка унаследует заголовок от окна, к которому она принадлежит.
  • если windowId указан, и у окна установлен специфичный для него заголовок, тогда окно унаследует глобальный заголовок.
  • В противном случае, глобальный заголовок будет сброшен до заголовка манифеста.
tabId Необязательно

integer. Устанавливает заголовок только для данной вкладки.

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

integer. Устанавливает заголовок для данного окна.

  • Если windowId и tabId оба указаны, функция завершается ошибкой, и заголовок не устанавливается.
  • Если windowId и tabId оба опущены, устанавливается глобальный заголовок.

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

Рабочий стол Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox для Android Opera Android Safari на iOS Samsung Internet
setTitle Да 15 45
45–58Заголовки, специфичные для вкладки, не очищаются при загрузке новой страницы.
? Да 14 ? ? 55
55–58Заголовки, специфичные для вкладки, не очищаются при загрузке новой страницы.
?
15API существует, но заголовок не отображается в пользовательском интерфейсе.
?
details_windowId_parameter Нет Нет 62 ? Нет Нет ? ? 79 ? Нет ?
null Нет Нет 59 ? Нет 14 ? ? 79 ? 15 ?

Примеры

Этот код переключает заголовок между "это" и "то" каждый раз, когда пользователь нажимает на действие браузера:

function toggleTitle(title) {
  if (title === "this") {
    browser.browserAction.setTitle({ title: "that" });
  } else {
    browser.browserAction.setTitle({ title: "this" });
  }
}

browser.browserAction.onClicked.addListener(() => {
  let gettingTitle = browser.browserAction.getTitle({});
  gettingTitle.then(toggleTitle);
});

Примеры расширений

  • bookmark-it

Примечание: Этот API основан на API chrome.browserAction Chromium. Данная документация взята из browser_action.json кода Chromium.

© 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/browserAction/setTitle

Spec-Zone.ru

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