fix: escape quotes in title generated fields

vega · Jul 19, 2023 · b1d0023 · b1d0023
1 parent d535812
commit b1d0023
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 2 deletions.
diff --git a/site/_data/versions.yml b/site/_data/versions.yml
@@ -0,0 +1,4 @@
+vega: 5.25.0
+vega-lite: 5.9.3
+vega-embed: 6.22.1
+vega-tooltip: 0.32.0
diff --git a/src/compile/mark/encode/tooltip.ts b/src/compile/mark/encode/tooltip.ts
@@ -88,7 +88,7 @@ export function tooltipData(
         };
 
     const title = fieldDef.title || defaultTitle(fieldDef, formatConfig);
-    const key = array(title).join(', ');
+    const key = array(title).join(', ').replaceAll(/"/g, '\\"');
 
     let value: string;
 

diff --git a/test/compile/mark/encode/tooltip.test.ts b/test/compile/mark/encode/tooltip.test.ts
@@ -152,6 +152,19 @@ describe('compile/mark/encode/tooltip', () => {
         signal: '{"baz": isValid(datum["Foobar"]) ? datum["Foobar"] : ""+datum["Foobar"]}'
       });
     });
+
+    it('generates correct keys and values for channels with title with quotes', () => {
+      const model = parseUnitModelWithScaleAndLayoutSize({
+        mark: {type: 'point', tooltip: true},
+        encoding: {
+          color: {field: 'Foobar', type: 'nominal', title: '"baz"'}
+        }
+      });
+      const props = tooltip(model);
+      expect(props.tooltip).toEqual({
+        signal: '{"\\"baz\\"": isValid(datum["Foobar"]) ? datum["Foobar"] : ""+datum["Foobar"]}'
+      });
+    });
   });
 
   describe('tooltipForEncoding', () => {

diff --git a/tsconfig.json b/tsconfig.json
@@ -15,7 +15,7 @@
     "resolveJsonModule": true,
     "suppressImplicitAnyIndexErrors": true,
     "isolatedModules": true,
-    "lib": ["ESNext.Array", "DOM", "DOM.Iterable"],
+    "lib": ["ESNext.Array", "DOM", "DOM.Iterable", "ES2021.String"],
     "noEmit": true
   },
   "files": ["src/index.ts"],