Overstappen naar de naamruimte van de browser

Vanaf Chrome 148 zijn alle Chrome Extension API's beschikbaar onder de naamruimte browser, naast de bestaande naamruimte chrome. browser.tabs.create({}) en chrome.tabs.create({}) zijn bijvoorbeeld gelijkwaardig.

De naamruimte is overal beschikbaar waar je extensie-API's kunt aanroepen, waaronder contentscripts, servicemedewerkers en documenten buiten het scherm. Het verwijst naar dezelfde API-objecten als chrome, dus chrome.tabs === browser.tabs.

De naamruimte browser is het resultaat van werk in de WebExtensions Community Group (WECG), een W3C-communitygroep waarin browserleveranciers samenwerken aan gedeelde extensienormen. De naamruimte chrome verdwijnt niet. Beide naamruimten blijven werken.

Beslissen of je de naamruimte van de browser wilt overnemen

Als je webextension-polyfill gebruikt, ga je verder naar Een opmerking voor polyfill-gebruikers voordat je iets anders wijzigt. Het antwoord is anders voor jou.

Als je een nieuwe extensie maakt, stel je minimum_chrome_version in op "148" en gebruik je browser onvoorwaardelijk. Je kunt hier stoppen met lezen. De rest van dit gedeelte is bedoeld voor bestaande extensies die willen overstappen.

Controleren welke Chrome-versies je gebruikers hebben

Als je een bestaande extensie hebt, controleer je welke versies van Chrome je gebruikers hebben voordat je overstapt. Chrome wordt automatisch geüpdatet, maar sommige gebruikers zetten updates uit en anderen gebruiken oudere apparaten waarop de nieuwste versie niet kan worden uitgevoerd. Bevestig dit met je eigen analytische gegevens. Als je nog geen analyse hebt ingesteld, ga je naar De prestaties van je extensie bijhouden met Google Analytics 4 om aan de slag te gaan.

Kies daarna een pad:

Onvoorwaardelijk adopteren

Stel minimum_chrome_version in je manifest in en gebruik browser onvoorwaardelijk. Er is geen runtime-beveiliging nodig:

{
  "minimum_chrome_version": "148"
}

Gebruik een gefaseerde implementatie als je minimum_chrome_version verhoogt. Als er iets misgaat, kun je je extensie terugzetten in de Chrome Web Store.

De runtimebeveiliging gebruiken

Voeg het volgende fragment vroeg in de opstartcode van je extensie toe voordat je ergens anders naar browser verwijst:

if (!globalThis.browser) {
  globalThis.browser = chrome;
  // Consider firing an analytics event here to measure how often
  // your users hit this fallback path.
}

Hierdoor wordt browser een alias voor chrome in eerdere versies, zodat de rest van je code browser onvoorwaardelijk kan gebruiken.

Een opmerking voor polyfill-gebruikers

Als je extensie webextension-polyfill gebruikt, wordt dit een no-op in Chrome 148 en hoger. De polyfill heeft het verpakken overgeslagen toen browser al was gedefinieerd, ervan uitgaande dat de hostbrowser de API al had geleverd.

Een eerdere poging om de naamruimte in Chrome 136 te leveren, is om deze reden teruggedraaid: met browser nieuw gedefinieerd, stopte de polyfill met wrappen, maar de browser.runtime.onMessage van Chrome ondersteunde nog geen listeners die een promise retourneren, wat de polyfill wel had gedaan. Extensies die afhankelijk waren van dat patroon, werkten niet meer. Chrome 148 levert de naamruimte en systeemeigen promise-returning onMessage listeners samen om die kloof te voorkomen.

Je kunt de polyfill-afhankelijkheid verwijderen zodra je gebruikersbestand is overgestapt naar Chrome 148.

Andere functies

Asynchrone reacties in runtime.sendMessage

In Chrome 148 kunnen runtime.onMessage-listeners rechtstreeks een Promise retourneren om een asynchrone reactie te sturen. Dit werkt of je het nu aanroept met chrome.* of browser.*.

Eerder was de enige manier om asynchroon te reageren een letterlijke true terug te sturen vanuit de listener en later sendResponse aan te roepen:

// Old pattern - requires returning true to keep the channel open
chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
  fetch('https://example.com')
    .then(response => sendResponse({ statusCode: response.status }));

  return true; // keeps the message channel open for the async response
});

Je kunt nu rechtstreeks een Promise retourneren (of een async-functie gebruiken):

// New pattern - return a promise or use async/await
browser.runtime.onMessage.addListener(async (message, sender) => {
  const response = await fetch('https://example.com');
  return { statusCode: response.status };
});

Het patroon return true blijft werken, dus bestaande code hoeft niet te worden gewijzigd.