sidebarAction.setTitle()
Устанавливает заголовок боковой панели. Заголовок отображается везде, где браузер отображает доступные боковые панели. Например, Firefox отобразит его в меню "Вид > Боковая панель". Он также отображается в верхней части боковой панели при открытии боковой панели.
Типы заголовков
Ваше расширение должно указать заголовок для боковой панели в ключе sidebar_action манифеста. Это называется "заголовок манифеста". Если вы не укажете заголовок манифеста, он будет по умолчанию равен имени расширения.
Если вы установите новый заголовок с помощью setTitle(), и включите опцию tabId, то заголовок будет установлен только для данного вкладки. Этот заголовок называется "заголовок, специфичный для вкладки".
Если вы установите новый заголовок с помощью setTitle(), и включите опцию windowId, то заголовок будет установлен только для данного окна. Этот заголовок называется "заголовок, специфичный для окна", и он будет отображаться во всех вкладках этого окна, в которых не установлен заголовок, специфичный для вкладки.
Если вы установите новый заголовок с помощью setTitle(), и опустите оба параметра tabId и windowId, тогда это установит "глобальный заголовок". Глобальный заголовок будет отображаться во всех вкладках, в которых не установлен заголовок, специфичный для вкладки, и у которых окно не имеет заголовка, специфичного для окна.
Синтаксис
browser.sidebarAction.setTitle( details // object )
Параметры
details-
object. Объект со следующими свойствами:title-
stringилиnull. Новый заголовок боковой панели.Если
titleпустая строка, используемый заголовок будет именем расширения, ноsidebarAction.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 for Android | Opera Android | Safari на IOS | Samsung Internet | |
setTitle |
Нет | Нет | 54 | ? | 30 | Нет | ? | ? | Нет | ? | Нет | ? |
null |
Нет | Нет | 59 | ? | Нет | Нет | ? | ? | Нет | ? | Нет | ? |
Примеры
Этот код изменяет заголовок боковой панели, когда пользователь нажимает на действие браузера, но только для текущей вкладки:
let title = "A different title"; function setTitleForTab(tab) { browser.sidebarAction.setTitle({title, tabId: tab.id}); } browser.browserAction.onClicked.addListener(setTitleForTab);
Примечание: Этот API основан на API chrome.sidebarAction Opera.
© 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/sidebarAction/setTitle