Add events property to Plugin defined type (#11350)

chartjs · Jun 20, 2023 · b42f9d1 · b42f9d1
1 parent 201ddff
commit b42f9d1
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/types/index.d.ts b/src/types/index.d.ts
@@ -816,6 +816,12 @@ export declare const layouts: {
 export interface Plugin<TType extends ChartType = ChartType, O = AnyObject> extends ExtendedPlugin<TType, O> {
   id: string;
 
+  /**
+   * The events option defines the browser events that the plugin should listen.
+   * @default ['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']
+   */
+  events?: (keyof HTMLElementEventMap)[]
+
   /**
    * @desc Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).
    * @param {Chart} chart - The chart instance.