Aller au contenu principal

MenuItem

Classe : MenuItem​

Ajoute des éléments aux menus et menus contextuels natifs de l’application.

Process: Main

Voir Menu pour des exemples.

[!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.

new MenuItem(options)​

  • Objet options
    • Function (facultatif) click - Sera appelée par click(menuItem, window, event) lorsque l'élément de menu est cliqué.
      • menuItem MenuItem
      • window BrowserWindow | undefined - Cela ne sera pas défini si aucune fenêtre n'est ouverte.
      • event KeyboardEvent
    • role String (facultatif) - Peut prendre une des valeurs suivantes: undo, redo, cut, copy, paste, pasteAndMatchStyle, delete, selectAll, reload, forceReload, toggleDevTools, resetZoom, zoomIn, zoomOut, toggleSpellChecker, togglefullscreen, window, minimize, close, help, about, services, hide, hideOthers, unhide, quit, startSpeaking, stopSpeaking, zoom, front, appMenu, fileMenu, editMenu, viewMenu, shareMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow ou windowMenu - Définit l'action de l'élément de menu, la propriété click sera ignorée lorsque un rôle est spécifié. See roles.
    • type string (facultatif)
      • normal
      • separator
      • submenu
      • checkbox
      • radio
      • header - Only available on macOS 14 and up.
      • palette - Only available on macOS 14 and up.
    • label string (facultatif)
    • sublabel string (facultatif) macOS - Disponible sous macOS >= 14.4
    • toolTip string (facultatif) macOS - Texte s'affichant au survol de cet item de menu.
    • accelerator string (optional) - An Accelerator string.
    • icon (NativeImage | string) (facultatif)
    • enabled boolean (facultatif) - Si définit à false, l'élément de menu sera grisé et non cliquable.
    • acceleratorWorksWhenHidden booléen (facultatif) macOS - la valeur par défaut est true, et la valeur false empêche l’accélérateur de déclencher l’élément si celui-ci n’est pas visible.
    • visible boolean (facultatif) - Si false, l'élément de menu sera entièrement masqué.
    • checked boolean (facultatif) - Ne doit être spécifié que pour les éléments de menu de type checkbox ou radio .
    • registerAccelerator boolean (facultatif) Linux Windows - Si false, l'accélérateur ne sera pas enregistré par le système, mais il sera toujours affiché. La valeur par défaut est true.
    • sharingItem SharingItem (facultatif) macOS - L'élément à partager lorsque le role est à shareMenu.
    • sous-menu (MenuItemConstructorOptions[] | Menu) (facultatif) - Doit être spécifié pour sous-menu type éléments de menu. Si sous-menu est spécifié, le type: 'submenu' peut être omis. Si la valeur n'est pas un Menu alors elle sera automatiquement convertie en un en utilisant Menu.buildFromTemplate.
    • id string (facultatif) - Unique dans chaque menu. Si il est défini, il pourra être utilisé comme référence pour cet élément à l'ai de de l'attribut position.
    • before string[] (optional) - Inserts this item before the item with the specified id. Si l'élément référencé n'existe pas, l'élément sera inséré à la fin du menu. Implique également que l'élément de menu en question doit être placé dans le même « groupe ».
    • after string[] (optional) - Inserts this item after the item with the specified id. Si l'élément référencé n'existe pas, l'élément sera inséré à la fin du menu.
    • beforeGroupContaining string[] (optional) - Provides a means for a single context menu to declare the placement of their containing group before the containing group of the item with the specified id.
    • afterGroupContaining string[] (optional) - Provides a means for a single context menu to declare the placement of their containing group after the containing group of the item with the specified id.
note

acceleratorWorksWhenHidden is specified as being macOS-only because accelerators always work when items are hidden on Windows and Linux. L'option est exposée aux utilisateurs pour leur donner la possibilité de la désactiver, car cela est possible dans le développement natif de macOS.

Propriétés d'instance​

Les propriétés suivantes sont disponibles pour les instances de MenuItem :

A string indicating the item's unique id. This property can be dynamically changed.

string indique le label visible de l'item.

Function qui est activée lorsque l'élément MenuItem reçoit un événement de click. Elle peut être appelée par menuItem.click(event, focusedWindow, focusedWebContents).

Un Menu (facultatif) contenant le sous-menu de l'élément de menu s'il est présent.

string indique le type de l'item. Can be normal, separator, submenu, checkbox, radio, header or palette.

note

header and palette are only available on macOS 14 and up.

string (facultatif) indiquant, si défini, le rôle de l'item. Peut prendre une des valeurs suivantes: undo, redo, cut, copy, paste, pasteAndMatchStyle, delete, selectAll, reload, forceReload, toggleDevTools, resetZoom, zoomIn, zoomOut, toggleSpellChecker, togglefullscreen, window, minimize, close, help, about, services, hide, hideOthers, unhide, quit, startSpeaking, stopSpeaking, zoom, front, appMenu, fileMenu, editMenu, viewMenu, shareMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow ou windowMenu

Un Accelerator (facultatif) qui indique , si défini, l'accélérateur de l'item.

Accelerator | null indiquant l'accélérateur assigné par l'utilisateur de l'élément du menu.

[!NOTE] This property is only initialized after the MenuItem has been added to a Menu. Et ceci via Menu.buildFromTemplate ou Menu.append()/insert(). L'accès avant l'initialisation ne fera que renvoyer null.

Un NativeImage | string (facultatif) indiquant si défini l'icône de l'élément .

Un string indiquant le sulabel de l'item.

Une string indique le texte au survol de l'élément.

A boolean indicating whether the item is enabled. This property can be dynamically changed.

A boolean indicating whether the item is visible. This property can be dynamically changed.

A boolean indicating whether the item is checked. This property can be dynamically changed.

Une case à cocher lien de menu activera et éteindra la propriété cochée lorsque sera sélectionné.

Un lien de menu radio activera sa propriété cochée une fois cliqué, et désactivera cette propriété pour tous les éléments adjacents du même menu.

Vous pouvez ajouter une fonction clic pour un comportement supplémentaire.

Booléen indiquant si l'accélérateur doit être enregistré dans le système ou uniquement affiché.

Cette propriété peut être modifiée dynamiquement.

SharingItem indiquant l'élément à partager lorsque le role est shareMenu.

Cette propriété peut être modifiée dynamiquement.

number indiquant l'identifiant séquentiel unique d'un élément.

Un Menu dont l'item fait partie.