drop support for "currency" and "currencyFormatCallback"

There is another callback option "tooltipFnc" that allows transformation
of the value string. The currency options are hardcoded as prefix and
the transformation is applied in non-intuitive order. Finally, adding a
currency symbol can be achieved with a single callback:
  (value) => '$ ' + value

Author: stklcode

CHANGELOG.md

@@ -11,7 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * The plugin provides an ESM, CSJ and UMD version
 * The "class" option accepts a single class name or an array of class names
 * Sources were converted to TypeScript
-* replace deprecated properties "page{X,Y}Offset" with scroll{X,Y}
+* Replace deprecated properties "page{X,Y}Offset" with scroll{X,Y}
+* Dropped support for "currency" and "currencyFormatCallback" options (use "tooltipFnc" instead)
 
 ## [1.0.0] - 2nd January 2023
 

README.md

@@ -6,14 +6,6 @@ It's published on npm as [chartist-plugin-tooltips-updated](https://www.npmjs.co
 
 ## Available options and their defaults
 
-* **currency**: `string`
-
-  Currency or unit suffix, e.h. '$', '€' or '%' to be appended to the value.
-
-* **currencyFormatCallback**: `(value: string, options: Options) => string`
-
-  Transformation function to be applied in combination with "currency".
-
 * **tooltipOffset**: `{ x: number, y: number }`
 
   Tooltip offset in px. Default: `{ x: 0, y: -20 }`

src/scripts/chartist-plugin-tooltip.ts

@@ -5,18 +5,6 @@ import { BarChart, BaseChart, PieChart } from 'chartist';
  * Tooltip plugin options.
  */
 export interface Options {
-  /**
-   * Currency or unit suffix, e.h. '$', '€' or '%' to be appended to the value.
-   */
-  currency?: string;
-  /**
-   * Transformation function to be applied in combination with "currency".
-   *
-   * @param value - The original value.
-   * @param options - Plugin options.
-   * @returns Tooltip value for output.
-   */
-  currencyFormatCallback?: (value: string, options: Options) => string;
   /**
    * Tooltip offset in px.
    * Default: x 0, y -20
@@ -72,8 +60,6 @@ export function ChartistPluginTooltip<T extends BaseChart>(
   options?: Partial<Options>
 ): void {
   const defaultOptions = {
-    currency: undefined,
-    currencyFormatCallback: undefined,
     tooltipOffset: {
       x: 0,
       y: -20
@@ -82,6 +68,8 @@ export function ChartistPluginTooltip<T extends BaseChart>(
     appendToBody: true,
     class: undefined,
     pointClass: 'ct-point',
+    tooltipFnc: undefined,
+    transformTooltipTextFnc: undefined,
     metaIsHTML: false
   };
 
@@ -194,15 +182,6 @@ export function ChartistPluginTooltip<T extends BaseChart>(
       }
 
       if (value) {
-        if ($options.currency) {
-          if ($options.currencyFormatCallback !== undefined) {
-            value = $options.currencyFormatCallback(value, $options);
-          } else {
-            value =
-              $options.currency +
-              value.replace(/(\d)(?=(\d{3})+(?:\.\d+)?$)/g, '$1,');
-          }
-        }
         value = '<span class="chartist-tooltip-value">' + value + '</span>';
         tooltipText += value;
       }

test/spec/tooltip.spec.ts

@@ -1,8 +1,5 @@
 import { BarChart, LineChart, PieChart } from 'chartist';
-import {
-  ChartistPluginTooltip,
-  Options
-} from '../../src/scripts/chartist-plugin-tooltip';
+import { ChartistPluginTooltip } from '../../src/scripts/chartist-plugin-tooltip';
 
 describe('Tooltip Plugin', () => {
   beforeAll(() => {
@@ -408,11 +405,6 @@ describe('Tooltip Plugin', () => {
             [
               ChartistPluginTooltip,
               {
-                currency: '$',
-                currencyFormatCallback: (
-                  value: string,
-                  options: Options
-                ): string => options.currency + ' ' + value + ' (incl. VAT)',
                 tooltipOffset: {
                   x: 13,
                   y: 37
@@ -422,7 +414,7 @@ describe('Tooltip Plugin', () => {
                 class: 'my-tooltip',
                 pointClass: 'ct-point',
                 transformTooltipTextFnc: (value: string): string =>
-                  value + '.00'
+                  '$ ' + value + '.00'
               }
             ]
           ]
@@ -464,7 +456,7 @@ describe('Tooltip Plugin', () => {
 
     it('should generate tooltip content', () => {
       expect(tooltip?.innerHTML).toEqual(
-        '<span class="chartist-tooltip-value">$ 5.00 (incl. VAT)</span>'
+        '<span class="chartist-tooltip-value">$ 5.00</span>'
       );
     });