Custom menus for Editor add-ons

AI-generated Key Takeaways

• Published Editor Add-ons can create custom menu items under the Extensions menu using Ui.createAddonMenu() and Menu.addItem(), typically within the add-on's onOpen(e) method.

• While unpublished add-ons can create top-level menus, it's recommended to use Ui.createAddonMenu() for published add-ons to ensure consistent user experience.

• Add-ons must create an initial menu before user authorization and adjust menu items dynamically based on the authorization mode (ScriptApp.AuthMode) to avoid errors.

• The provided example demonstrates building a dynamic add-on menu that adapts to different authorization modes, using ScriptApp.AuthMode.NONE to control actions requiring authorization.

Published Editor add-ons can create custom menu items under their editor's Extensions menu. You can insert an add-on menu by using the Ui.createAddonMenu() method and add items to it using the Menu.addItem() method. Menus are usually created in the add-on's onOpen(e) method.

Caution: Unpublished add-ons can also create custom top-level menus, but these are automatically moved under the add-ons menu if the add-on is published and may not result in the user experience you intended. If you intend to publish the add-on, always use Ui.createAddonMenu() to define the add-on menu.

You can create dynamic menus that change based on user interactions or add-on state. However, add-ons must create an initial menu before the add-on is authorized by the user. Because of this, you must check the add-on's authorization mode prior to constructing menus in onOpen(e). Do not attempt to take any action that requires authorization (such as checking the script Properties) while the add-on is in ScriptApp.AuthMode.NONE. See the authorization lifecycle for more details on the authorization modes and lifecycle.

Warning: If you attempt to take actions that require authorization when the authorization mode is ScriptApp.AuthMode.NONE, it results in an error. This may prevent your add-on menus from being displayed.

The following example shows how to build a dynamic add-on menu for different authorization modes:

function onOpen(e) {
  var menu = SpreadsheetApp.getUi().createAddonMenu(); // Or DocumentApp or SlidesApp or FormApp.
  if (e && e.authMode == ScriptApp.AuthMode.NONE) {
    // Add a normal menu item (works in all authorization modes).
    menu.addItem('Start workflow', 'startWorkflow');
  } else {
    // Add a menu item based on properties (doesn't work in AuthMode.NONE).
    var properties = PropertiesService.getDocumentProperties();
    var workflowStarted = properties.getProperty('workflowStarted');
    if (workflowStarted) {
      menu.addItem('Check workflow status', 'checkWorkflow');
    } else {
      menu.addItem('Start workflow', 'startWorkflow');
    }
    // Record analytics.
    UrlFetchApp.fetch('http://www.example.com/analytics?event=open');
  }
  menu.addToUi();
}