chroom.actie

Beschrijving

Gebruik de chrome.action API om het pictogram van de extensie in de Google Chrome-werkbalk te beheren.

De actiepictogrammen worden weergegeven in de browserwerkbalk naast de omnibox . Na installatie verschijnen deze in het extensiemenu (het puzzelstukje-icoontje). Gebruikers kunnen uw extensiepictogram vastzetten op de werkbalk.

Beschikbaarheid

Chroom 88+ MV3+

Manifest

De volgende sleutels moeten in het manifest worden gedeclareerd om deze API te kunnen gebruiken.

"action"

Als u de chrome.action API wilt gebruiken, geeft u een "manifest_version" van 3 op en neemt u de sleutel "action" op in uw manifestbestand .

{
  "name": "Action Extension",
  ...
  "action": {
    "default_icon": {              // optional
      "16": "images/icon16.png",   // optional
      "24": "images/icon24.png",   // optional
      "32": "images/icon32.png"    // optional
    },
    "default_title": "Click Me",   // optional, shown in tooltip
    "default_popup": "popup.html"  // optional
  },
  ...
}

De "action" -toets (samen met de kinderen) is optioneel. Als deze niet is opgenomen, wordt uw extensie nog steeds weergegeven in de werkbalk om toegang te geven tot het menu van de extensie. Om deze reden raden wij u aan altijd minimaal de toetsen "action" en "default_icon" op te nemen.

Concepten en gebruik

Delen van de gebruikersinterface

Icon

Het pictogram is de hoofdafbeelding op de werkbalk van uw extensie en wordt ingesteld met de sleutel "default_icon" in de "action" -sleutel van uw manifest. Pictogrammen moeten 16 apparaatonafhankelijke pixels (DIP's) breed en hoog zijn.

De sleutel "default_icon" is een woordenboek met afmetingen voor afbeeldingspaden. Chrome gebruikt deze pictogrammen om te kiezen welke afbeeldingsschaal moet worden gebruikt. Als er geen exacte overeenkomst wordt gevonden, selecteert Chrome de dichtstbijzijnde beschikbare en schaalt deze zodat deze bij de afbeelding past, wat de beeldkwaliteit kan beïnvloeden.

Omdat apparaten met minder gebruikelijke schaalfactoren zoals 1,5x of 1,2x steeds vaker voorkomen, raden we u aan meerdere formaten voor uw pictogrammen op te geven. Dit maakt uw extensie ook toekomstbestendig tegen mogelijke wijzigingen in de weergavegrootte van pictogrammen. Als u echter slechts één grootte biedt, kan de sleutel "default_icon" ook worden ingesteld op een tekenreeks met het pad naar een enkel pictogram in plaats van naar een woordenboek.

U kunt ook action.setIcon() aanroepen om het pictogram van uw extensie programmatisch in te stellen door een ander afbeeldingspad op te geven of een dynamisch gegenereerd pictogram op te geven met behulp van het HTML canvas-element , of, indien ingesteld door een medewerker van de extensieservice, de canvas-API buiten het scherm .

const canvas = new OffscreenCanvas(16, 16);
const context = canvas.getContext('2d');
context.clearRect(0, 0, 16, 16);
context.fillStyle = '#00FF00';  // Green
context.fillRect(0, 0, 16, 16);
const imageData = context.getImageData(0, 0, 16, 16);
chrome.action.setIcon({imageData: imageData}, () => { /* ... */ });

Voor ingepakte extensies (geïnstalleerd vanuit een .crx-bestand) kunnen afbeeldingen de meeste formaten hebben die de Blink-rendering-engine kan weergeven, inclusief PNG, JPEG, BMP, ICO en andere. SVG wordt niet ondersteund. Uitgepakte extensies moeten PNG-afbeeldingen gebruiken.

Tooltip (titel)

De tooltip, of titel, verschijnt wanneer de gebruiker de muisaanwijzer op het pictogram van de extensie in de werkbalk houdt. Het is ook opgenomen in de toegankelijke tekst die door schermlezers wordt uitgesproken wanneer de knop de focus krijgt.

De standaard tooltip wordt ingesteld met behulp van het veld "default_title" van de sleutel "action" in manifest.json . U kunt dit ook programmatisch instellen door action.setTitle() aan te roepen.

Kenteken

Acties kunnen optioneel een "badge" weergeven: een stukje tekst over het pictogram heen. Hiermee kunt u de actie bijwerken zodat een kleine hoeveelheid informatie over de status van de extensie wordt weergegeven, zoals een teller. De badge heeft een tekstcomponent en een achtergrondkleur. Omdat de ruimte beperkt is, raden we aan dat badgetekst vier of minder tekens gebruikt.

Als u een badge wilt maken, stelt u deze programmatisch in door action.setBadgeBackgroundColor() en action.setBadgeText() aan te roepen. Er is geen standaardbadge-instelling in het manifest. Badgekleurwaarden kunnen een array van vier gehele getallen tussen 0 en 255 zijn die de RGBA-kleur van de badge vormen, of een tekenreeks met een CSS- kleurwaarde.

chrome.action.setBadgeBackgroundColor(
  {color: [0, 255, 0, 0]},  // Green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: '#00FF00'},  // Also green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: 'green'},  // Also, also green
  () => { /* ... */ },
);

De pop-up van een actie wordt weergegeven wanneer de gebruiker op de actieknop van de extensie in de werkbalk klikt. De pop-up kan elke gewenste HTML-inhoud bevatten en wordt automatisch aangepast aan de inhoud ervan. De grootte van de pop-up moet tussen 25x25 en 800x600 pixels zijn.

De pop-up wordt in eerste instantie ingesteld door de eigenschap "default_popup" in de "action" -sleutel in het bestand manifest.json . Indien aanwezig moet deze eigenschap verwijzen naar een relatief pad binnen de extensiemap. Het kan ook dynamisch worden bijgewerkt om naar een ander relatief pad te verwijzen met behulp van de action.setPopup() -methode.

Gebruiksgevallen

Staat per tabblad

Extensieacties kunnen voor elk tabblad een verschillende status hebben. Als u een waarde voor een afzonderlijk tabblad wilt instellen, gebruikt u de eigenschap tabId in de instellingsmethoden van de action API. Als u bijvoorbeeld de badgetekst voor een specifiek tabblad wilt instellen, doet u het volgende:

function getTabId() { /* ... */}
function getTabBadge() { /* ... */}

chrome.action.setBadgeText(
  {
    text: getTabBadge(tabId),
    tabId: getTabId(),
  },
  () => { ... }
);

Als de eigenschap tabId wordt weggelaten, wordt de instelling behandeld als een globale instelling. Tabspecifieke instellingen hebben voorrang op algemene instellingen.

Ingeschakelde status

Standaard zijn werkbalkacties op elk tabblad ingeschakeld (klikbaar). U kunt deze standaard wijzigen door de eigenschap default_state in de action van het manifest in te stellen. Als default_state is ingesteld op "disabled" , is de actie standaard uitgeschakeld en moet deze programmatisch worden ingeschakeld om klikbaar te zijn. Als default_state is ingesteld op "enabled" (de standaardwaarde), is de actie standaard ingeschakeld en klikbaar.

U kunt de status programmatisch beheren met behulp van de methoden action.enable() en action.disable() . Dit heeft alleen invloed op de vraag of de pop-up (indien aanwezig) of action.onClicked -gebeurtenis naar uw extensie wordt verzonden; het heeft geen invloed op de aanwezigheid van de actie in de werkbalk.

Voorbeelden

In de volgende voorbeelden ziet u enkele veelvoorkomende manieren waarop acties in extensies worden gebruikt. Om deze API te proberen, installeert u het Action API-voorbeeld uit de chrome-extension-samples -repository.

Laat een pop-up zien

Het is gebruikelijk dat een extensie een pop-up weergeeft wanneer de gebruiker op de actie van de extensie klikt. Om dit in uw eigen extensie te implementeren, declareert u de pop-up in uw manifest.json en specificeert u de inhoud die Chrome in de pop-up moet weergeven.

// manifest.json
{
  "name": "Action popup demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to view a popup",
    "default_popup": "popup.html"
  }
}

<!-- popup.html -->
<!DOCTYPE html>
<html>
<head>
  <style>
    html {
      min-height: 5em;
      min-width: 10em;
      background: salmon;
    }
  </style>
</head>
<body>
  <p>Hello, world!</p>
</body>
</html>

Injecteer een inhoudsscript wanneer u klikt

Een gebruikelijk patroon voor extensies is om hun primaire kenmerk bloot te leggen met behulp van de actie van de extensie. Het volgende voorbeeld demonstreert dit patroon. Wanneer de gebruiker op de actie klikt, injecteert de extensie een inhoudsscript in de huidige pagina. Het inhoudsscript geeft vervolgens een waarschuwing weer om te verifiëren dat alles werkte zoals verwacht.

// manifest.json
{
  "name": "Action script injection demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to show an alert"
  },
  "permissions": ["activeTab", "scripting"],
  "background": {
    "service_worker": "background.js"
  }
}

// background.js
chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    files: ['content.js']
  });
});

// content.js
alert('Hello, world!');

Emuleer acties met declarativeContent

Dit voorbeeld laat zien hoe de achtergrondlogica van een extensie (a) een actie standaard kan uitschakelen en (b) declarativeContent kan gebruiken om de actie op specifieke sites in te schakelen. 

// service-worker.js

// Wrap in an onInstalled callback to avoid unnecessary work
// every time the service worker is run
chrome.runtime.onInstalled.addListener(() => {
  // Page actions are disabled by default and enabled on select tabs
  chrome.action.disable();

  // Clear all rules to ensure only our expected rules are set
  chrome.declarativeContent.onPageChanged.removeRules(undefined, () => {
    // Declare a rule to enable the action on example.com pages
    let exampleRule = {
      conditions: [
        new chrome.declarativeContent.PageStateMatcher({
          pageUrl: {hostSuffix: '.example.com'},
        })
      ],
      actions: [new chrome.declarativeContent.ShowAction()],
    };

    // Finally, apply our new array of rules
    let rules = [exampleRule];
    chrome.declarativeContent.onPageChanged.addRules(rules);
  });
});

Soorten

OpenPopupOptions

Chroom 99+

Eigenschappen

  • vensterId

    nummer optioneel

    De ID van het venster waarin de actiepop-up wordt geopend. Standaard ingesteld op het momenteel actieve venster, indien niet gespecificeerd.

TabDetails

Eigenschappen

  • tabId

    nummer optioneel

    De ID van het tabblad waarvoor de status moet worden opgevraagd. Als er geen tabblad is opgegeven, wordt de niet-tabbladspecifieke status geretourneerd.

UserSettings

Chroom 91+

De verzameling door de gebruiker opgegeven instellingen met betrekking tot de actie van een extensie.

Eigenschappen

  • isOnToolbar

    Booleaans

    Of het actiepictogram van de extensie zichtbaar is in de werkbalk op het hoogste niveau van browservensters (dwz of de extensie door de gebruiker is 'vastgezet').

UserSettingsChange

Chroom 130+

Eigenschappen

  • isOnToolbar

    Booleaans optioneel

    Of het actiepictogram van de extensie zichtbaar is in de werkbalk op het hoogste niveau van browservensters (dwz of de extensie door de gebruiker is 'vastgezet').

Methoden

disable()

Belofte
chrome.action.disable(
  tabId?: number,
  callback?: function,
)

Schakelt de actie voor een tabblad uit.

Parameters

  • tabId

    nummer optioneel

    De ID van het tabblad waarvoor u de actie wilt wijzigen.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

enable()

Belofte
chrome.action.enable(
  tabId?: number,
  callback?: function,
)

Schakelt de actie voor een tabblad in. Standaard zijn acties ingeschakeld.

Parameters

  • tabId

    nummer optioneel

    De ID van het tabblad waarvoor u de actie wilt wijzigen.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getBadgeBackgroundColor()

Belofte
chrome.action.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

Krijgt de achtergrondkleur van de actie.

Parameters

Retouren

  • Beloof het < browserAction.ColorArray >

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getBadgeText()

Belofte
chrome.action.getBadgeText(
  details: TabDetails,
  callback?: function,
)

Haalt de badgetekst van de actie op. Als er geen tabblad is opgegeven, wordt de niet-tabspecifieke badgetekst geretourneerd. Als displayActionCountAsBadgeText is ingeschakeld, wordt er een tijdelijke tekst geretourneerd, tenzij de declarativeNetRequestFeedback- machtiging aanwezig is of er tabspecifieke badgetekst is opgegeven.

Parameters

  • details

    TabbladDetails

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: string) => void

    • resultaat

      snaar

Retouren

  • Beloof<tekenreeks>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getBadgeTextColor()

BeloofChrome 110+
chrome.action.getBadgeTextColor(
  details: TabDetails,
  callback?: function,
)

Krijgt de tekstkleur van de actie.

Parameters

Retouren

  • Beloof het < browserAction.ColorArray >

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getPopup()

Belofte
chrome.action.getPopup(
  details: TabDetails,
  callback?: function,
)

Haalt het HTML-document op dat is ingesteld als pop-up voor deze actie.

Parameters

  • details

    TabbladDetails

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: string) => void

    • resultaat

      snaar

Retouren

  • Beloof<tekenreeks>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getTitle()

Belofte
chrome.action.getTitle(
  details: TabDetails,
  callback?: function,
)

Krijgt de titel van de actie.

Parameters

  • details

    TabbladDetails

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: string) => void

    • resultaat

      snaar

Retouren

  • Beloof<tekenreeks>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

getUserSettings()

BeloofChrome 91+
chrome.action.getUserSettings(
  callback?: function,
)

Retourneert de door de gebruiker opgegeven instellingen met betrekking tot de actie van een extensie.

Parameters

Retouren

  • Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

isEnabled()

BeloofChrome 110+
chrome.action.isEnabled(
  tabId?: number,
  callback?: function,
)

Geeft aan of de extensieactie is ingeschakeld voor een tabblad (of globaal als er geen tabId is opgegeven). Acties die alleen zijn ingeschakeld met declarativeContent retourneren altijd false.

Parameters

  • tabId

    nummer optioneel

    De ID van het tabblad waarvan u de ingeschakelde status wilt controleren.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (isEnabled: boolean) => void

    • is ingeschakeld

      Booleaans

      Waar als de extensieactie is ingeschakeld.

Retouren

  • Beloof<boolean>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

openPopup()

BeloofChrome 127+
chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

Opent de pop-up van de extensie. Tussen Chrome 118 en Chrome 126 is dit alleen beschikbaar voor door het beleid geïnstalleerde extensies.

Parameters

  • opties

    OpenPopupOptions optioneel

    Specificeert opties voor het openen van de pop-up.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setBadgeBackgroundColor()

Belofte
chrome.action.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

Stelt de achtergrondkleur voor de badge in.

Parameters

  • details

    voorwerp

    • kleur

      tekenreeks | KleurArray

      Een array van vier gehele getallen in het bereik [0,255] waaruit de RGBA-kleur van de badge bestaat. Ondoorzichtig rood is bijvoorbeeld [255, 0, 0, 255] . Kan ook een string zijn met een CSS-waarde, waarbij ondoorzichtig rood #FF0000 of #F00 is.

    • tabId

      nummer optioneel

      Beperkt de wijziging tot wanneer een bepaald tabblad is geselecteerd. Wordt automatisch gereset wanneer het tabblad wordt gesloten.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setBadgeText()

Belofte
chrome.action.setBadgeText(
  details: object,
  callback?: function,
)

Stelt de badgetekst voor de actie in. De badge wordt bovenaan het pictogram weergegeven.

Parameters

  • details

    voorwerp

    • tabId

      nummer optioneel

      Beperkt de wijziging tot wanneer een bepaald tabblad is geselecteerd. Wordt automatisch gereset wanneer het tabblad wordt gesloten.

    • tekst

      tekenreeks optioneel

      Er kan een willekeurig aantal tekens worden doorgegeven, maar er passen er slechts ongeveer vier in de ruimte. Als een lege string ( '' ) wordt doorgegeven, wordt de badgetekst gewist. Als tabId is opgegeven en text null is, wordt de tekst voor het opgegeven tabblad gewist en wordt standaard de algemene badgetekst gebruikt.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setBadgeTextColor()

BeloofChrome 110+
chrome.action.setBadgeTextColor(
  details: object,
  callback?: function,
)

Stelt de tekstkleur voor de badge in.

Parameters

  • details

    voorwerp

    • kleur

      tekenreeks | KleurArray

      Een array van vier gehele getallen in het bereik [0,255] waaruit de RGBA-kleur van de badge bestaat. Ondoorzichtig rood is bijvoorbeeld [255, 0, 0, 255] . Kan ook een string zijn met een CSS-waarde, waarbij ondoorzichtig rood #FF0000 of #F00 is. Als u deze waarde niet instelt, wordt er automatisch een kleur gekozen die contrasteert met de achtergrondkleur van de badge, zodat de tekst zichtbaar is. Kleuren met alfawaarden gelijk aan 0 worden niet ingesteld en geven een foutmelding.

    • tabId

      nummer optioneel

      Beperkt de wijziging tot wanneer een bepaald tabblad is geselecteerd. Wordt automatisch gereset wanneer het tabblad wordt gesloten.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setIcon()

Belofte
chrome.action.setIcon(
  details: object,
  callback?: function,
)

Stelt het pictogram voor de actie in. Het pictogram kan worden opgegeven als het pad naar een afbeeldingsbestand of als de pixelgegevens van een canvaselement, of als woordenboek van een van beide. Het pad of de eigenschap imageData moet worden opgegeven.

Parameters

  • details

    voorwerp

    • afbeeldingGegevens

      Beeldgegevens | object optioneel

      Een ImageData-object of een woordenboek {size -> ImageData} dat het in te stellen pictogram vertegenwoordigt. Als het pictogram als woordenboek is opgegeven, wordt de werkelijk te gebruiken afbeelding gekozen afhankelijk van de pixeldichtheid van het scherm. Als het aantal afbeeldingspixels dat in één schermruimte-eenheid past gelijk is aan scale , dan wordt afbeelding met scale * n geselecteerd, waarbij n de grootte is van het pictogram in de gebruikersinterface. Er moet ten minste één afbeelding worden opgegeven. Houd er rekening mee dat 'details.imageData = foo' gelijk is aan 'details.imageData = {'16': foo}'

    • pad

      tekenreeks | object optioneel

      Ofwel een relatief afbeeldingspad, ofwel een woordenboek {grootte -> relatief afbeeldingspad} dat verwijst naar het in te stellen pictogram. Als het pictogram als woordenboek is opgegeven, wordt de werkelijk te gebruiken afbeelding gekozen afhankelijk van de pixeldichtheid van het scherm. Als het aantal afbeeldingspixels dat in één schermruimte-eenheid past gelijk is aan scale , dan wordt afbeelding met scale * n geselecteerd, waarbij n de grootte is van het pictogram in de gebruikersinterface. Er moet ten minste één afbeelding worden opgegeven. Houd er rekening mee dat 'details.path = foo' gelijk is aan 'details.path = {'16': foo}'

    • tabId

      nummer optioneel

      Beperkt de wijziging tot wanneer een bepaald tabblad is geselecteerd. Wordt automatisch gereset wanneer het tabblad wordt gesloten.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Chroom 96+

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setPopup()

Belofte
chrome.action.setPopup(
  details: object,
  callback?: function,
)

Stelt in dat het HTML-document wordt geopend als een pop-up wanneer de gebruiker op het actiepictogram klikt.

Parameters

  • details

    voorwerp

    • pop-up

      snaar

      Het relatieve pad naar het HTML-bestand dat in een pop-up moet worden weergegeven. Indien ingesteld op de lege tekenreeks ( '' ), wordt er geen pop-up weergegeven.

    • tabId

      nummer optioneel

      Beperkt de wijziging tot wanneer een bepaald tabblad is geselecteerd. Wordt automatisch gereset wanneer het tabblad wordt gesloten.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

setTitle()

Belofte
chrome.action.setTitle(
  details: object,
  callback?: function,
)

Stelt de titel van de actie in. Dit wordt weergegeven in de tooltip.

Parameters

  • details

    voorwerp

    • tabId

      nummer optioneel

      Beperkt de wijziging tot wanneer een bepaald tabblad is geselecteerd. Wordt automatisch gereset wanneer het tabblad wordt gesloten.

    • titel

      snaar

      De tekenreeks die de actie moet weergeven als er met de muis overheen wordt bewogen.

  • terugbellen

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retouren

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onClicked

chrome.action.onClicked.addListener(
  callback: function,
)

Wordt geactiveerd wanneer op een actiepictogram wordt geklikt. Deze gebeurtenis wordt niet geactiveerd als de actie een pop-up heeft.

Parameters

  • terugbellen

    functie

    De callback parameter ziet er als volgt uit: 

    (tab: tabs.Tab) => void

onUserSettingsChanged

Chroom 130+
chrome.action.onUserSettingsChanged.addListener(
  callback: function,
)

Wordt geactiveerd wanneer door de gebruiker opgegeven instellingen met betrekking tot de actie van een extensie veranderen.

Parameters