PluginDependency

Declares a dependency on another plugin.

Example

export class UndoRedoPlugin extends BaseGridPlugin {
  static readonly dependencies: PluginDependency[] = [
    { name: 'editing', required: true },
  ];
}

Properties

Property	Type	Description
name	string	The name of the required plugin (matches the plugin’s name property). Use string names for loose coupling - avoids static imports.
required?	boolean	Whether this dependency is required (hard) or optional (soft). - true: Plugin cannot function without it. Throws error if missing. - false: Plugin works with reduced functionality. Logs info if missing.
reason?	string	Human-readable reason for this dependency. Shown in error/info messages to help users understand why.

Property Details

required

Default: true

---

reason

"UndoRedoPlugin needs EditingPlugin to track cell edits"

---