ContextualOperation

Type: Object

Defines the 'contextual operations' of nodes matching a given selector. These are shown in places like the structure view, the elements menu button in the content view, the breadcrumbs bar or the context menu.

The hideIn property describes in which views the operation is not applicable. This is optional and defaults to hiding nowhere. Possible values are 'context-menu', 'element-menu', 'breadcrumbs-menu' and 'structure-view'.

  • context-menu: The right click mouse menu, opens when the user right clicks on an element with contextual operations.

  • element-menu: A menu configured by the createElementMenuButtonWidget. The element-menu is also by default on the table cell, but will only show up when there are contextual operations for the element-menu available on the cell element.

  • breadcrumbs-menu: When the cursor is placed in an element with contextual operations, then you will find this element in the breadcrumbs together with breadcrumbs menu.

  • structure-view: You can find this menu in the outline sidebar for elements that are configured as configureAsStructureViewItem.

Properties

hideIn

Type: Array<String>

Where the operations should be hidden from view in a certain context; Possible values are 'context-menu', 'element-menu', 'breadcrumbs-menu' or 'structure-view'.

icon

Type: String

Use an icon in this component. This should be one of the FontAwesome (v5 Pro) icon names with an optional style prefix ('far ' is the default prefix). For more info, see the Font Awesome concept page.

label

Type: String

The label of the menu item. This overrides the label provided by the operation (operation.label).

name

Type: String

The name by with the operation was registered. The component will be replaced with a CompactStateMessage if the operation is not found.

operationData

Type: Object

Additional operation data, which will be added to the stepData of the operation.

tooltipContent

Type: String

The content of the tooltip that is displayed when hovering over the whole component.