Customize Popups and the Popup API in WebViewer Using JavaScript

The popups in WebViewer UI are small floating menus.

In WebViewer UI, there are 4 types of popups:

• context menu popup; appears on right click of a blank space

• text popup; appears on highlight of a text when using select tool

• annotation popup; appears on selection of annotation(s)

• content overlay popup; appears on hover of annotation(s)

There are a number of ways you may want to customize Popups. To name a few:

• Adding items
• Modifying items
• Deleting items

The WebViewer UI provides API's to easily handle each of these cases and more.

Get items

The unique identifier of the items in the popup can be retrieved using the getItems API. It returns an array of objects where each object contains a key that denotes the dataElement.

Adding items

Adding items can be done using the add API. The type of items to add can be found in the list of items for Modular UI.

Add new items at beginning of the popup

To add new items at beginning of the popup, do not provide a second parameter to the add function.

JavaScript (SDK v8.0+)

WebViewer(...)
  .then(function(instance) {
    instance.UI.contextMenuPopup.add({
      type: 'actionButton',
      label: 'some-label',
      onClick: () => console.log('clicked'),
    });
  });

JavaScript (SDK v6.0+)

WebViewer(...)
  .then(function(instance) {
    instance.contextMenuPopup.add({
      type: 'actionButton',
      label: 'some-label',
      onClick: () => console.log('clicked'),
    });
  });

Add new items at a specific location in the popup

There are 2 ways to do this.

Option one:

• If you know the specific element you want it to be after then you can provide a valid dataElement string as a second parameter. This will insert the new item(s) after the specified data element.

Option two:

• If you know the index where you want to add it (for example as the last button) then you can get the list of data elements in the popup using the getItems API. Then retrieve the data element from the item at that index.

JavaScript (SDK v8.0+)

WebViewer(...)
  .then(function(instance) {
    // insert after the last element in the popup
    const contextMenuItems = instance.UI.contextMenuPopup.getItems();
    const lastItem = contextMenuItems[contextMenuItems.length - 1];

    instance.UI.contextMenuPopup.add({
      type: 'actionButton',
      label: 'Get selected text',
      onClick: () => console.log(instance.Core.documentViewer.getSelectedText()),
    },
    lastItem.dataElement);
  });

JavaScript (SDK v6.0+)

WebViewer(...)
  .then(function(instance) {
    // insert after the last element in the popup
    const contextMenuItems = instance.contextMenuPopup.getItems();
    const lastItem = contextMenuItems[contextMenuItems.length - 1];

    instance.contextMenuPopup.add({
      type: 'actionButton',
      label: 'Get selected text',
      onClick: () => console.log(instance.docViewer.getSelectedText()),
    },
    lastItem.dataElement);
  });

Modifying items

Existing items can be modified using updateElements. The items in the popup can be replaced using update.

Update existing elements' properties

JavaScript (SDK v8.0+)

WebViewer(...)
  .then(function(instance) {
    // Updating existing sticky tool button in context menu popup with new label and new on click handler
    instance.UI.updateElement("stickyToolButton", {label: 'new-label', onClick: () => console.log('clicked')});
  });

JavaScript (SDK v6.0+)

WebViewer(...)
  .then(function(instance) {
    // Updating existing sticky tool button in context menu popup with new label and new on click handler
    instance.updateElement("stickyToolButton", {label: 'new-label', onClick: () => console.log('clicked')});
  });

Replace existing elements

JavaScript (SDK v8.0+)

WebViewer(...)
  .then(function(instance) {
    // replace existing items with a new array of items
    instance.UI.contextMenuPopup.update([
      {
        type: 'actionButton',
        label: '1',
        onClick: () => console.log('clicked'),
      },
      {
        type: 'actionButton',
        label: '2',
        onClick: () => console.log('clicked'),
      },
    ]);
  });

JavaScript (SDK v6.0+)

WebViewer(...)
  .then(function(instance) {
    // replace existing items with a new array of items
    instance.contextMenuPopup.update([
      {
        type: 'actionButton',
        label: '1',
        onClick: () => console.log('clicked'),
      },
      {
        type: 'actionButton',
        label: '2',
        onClick: () => console.log('clicked'),
      },
    ]);
  });

Update ordering of elements in the popup

This can be done by:

1. Get the list of data elements in the popup using the getItems API
2. Modify ordering of the elements in the list retrieved from step 1.
3. call update

JavaScript (SDK v8.0+)

WebViewer(...)
  .then(function(instance) {
    const contextMenuItems = instance.UI.contextMenuPopup.getItems();
    const newArray = contextMenuItems.reverse();
    instance.UI.contextMenuPopup.update(newArray);
  });

JavaScript (SDK v6.0+)

WebViewer(...)
  .then(function(instance) {
    const contextMenuItems = instance.contextMenuPopup.getItems();
    const newArray = contextMenuItems.reverse();
    instance.contextMenuPopup.update(newArray);
  });

Deleting items

Items in the popup can be deleted using the using disableElements.

Adds a custom overlay to annotation on hover

JavaScript (SDK v8.0+)

WebViewer(...)
  .then(function(instance) {
    instance.UI.setAnnotationContentOverlayHandler(annotation => { 
      const div = document.createElement('div'); 
      div.appendChild(document.createTextNode(`Created by: ${annotation.Author}`)); 
      div.appendChild(document.createElement('br')); 
      div.appendChild(document.createTextNode(`Created on ${annotation.DateCreated}`)); 
      return div; 
    });
  });

JavaScript (SDK v6.0+)

WebViewer(...)
  .then(function(instance) {
    instance.setAnnotationContentOverlayHandler(annotation => { 
      const div = document.createElement('div'); 
      div.appendChild(document.createTextNode(`Created by: ${annotation.Author}`)); 
      div.appendChild(document.createElement('br')); 
      div.appendChild(document.createTextNode(`Created on ${annotation.DateCreated}`)); 
      return div; 
    });
  });

Customizing Popups with the Modular UI

When using the Modular UI, you can continue using existing Popup APIs. As of 11.8, you can also customize Popups using configuration files, making it easy to audit your current customizations at a glance or maintain different variants for different use cases.

To recap, there are three Popups you can customize using these APIs:

• AnnotationPopup: Appears when you select an annotation.
• ContextMenuPopup: Appears when you right-click anywhere on the viewer container.
• TextPopup: Appears when you select text.

For example, you may want to add a ToolButton to the ContextMenuPopup, so users can quickly access commonly used tools:

JavaScript

WebViewer(...)
  .then(function(instance) {
    instance.UI.contextMenuPopup.add({
      dataElement: 'rectangleToolButtonInContextMenu',
      type: 'toolButton',
      toolName: 'AnnotationCreateRectangle'
    });
    
    // Alternatively, you can use the constructor to create the new button.
    const ellipseToolButton = new instance.UI.Components.ToolButton({
    dataElement: 'ellipseToolButtonInContextMenu',
    toolName: 'AnnotationCreateEllipse',
    });
    
    // And then add it
    instance.UI.contextMenuPopup.add([ellipseToolButton]);
  });

Notice that we used a ToolButton as defined in the items documentation. Popups in the Modular UI support the following item types:

• ToolButton
• ToggleButton
• CustomButton
• StatefulButton
• CustomElement

Customizing via the configuration file

Starting in 11.8, when you call exportModularComponents, you will see a new key in the JSON for the three customizable Popups:

JSON

// Other components removed for ease of readability.
{
    "modularComponents": {},
    "modularHeaders": {},
    "panels": {},
    "flyouts": {},
    "popups": {
        "annotationPopup": [
            {
                "dataElement": "viewFileButton"
            },
            {
                "dataElement": "annotationCommentButton"
            },
            {
                "dataElement": "annotationStyleEditButton"
            }
        ],
        "textPopup": [
            {
                "dataElement": "copyTextButton"
            },
            {
                "dataElement": "textHighlightToolButton"
            },
            {
                "dataElement": "textUnderlineToolButton"
            },
            {
                "dataElement": "textSquigglyToolButton"
            },
            {
                "dataElement": "textStrikeoutToolButton"
            },
            {
                "dataElement": "textRedactToolButton"
            },
            {
                "dataElement": "linkButton"
            }
        ],
        "contextMenuPopup": [
            {
                "dataElement": "panToolButton"
            },
            {
                "dataElement": "stickyToolButton"
            },
            {
                "dataElement": "highlightToolButton"
            },
            {
                "dataElement": "freeHandToolButton"
            },
            {
                "dataElement": "freeHandHighlightToolButton"
            },
            {
                "dataElement": "freeTextToolButton"
            },
            {
                "dataElement": "markInsertTextToolButton"
            },
            {
                "dataElement": "markReplaceTextToolButton"
            }
        ]
    }
}

Each Popup will be a key in the JSON, with a list of the buttons it contains. The dataElements point to buttons the UI ships by default, such as the annotationStyleEditButton which toggles the Style Panel.

Why are there more items for each Popup than I can see in the UI?

The items for each Popup may not match what you see in all circumstances in the UI. For example, the AnnotationPopup includes the annotationGroupButton that only renders when you select multiple annotations.

As with any custom component in the Modular UI, if you pass custom handlers or render functions, make sure those functions are added to the FunctionMap when importing your configuration. See the FunctionMap guide for more in-depth examples.