Safari Developer Library

Developer

SafariExtensionContextMenuEvent Class Reference

Options
Deployment Target:

On This Page

SafariExtensionContextMenuEvent

Inheritance


Conforms To


Not Applicable

Import Statement


Not Applicable Not Applicable

Availability


Available in Safari 5.0 and later.

Instances of the SafariExtensionContextMenuEvent class are used to notify listeners when a context menu is about to be displayed.

Each time a contextual menu is about to be displayed, Safari creates a new menu, populated with the default menu items from your extension’s Info.plist file. Next, a SafariExtensionContextMenuEvent event is sent, and its listeners add menu items to the menu. Then a SafariExtensionContextMenuItemValidateEvent event is sent for each menu item, and its listeners have the opportunity to prevent items in the context menu from being displayed by marking them as disabled.

The event type for this class is contextmenu.

  • userInfo Property

    Information about the current context menu event.

    Declaration

    JavaScript

    readonly attribute any userInfo

    Discussion

    From within the web content area, you listen for a DOM context menu event, and then call the setContextMenuEventUserInfo method. The value you provide is used as the userInfo property by the SafariExtensionContextMenuEvent and SafariExtensionContextMenuItemValidateEvent events when they are sent.

    Availability

    Available in Safari 5.0 and later.

  • contextMenu Property

    The context menu being built up.

    Declaration

    JavaScript

    readonly attribute SafariExtensionContextMenu contextMenu

    Availability

    Available in Safari 5.0 and later.