chrome.contextMenus (original) (raw)

Zum Hauptinhalt springen

• Docs

  • Übersicht
  • Jetzt starten
  • Entwickeln
  • Anleitungen
  • KI
  • Referenzen
  • Beispiele
  • Chrome Web Store

• Fallstudien

• Blog

• Neu in Chrome

• Manifest V3

• ➡ Manifest V2

• accessibilityFeatures

• action

• alarms

• audio

• bookmarks

• browsingData

• certificateProvider

• commands

• contentSettings

• contextMenus

• cookies

• debugger

• declarativeContent

• declarativeNetRequest

• desktopCapture

• devtools.inspectedWindow

• devtools.network

• devtools.panels

• devtools.performance

• devtools.recorder

• dns

• documentScan

• dom

• downloads

• enterprise.deviceAttributes

• enterprise.hardwarePlatform

• enterprise.login

• enterprise.networkingAttributes

• enterprise.platformKeys

• events

• extension

• extensionTypes

• fileBrowserHandler

• fileSystemProvider

• fontSettings

• gcm

• history

• i18n

• identity

• idle

• input.ime

• instanceID

• loginState

• management

• notifications

• offscreen

• omnibox

• pageCapture

• permissions

• platformKeys

• power

• printerProvider

• printing

• printingMetrics

• privacy

• processes

• proxy

• readingList

• runtime

• scripting

• search

• sessions

• sidePanel

• storage

• system.cpu

• system.display

• system.memory

• system.storage

• systemLog

• tabCapture

• tabGroups

• tabs

• topSites

• tts

• ttsEngine

• types

• userScripts

• vpnProvider

• wallpaper

• webAuthenticationProxy

• webNavigation

• webRequest

• windows

chrome.contextMenus

Beschreibung

Mit der chrome.contextMenus API können Sie Elemente zum Kontextmenü von Google Chrome hinzufügen. Sie können auswählen, auf welche Arten von Objekten sich Ihre Kontextmenü-Ergänzungen beziehen, z. B. Bilder, Hyperlinks und Seiten.

Berechtigungen

contextMenus

Sie müssen die Berechtigung "contextMenus" im Manifest Ihrer Erweiterung deklarieren, um die API verwenden zu können. Außerdem sollten Sie ein 16 × 16 Pixel großes Symbol angeben, das neben Ihrem Menüelement angezeigt werden soll. Beispiel:

{
  "name": "My extension",
  ...
  "permissions": [
    "contextMenus"
  ],
  "icons": {
    "16": "icon-bitty.png",
    "48": "icon-small.png",
    "128": "icon-large.png"
  },
  ...
}

Konzepte und Verwendung

Kontextmenüelemente können in jedem Dokument (oder Frame in einem Dokument) angezeigt werden, auch in Dokumenten mit file://- oder chrome://-URLs. Wenn Sie festlegen möchten, in welchen Dokumenten Ihre Elemente angezeigt werden können, geben Sie das Feld documentUrlPatterns an, wenn Sie die Methoden create() oder update() aufrufen.

Sie können beliebig viele Kontextmenüelemente erstellen. Wenn jedoch mehr als eines Ihrer Erweiterung gleichzeitig sichtbar ist, werden sie in Google Chrome automatisch in einem einzelnen übergeordneten Menü zusammengefasst.

Beispiele

Wenn Sie diese API ausprobieren möchten, installieren Sie das API-Beispiel für contextMenus aus dem Repository chrome-extension-samples.

Typen

ContextType

Die verschiedenen Kontexte, in denen ein Menü angezeigt werden kann. Die Angabe von „all“ entspricht der Kombination aller anderen Kontexte mit Ausnahme von „launcher“. Der Kontext „Launcher“ wird nur von Apps unterstützt und dient dazu, dem Kontextmenü, das beim Klicken auf das App-Symbol im Launcher, in der Taskleiste, im Dock usw. angezeigt wird, Menüpunkte hinzuzufügen. Auf verschiedenen Plattformen gelten möglicherweise Einschränkungen für die Unterstützung in einem Launcher-Kontextmenü.

Enum

"all"

"page"

"frame"

„selection“

„link“

"editable"

"image"

"video"

"audio"

"launcher"

"browser_action"

"page_action"

"action"

CreateProperties

Eigenschaften des neuen Kontextmenüelements.

Attribute

• ausgewählt
  boolean optional
  Der Anfangsstatus eines Kästchens oder Optionsfelds: true für ausgewählt, false für nicht ausgewählt. Es kann jeweils nur ein Optionsfeld einer Gruppe ausgewählt werden.
• contexts
  [ContextType, ...ContextType[]] optional
  Liste der Kontexte, in denen dieses Menüelement angezeigt wird. Die Standardeinstellung ist ['page'].
• documentUrlPatterns
  string[] optional
  Beschränkt das Element so, dass es nur auf Dokumente oder Frames angewendet wird, deren URL einem der angegebenen Muster entspricht. Weitere Informationen zu Musterformaten finden Sie unter Übereinstimmungsmuster.
• aktiviert
  boolean optional
  Gibt an, ob dieses Kontextmenüelement aktiviert oder deaktiviert ist. Die Standardeinstellung ist true.
• Die eindeutige ID, die diesem Artikel zugewiesen werden soll. Für Veranstaltungsseiten erforderlich. Darf nicht mit einer anderen ID für diese Erweiterung übereinstimmen.
• parentId
  String | Zahl optional
  Die ID eines übergeordneten Menüpunkts. Dadurch wird das Element zu einem untergeordneten Element eines zuvor hinzugefügten Elements.
• targetUrlPatterns
  string[] optional
  Ähnlich wie bei documentUrlPatterns werden Filter basierend auf dem src-Attribut der Tags img, audio und video sowie dem href-Attribut der a-Tags angewendet.
• Der im Element anzuzeigende Text. Dieser ist erforderlich, sofern type nicht separator ist. Wenn der Kontext selection ist, verwenden Sie %s im String, um den ausgewählten Text anzuzeigen. Wenn der Wert dieses Parameters beispielsweise „Übersetze ‚%s‘ ins Lateinische“ lautet und der Nutzer das Wort „cool“ auswählt, lautet der Kontextmenüpunkt für die Auswahl „Übersetze ‚cool‘ ins Lateinische“.
• Der Typ des Menüpunkts. Die Standardeinstellung ist normal.
• sichtbar
  boolean optional
  Gibt an, ob das Element im Menü sichtbar ist.
• Eine Funktion, die aufgerufen wird, wenn auf das Menüelement geklickt wird. Diese Funktion ist in einem Service Worker nicht verfügbar. Stattdessen sollten Sie einen Listener für contextMenus.onClicked registrieren.
  Die onclick-Funktion sieht so aus:
  (info: OnClickData, tab: Tab) => {...}
  • Informationen zum angeklickten Element und zum Kontext, in dem der Klick erfolgt ist.
  • Details zum Tab, auf den geklickt wurde. Dieser Parameter ist für Plattform-Apps nicht vorhanden.

ItemType

Der Typ des Menüpunkts.

Enum

"normal"

"checkbox"

"radio"

"separator"

OnClickData

Informationen, die gesendet werden, wenn auf ein Kontextmenüelement geklickt wird.

Attribute

• ausgewählt
  boolean optional
  Ein Flag, das den Status eines Kontrollkästchens oder Optionsfelds nach dem Klicken angibt.
• Ein Flag, das angibt, ob das Element bearbeitet werden kann (Texteingabe, Textbereich usw.).
• Die ID des Frames des Elements, auf das geklickt wurde, um das Kontextmenü aufzurufen, sofern es sich in einem Frame befand.
• Die URL des Frames des Elements, auf das geklickt wurde, um das Kontextmenü aufzurufen, sofern es sich in einem Frame befand.
• Wenn das Element ein Link ist, die URL, auf die es verweist.
• mediaType
  String optional
  Einer der Werte „image“, „video“ oder „audio“, wenn das Kontextmenü für eines dieser Elemente aktiviert wurde.
• Die ID des angeklickten Menüpunkts.
• Die URL der Seite, auf der auf den Menüpunkt geklickt wurde. Diese Property wird nicht festgelegt, wenn der Klick in einem Kontext erfolgt ist, in dem es keine aktuelle Seite gibt, z. B. in einem Kontextmenü des Launchers.
• Die übergeordnete ID des angeklickten Elements, sofern vorhanden.
• selectionText
  String optional
  Der Text für die Kontextauswahl, falls vorhanden.
• Wird für Elemente mit einer „src“-URL angezeigt.
• wasChecked
  boolean optional
  Ein Flag, das den Status eines Kästchens oder Optionsfelds angibt, bevor darauf geklickt wurde.

Attribute

Die maximale Anzahl von Erweiterungselementen der obersten Ebene, die dem Kontextmenü einer Erweiterungsaktion hinzugefügt werden können. Alle Elemente darüber hinaus werden ignoriert.

Methoden

create()

chrome.contextMenus.create(
  createProperties: CreateProperties,
  callback?: function,
): number | string

Erstellt ein neues Kontextmenüelement. Wenn während der Erstellung ein Fehler auftritt, wird er möglicherweise erst erkannt, wenn der Erstellungs-Callback ausgelöst wird. Details finden Sie unter runtime.lastError.

Parameter

• callback
  Funktion optional
  Der Parameter callback sieht so aus:
  () => void

Ausgabe

• Die ID des neu erstellten Elements.

remove()

chrome.contextMenus.remove(
  menuItemId: string | number,
): Promise

Entfernt ein Kontextmenüelement.

Parameter

• Die ID des zu entfernenden Kontextmenüelements.

Ausgabe

removeAll()

chrome.contextMenus.removeAll(): Promise

Entfernt alle Kontextmenüelemente, die von dieser Erweiterung hinzugefügt wurden.

Ausgabe

update()

chrome.contextMenus.update(
  id: string | number,
  updateProperties: object,
): Promise

Aktualisiert ein zuvor erstelltes Kontextmenüelement.

Parameter

• Die ID des zu aktualisierenden Artikels.
• Die zu aktualisierenden Attribute. Akzeptiert dieselben Werte wie die Funktion contextMenus.create.
  • ausgewählt
    boolean optional
  • contexts
    [ContextType, ...ContextType[]] optional
  • documentUrlPatterns
    string[] optional
  • aktiviert
    boolean optional
  • parentId
    String | Zahl optional
    Die ID des Elements, das als übergeordnetes Element für dieses Element festgelegt werden soll. Hinweis: Ein Element kann nicht zum untergeordneten Element eines seiner eigenen untergeordneten Elemente werden.
  • targetUrlPatterns
    string[] optional
  • sichtbar
    boolean optional
    Gibt an, ob das Element im Menü sichtbar ist.
  • Die onclick-Funktion sieht so aus:
    (info: OnClickData, tab: Tab) => {...}
    * Details zum Tab, auf den geklickt wurde. Dieser Parameter ist für Plattform-Apps nicht vorhanden.

Ausgabe

Ereignisse

onClicked

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

Wird ausgelöst, wenn auf ein Kontextmenüelement geklickt wird.

Parameter

• Der Parameter callback sieht so aus:
  (info: OnClickData, tab?: tabs.Tab) => void

Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.

Zuletzt aktualisiert: 2025-09-15 (UTC).