Modules

sidebarAction.setPanel()

Définit le panneau de la barre latérale: c'est-à-dire le document HTML qui définit le contenu de cette barre latérale.

Types de panneau

Les barres latérales ont toujours un "panneau manifest", qui est le panneau défini dans la clé de manifest sidebar_action.

Si vous définissez un nouveau panneau à l'aide de setPanel(), et incluez l'option tabId le panneau est défini uniquement pour l'onglet donné. Ce panneau est appelé  "tab-specific panel".

Si vous définissez un nouveau panneau à l'aide de setPanel(), et omettez l'option  tabId de setPanel(), cela définit le "global panel". Le panneau global apparaît alors dans tous les onglets qui n'ont pas de jeu de panneaux spécifique aux onglets.

Syntaxe

browser.sidebarAction.setPanel(
  details // object
)

Paramètres

details
object.
tabIdFacultatif
integer. Définit le panneau uniquement pour un onglet spécifique. Si omis, le panneau global est défini à la place.
panel
string ou null. Le panneau à charger dans la barre latérale, spécifié comme une URL pointant vers un document HTML, ou null, ou une chaîne vide.
Cela peut pointer vers un fichier empaqueté dans l'extension (par exemple, créé en utilisant extension.getURL), ou un document distant (par exemple https://example.org/). Ce doit être une URL valide..
Si panel est null ou "", et tabId a été spécifié, et que l'onglet spécifié possède un ensemble de panneaux spécifique aux onglets: alors le panneau spécifique aux onglets est réinitialisé au panneau global (si un panneau global est défini) ou au panneau manifest.
Si panel est null"", et tabId a été omis, alors s'il y avait un ensemble de panneaux global, il sera réinitialisé dans le panneau de manifest.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Non Non54 Non Oui
The panel property of the details parameter can be set to null. Non Non59 Non Non
details.windowId Non Non61 Non Non

Exemples

Ce code bascule le document de la barre latérale lorsque l'utilisateur clique sur une action du navigateur :

var thisPanel = browser.extension.getURL("/this.html");
var thatPanel = browser.extension.getURL("/that.html");

function toggle(panel) {
  if (panel === thisPanel) {
    browser.sidebarAction.setPanel({panel: thatPanel});
  } else {
    browser.sidebarAction.setPanel({panel: thisPanel});
  }
}

browser.browserAction.onClicked.addListener(() => {
  browser.sidebarAction.getPanel({}).then(toggle);
});

Remerciements :

Cette API est basée sur l'API Opera chrome.sidebarAction.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.

Étiquettes et contributeurs liés au document

Contributeurs à cette page : hellosct1
Dernière mise à jour par : hellosct1,