Black Lives Matter. Support the Equal Justice Initiative and read our statement here.

Electron Documentation

ShareMenu

The ShareMenu class creates Share Menu on macOS, which can be used to share information from the current context to apps, social media accounts, and other services.

For including the share menu as a submenu of other menus, please use the shareMenu role of MenuItem.

Class: ShareMenu

Create share menu on macOS.

Process: Main

new ShareMenu(sharingItem)

  • sharingItem SharingItem - The item to share.

Creates a new share menu.

Instance Methods

The shareMenu object has the following instance methods:

shareMenu.popup([options])

  • options PopupOptions (optional)
    • browserWindow BrowserWindow (optional) - Default is the focused window.
    • x Number (optional) - Default is the current mouse cursor position. Must be declared if y is declared.
    • y Number (optional) - Default is the current mouse cursor position. Must be declared if x is declared.
    • positioningItem Number (optional) macOS - The index of the menu item to be positioned under the mouse cursor at the specified coordinates. Default is -1.
    • callback Function (optional) - Called when menu is closed.

Pops up this menu as a context menu in the BrowserWindow.

shareMenu.closePopup([browserWindow])

  • browserWindow BrowserWindow (optional) - Default is the focused window.

Closes the context menu in the browserWindow.

Keyboard Shortcuts

Key Action
/ Focus the search bar
Esc Focus the search bar and cleans it
Select the next search result
Select the previous search result
Enter Open the selected search result
cmdEnter Ctrl+Enter Open the selected search result in a new tab