Smart.Editor Context Menu

Editor Context Menu

Smart.Editor has a built in context menu that is available by default. When the user right clicks with the mouse inside the Editor, the context menu opens. A different options list is displayed depending on the target. However the options list can be customized.

The contextMenu property determines the behavior of the Editor's context menu. It is possible to use the native context menu instead of the Editor's built in or event disable the context menus inside the element.

Here's how to enable the browser's context menu in order to used it instead of the built in:

document.querySelector('smart-editor').contextMenu = 'browser';

Let's take a close look at the built in Context menu options.

Table Context Menu

When the user triggers the context menu on a Table cell element inside the Editor a specific options list appears that allows to execute quick actions like:

  • Edit the Table Properties
  • Insert new rows/columns
  • Delete rows/columns
  • Delete the whole table
Editor Context Menu

Image Context Menu

Image elements inside the Editor also offer specific context menu options:

  • Edit Image Properties
  • Copy/Cut the image
  • Add/Remove a hyperlink
  • Add/Remove a caption
Editor Context Menu 2

Link Context Menu

Hyperlink elements inside the Editor also have specific context menu options:

  • Editor the Link properties
  • Delete the link
Editor Context Menu 3

Text Context Menu

Clicking anywhere else inside the Editor's content will trigger the default context menu for text.

The default context menu options offer basic quick actions like copy, paste, cut and text selection

Editor Context Menu 4

Custom Context Menu

The Context menu options can be customized. The user can specify a list of completely different quick action items even for specific targets.

It is also possible to modify the default options list and remove specific options that the user does not want to have or include additional.

The contextMenuDataSource property allows to modify the options list of the context menu. It accepts an array of strings or objects with the following format 

{ label: string, value: string }

If the list option is a string it is used as the label and value for the item. When defined as objects the user can set a one label to an option while it has a different value.

The contextMenuDataSource also accepts a function with the following format: 

function (target: HTMLElement, type: string, defaultItems: string[]) { return defaultItems }
When the property is a function it is possible to modify the default options list instead of replacing it. The defaultItems is an array that contains the options for the context menu that will be displayed. The type parameter represents the type of the context menu (table, image, link or text). The function is executed before the context menu is opened.

The following demo shows to to add a custom context menu item that deletes everything inside the Editor:

window.Smart('#editor', class {
    get properties() {
        return {
            //Properties
            contextMenuDataSource: function (target, type, defaultItems) {
                if (type === 'table') {
                    defaultItems.splice(defaultItems.indexOf('deleteTable'), 1);
                    defaultItems.splice(defaultItems.indexOf('deleteRow'), 1);
                    defaultItems.splice(defaultItems.indexOf('deleteColumn'), 1);
                }
                if (!defaultItems.find(i => typeof i === 'object' && i.value === 'custoItem1')) {
                    defaultItems.push({
                        label: 'Custom Delete All Item',
                        value: 'customItem1'
                    });
                }
                return defaultItems;
            }
        };
    }
});

The context menu fires a contextMenuItemClick event which contains the value of the selected item. This way it is possible to execute a custom logic when a certain item has been clicked.

Editor Context Menu 5