Add missing feature for disabling plugins in TyeScript (#11403)

* Add missing feature for disabling plugins in TyeScript * apply review * remove empty line
chartjs · Jul 24, 2023 · f287be4 · f287be4
1 parent cc7ee8a
commit f287be4
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 17 deletions.
diff --git a/docs/developers/plugins.md b/docs/developers/plugins.md
@@ -197,7 +197,7 @@ declare module 'chart.js' {
   interface PluginOptionsByType<TType extends ChartType> {
     customCanvasBackgroundColor?: {
       color?: string
-    }
+    } | false
   }
 }
 ```
diff --git a/src/types/index.d.ts b/src/types/index.d.ts
@@ -2913,13 +2913,13 @@ export interface TooltipItem<TType extends ChartType> {
 }
 
 export interface PluginOptionsByType<TType extends ChartType> {
-  colors: ColorsPluginOptions;
-  decimation: DecimationOptions;
-  filler: FillerOptions;
-  legend: LegendOptions<TType>;
-  subtitle: TitleOptions;
-  title: TitleOptions;
-  tooltip: TooltipOptions<TType>;
+  colors: ColorsPluginOptions | false;
+  decimation: DecimationOptions | false;
+  filler: FillerOptions | false;
+  legend: LegendOptions<TType> | false;
+  subtitle: TitleOptions | false;
+  title: TitleOptions | false;
+  tooltip: TooltipOptions<TType> | false;
 }
 export interface PluginChartOptions<TType extends ChartType> {
   plugins: PluginOptionsByType<TType>;

diff --git a/test/types/defaults.ts b/test/types/defaults.ts
@@ -1,8 +1,8 @@
-import { Chart } from '../../src/types.js';
+import { Chart, TitleOptions, TooltipOptions } from '../../src/types.js';
 
 Chart.defaults.scales.time.time.minUnit = 'day';
 
-Chart.defaults.plugins.title.display = false;
+(Chart.defaults.plugins.title as TitleOptions).display = false;
 
 Chart.defaults.datasets.bar.backgroundColor = 'red';
 
@@ -27,4 +27,4 @@ Chart.defaults.layout = {
   },
 };
 
-Chart.defaults.plugins.tooltip.boxPadding = 3;
+(Chart.defaults.plugins.tooltip as TooltipOptions).boxPadding = 3;
diff --git a/test/types/overrides.ts b/test/types/overrides.ts
@@ -1,8 +1,8 @@
-import { Chart } from '../../src/types.js';
+import { Chart, TitleOptions } from '../../src/types.js';
 
 Chart.overrides.bar.scales.x.type = 'time';
 
-Chart.overrides.bar.plugins.title.display = false;
+(Chart.overrides.bar.plugins.title as TitleOptions).display = false;
 
 Chart.overrides.line.datasets.bar.backgroundColor = 'red';
 

diff --git a/test/types/plugins/defaults.ts b/test/types/plugins/defaults.ts
@@ -1,8 +1,9 @@
-import { defaults } from '../../../src/types.js';
+import { defaults, LegendOptions } from '../../../src/types.js';
 
 // https://github.com/chartjs/Chart.js/issues/8711
-const original = defaults.plugins.legend.labels.generateLabels;
+const original = (defaults.plugins.legend as LegendOptions<"line">).labels.generateLabels;
 
+// @ts-ignore
 defaults.plugins.legend.labels.generateLabels = function(chart) {
   return [{
     datasetIndex: 0,

diff --git a/test/types/plugins/disable.ts b/test/types/plugins/disable.ts
@@ -0,0 +1,16 @@
+import { Chart } from '../../../src/types.js';
+
+const chart = new Chart('id', {
+  type: 'bubble',
+  data: {
+    labels: [],
+    datasets: [{
+      data: []
+    }]
+  },
+  options: {
+    plugins: {
+      legend: false
+    }
+  }
+});
diff --git a/test/types/plugins/plugin.tooltip/tooltip_parsed_data_chart_defaults.ts b/test/types/plugins/plugin.tooltip/tooltip_parsed_data_chart_defaults.ts
@@ -1,6 +1,6 @@
-import { Chart } from '../../../../src/types.js';
+import { Chart, TooltipOptions } from '../../../../src/types.js';
 
-Chart.overrides.bubble.plugins.tooltip.callbacks.label = (item) => {
+(Chart.overrides.bubble.plugins.tooltip as TooltipOptions<'bubble'>).callbacks.label = (item) => {
   const { x, y, _custom: r } = item.parsed;
   return `${item.label}: (${x}, ${y}, ${r})`;
 };