EventDefinition

Defines an event that a plugin can emit. Other plugins can subscribe to these events via the Event Bus.

Example

// In manifest
events: [
  {
    type: 'filter-change',
    description: 'Emitted when filter criteria change',
  },
]

// In plugin class - emit
this.emitPluginEvent('filter-change', { field: 'name', value: 'Alice' });

// In another plugin - subscribe
this.on('filter-change', (detail) => console.log('Filter changed:', detail));

Properties

Property	Type	Description
type	string	The event type identifier (e.g., ‘filter-change’, ‘selection-change’). Used when emitting and subscribing to events.
description?	string	Human-readable description of what the event represents.
cancelable?	boolean	Whether this event is cancelable via event.preventDefault().

Property Details

cancelable

Default: false

---