Skip to main content

Type Alias: PluginContext<TProps>

PluginContext<TProps> = PluginContextOf<Gantt<TProps>, Dataset<TProps>>

Defined in: api/gantt.ts:335

S5.1, ADR 0019: the plugin shapes and PluginContext, bound to this class. See api/plugin.ts's file header for why the generic forms live there and the binding happens here. This file is the one that sees both Gantt and Dataset. So all four names bind here, the Dataset-installed ones included. These are the types a plugin author actually writes, and api/index.ts re-exports them alongside the generic *Of shapes.

TProps here names the plugin's own keys, not a consumer Gantt's or Dataset's — GanttOptions. plugins and the installPlugin/hasPlugin/uninstallPlugin family below all take the erased ChromePlugin (no type argument) for that reason. A plugin author writes definePlugin<LockProps> ({ … }) and meets this bound name through the return type definePlugin resolves to.

Type Parameters​

TProps​

TProps = unknown