Ir para o conteúdo principal

Class: MenuItem

Class: MenuItem​

Adicione itens para menus e menus de contexto para aplicações nativas.

Processo: Main

Veja Menu para exemplos.

new MenuItem(options)​

  • options Object
    • click Function (optional) - Will be called with click(menuItem, window, event) when the menu item is clicked.
      • menuItem MenuItem
      • window BaseWindow | undefined - This will not be defined if no window is open.
      • event KeyboardEvent
    • role string (optional) - Can be 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, showSubstitutions, toggleSmartQuotes, toggleSmartDashes, toggleTextReplacement, startSpeaking, stopSpeaking, zoom, front, appMenu, fileMenu, editMenu, viewMenu, shareMenu, recentDocuments, toggleTabBar, selectNextTab, selectPreviousTab, showAllTabs, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow or windowMenu - Define the action of the menu item, when specified the click property will be ignored. See roles.
    • type string (opcional) - Pode ser normal, separator, submenu, checkbox ou radio.
    • label string (opcional)
    • sublabel string (opcional)
    • toolTip string (optional) macOS - Hover text for this menu item.
    • accelerator Accelerator (opcional) - Atalho
    • icon (NativeImage | string) (optional)
    • enabled boolean (optional) - Se falso, o item do menu vai ser não-clicável e cinza.
    • acceleratorWorksWhenHidden boolean (optional) macOS - default is true, and when false will prevent the accelerator from triggering the item if the item is not visible.
    • visible boolean (opcional) - Se falso, o item do menu será inteiramente escondido.
    • checked boolean (opcinal) - Deve ser especificado apenas para checkbox ou radio tipos de item de menu.
    • registerAccelerator boolean (optional) Linux Windows - If false, the accelerator won't be registered with the system, but it will still be displayed. Defaults to true.
    • sharingItem SharingItem (optional) macOS - The item to share when the role is shareMenu.
    • submenu (MenuItemConstructorOptions[] | Menu) (optional) - Should be specified for submenu type menu items. If submenu is specified, the type: 'submenu' can be omitted. If the value is not a Menu then it will be automatically converted to one using Menu.buildFromTemplate.
    • id string (optional) - Unique within a single menu. If defined then it can be used as a reference to this item by the position attribute.
    • before string[] (optional) - Inserts this item before the item with the specified id. If the referenced item doesn't exist the item will be inserted at the end of the menu. Also implies that the menu item in question should be placed in the same “group” as the item.
    • after string[] (optional) - Inserts this item after the item with the specified id. If the referenced item doesn't exist the item will be inserted at the end of the 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. The option is exposed to users to give them the option to turn it off, as this is possible in native macOS development.

Roles​

Roles permitem itens de menu items terem funcionamentos pré-definidos.

É melhor especificar role para qualquer item de menu que utiliza uma role padrão, ao invés de tentar implementar manualmente um funcionamento em uma função de click. O funcionamento built-in role dará a melhor experiência nativa.

O valor de label e de acceleratorsão opcionais quando utilizando uma role e lhes serão dados valores padrão apropriados para cada plataforma.

Every menu item must have either a role, label, or in the case of a separator a type.

A propriedade role pode ter os seguintes valores:

  • undo
  • about - Trigger a native about panel (custom message box on Window, which does not provide its own).
  • redo
  • cut
  • copy
  • paste
  • pasteAndMatchStyle
  • selectAll
  • delete
  • minimize - Minimiza a janela atual.
  • close - Fecha a janela atual.
  • quit - Quit the application.
  • reload - Recarrega a janela atual.
  • forceReload - Recarrega a janela atual, ignorando o cache.
  • toggleDevTools - Alterna ferramentas de desenvolvedor na janela atual.
  • togglefullscreen - Toggle full screen mode on the current window.
  • resetZoom - Reseta o zoom da pagina focada para seu valor original.
  • zoomIn - O zoom na pagina focada é aumentado em 10%.
  • zoomOut - O zoom na pagina focada é diminuido em 10%.
  • toggleSpellChecker - Enable/disable builtin spell checker.
  • fileMenu - Whole default "File" menu (Close / Quit)
  • editMenu - Menu "Edit" padrão inteiro (Desfazer, Copiar, etc.).
  • viewMenu - Whole default "View" menu (Reload, Toggle Developer Tools, etc.)
  • windowMenu - Whole default "Window" menu (Minimize, Zoom, etc.).

The following additional roles are available on macOS:

  • appMenu - Whole default "App" menu (About, Services, etc.)
  • hide - Mapeia para a ação hide.
  • hideOthers - Mapeia para a ação hideOtherApplications.
  • hideothers - Mapeia para a ação unhideAllApplications.
  • showSubstitutions - Mapeia para a ação orderFrontSubstitutionsPanel.
  • toggleSmartQuotes - Mapeia para a ação toggleAutomaticQuoteSubstitution.
  • toggleSmartDashes - Mapeia para a ação toggleAutomaticDashSubstitution.
  • toggleTextReplacement - Mapeia para a ação toggleAutomaticTextReplacement.
  • startSpeaking - Mapeia para a ação startSpeaking.
  • stopSpeaking - Mapeia para a ação stopSpeaking.
  • hide - Mapeia para a ação arrangeInFront.
  • zoom - Mapeia para a ação performZoom.
  • toggleTabBar - Mapeia para a ação toggleTabBar.
  • selectNextTab - Mapeia para a ação selectNextTab.
  • selectPreviousTab - Mapeia para a ação selectPreviousTab.
  • showAllTabs - Map to the showAllTabs action.
  • mergeAllWindows - Map to the mergeAllWindows action.
  • moveTabToNewWindow - Map to the moveTabToNewWindow action.
  • window - The submenu is a "Window" menu.
  • help - The submenu is a "Help" menu.
  • services - The submenu is a "Services" menu. This is only intended for use in the Application Menu and is not the same as the "Services" submenu used in context menus in macOS apps, which is not implemented in Electron.
  • recentDocuments - The submenu is an "Open Recent" menu.
  • clearRecentDocuments - Map to the clearRecentDocuments action.
  • shareMenu - The submenu is share menu. The sharingItem property must also be set to indicate the item to share.

When specifying a role on macOS, label and accelerator are the only options that will affect the menu item. All other options will be ignored. Lowercase role, e.g. toggledevtools, is still supported.

Note: The enabled and visibility properties are not available for top-level menu items in the tray on macOS.

Propriedades da Instância​

As seguintes propriedades estão disponíveis em instâncias de MenuItem:

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

A string indicating the item's visible label.

Uma Function que é ativada quando um item de menu recebe um evento de clique. It can be called with menuItem.click(event, focusedWindow, focusedWebContents).

A Menu (optional) containing the menu item's submenu, if present.

A string indicating the type of the item. Can be normal, separator, submenu, checkbox or radio.

A string (optional) indicating the item's role, if set. Can be 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, showAllTabs, mergeAllWindows, clearRecentDocuments, moveTabToNewWindow or windowMenu

An Accelerator (optional) indicating the item's accelerator, if set.

An Accelerator | null indicating the item's user-assigned accelerator for the menu item.

Note: This property is only initialized after the MenuItem has been added to a Menu. Either via Menu.buildFromTemplate or via Menu.append()/insert(). Accessing before initialization will just return null.

A NativeImage | string (optional) indicating the item's icon, if set.

A string indicating the item's sublabel.

A string indicating the item's hover text.

Um boolean indicando se o item está ativo, essa propriedade pode ser alterada dinamicamente.

Um boolean indicando se o item está visível, essa propriedade pode ser alterada dinamicamente.

Um boolean indicando se o item está ativo ou não, essa propriedade pode ser alterada dinamicamente.

Um item do menu de um checkbox irá mudar a propriedade checked para ativa ou não quando selecionada.

Um item do menu de um radio irá ativar a sua propriedade checked quando clicado, e irá desativar essa propriedade para todos os itens adjacentes no mesmo menu.

Você pode adicionar uma função click para comportamentos adicionais.

A boolean indicating if the accelerator should be registered with the system or just displayed.

This property can be dynamically changed.

A SharingItem indicating the item to share when the role is shareMenu.

This property can be dynamically changed.

A number indicating an item's sequential unique id.

A Menu that the item is a part of.