refactor(tooltip): 重构 tooltip API 命名 (#2271)

Co-authored-by: wjgogogo <[email protected]>
antvis · Jul 17, 2023 · d25cfc6 · d25cfc6
1 parent c332c68
commit d25cfc6
Show file tree

Hide file tree

Showing 89 changed files with 303 additions and 249 deletions.
diff --git a/packages/s2-core/__tests__/spreadsheet/corner-spec.ts b/packages/s2-core/__tests__/spreadsheet/corner-spec.ts
@@ -30,7 +30,7 @@ describe('PivotSheet Corner Tests', () => {
       width: 300,
       height: 300,
       tooltip: {
-        showTooltip: true,
+        enable: true,
       },
     });
     await s2.render();

diff --git a/packages/s2-core/__tests__/spreadsheet/hidden-columns-spec.ts b/packages/s2-core/__tests__/spreadsheet/hidden-columns-spec.ts
@@ -13,7 +13,7 @@ const s2Options: S2Options = {
   width: 400,
   height: 120,
   tooltip: {
-    showTooltip: true,
+    enable: true,
   },
 };
 

diff --git a/packages/s2-core/__tests__/spreadsheet/interaction-multi-selection-spec.ts b/packages/s2-core/__tests__/spreadsheet/interaction-multi-selection-spec.ts
@@ -13,7 +13,7 @@ const s2Options: S2Options = {
   width: 600,
   height: 400,
   tooltip: {
-    showTooltip: true,
+    enable: true,
   },
 };
 

diff --git a/packages/s2-core/__tests__/spreadsheet/interaction-tooltip-spec.ts b/packages/s2-core/__tests__/spreadsheet/interaction-tooltip-spec.ts
@@ -9,7 +9,7 @@ const s2Options: S2Options = {
   width: 600,
   height: 400,
   tooltip: {
-    showTooltip: true,
+    enable: true,
   },
 };
 

diff --git a/packages/s2-core/__tests__/spreadsheet/layout-hooks-spec.ts b/packages/s2-core/__tests__/spreadsheet/layout-hooks-spec.ts
@@ -145,7 +145,7 @@ const s2Options: S2Options = {
     },
   },
   tooltip: {
-    showTooltip: true,
+    enable: true,
   },
   // layout hooks
   layoutArrange: CustomLayoutArrange,

diff --git a/packages/s2-core/__tests__/spreadsheet/tooltip-spec.ts b/packages/s2-core/__tests__/spreadsheet/tooltip-spec.ts
@@ -16,7 +16,7 @@ describe('Tooltip Tests', () => {
     });
 
   test('should not render tooltip in default container if disable tooltip', async () => {
-    const s2 = createS2({ showTooltip: false });
+    const s2 = createS2({ enable: false });
 
     await s2.render();
 
@@ -28,7 +28,7 @@ describe('Tooltip Tests', () => {
   });
 
   test('should not render tooltip in default container when hide tooltip if disable tooltip', async () => {
-    const s2 = createS2({ showTooltip: false });
+    const s2 = createS2({ enable: false });
 
     await s2.render();
 
@@ -42,7 +42,7 @@ describe('Tooltip Tests', () => {
   });
 
   test('should render tooltip in default container', async () => {
-    const s2 = createS2({ showTooltip: true });
+    const s2 = createS2({ enable: true });
 
     await s2.render();
 
@@ -62,7 +62,7 @@ describe('Tooltip Tests', () => {
     document.body.appendChild(container);
 
     const s2 = createS2({
-      showTooltip: true,
+      enable: true,
       adjustPosition: (positionInfo) => {
         const { position } = positionInfo;
 
@@ -86,7 +86,7 @@ describe('Tooltip Tests', () => {
     document.body.appendChild(container);
 
     const s2 = createS2({
-      showTooltip: true,
+      enable: true,
       getContainer: () => container,
     });
 

diff --git a/packages/s2-core/__tests__/unit/interaction/base-interaction/click/row-column-click-spec.ts b/packages/s2-core/__tests__/unit/interaction/base-interaction/click/row-column-click-spec.ts
@@ -66,7 +66,7 @@ describe('Interaction Row & Column Cell Click Tests', () => {
         hiddenColumnFields: ['a'],
       },
       tooltip: {
-        showTooltip: true,
+        enable: true,
         operation: {
           hiddenColumns: false,
         },

diff --git a/packages/s2-core/__tests__/unit/interaction/base-interaction/hover-spec.ts b/packages/s2-core/__tests__/unit/interaction/base-interaction/hover-spec.ts
@@ -28,10 +28,9 @@ describe('Interaction Hover Tests', () => {
   const mockTooltipParams = [
     [{ value: undefined, valueField: undefined }],
     {
-      enterable: true,
       hideSummary: true,
       isTotals: undefined,
-      showSingleTips: true,
+      onlyShowCellText: true,
     },
   ];
 

diff --git a/packages/s2-core/__tests__/unit/interaction/event-controller-spec.ts b/packages/s2-core/__tests__/unit/interaction/event-controller-spec.ts
@@ -51,7 +51,7 @@ const s2Options: S2Options = {
   width: 200,
   height: 200,
   tooltip: {
-    showTooltip: true,
+    enable: true,
   },
   interaction: {
     enableCopy: true,
@@ -954,15 +954,15 @@ describe('Interaction Event Controller Tests', () => {
 
     spreadsheet.on(S2Event.GLOBAL_RESET, reset);
     spreadsheet.options.tooltip = {
-      showTooltip: false,
+      enable: false,
       dataCell: {
-        showTooltip: true,
+        enable: true,
       },
       colCell: {
-        showTooltip: true,
+        enable: true,
       },
       rowCell: {
-        showTooltip: true,
+        enable: true,
       },
     };
     spreadsheet.tooltip.visible = true;

diff --git a/packages/s2-core/__tests__/unit/sheet-type/pivot-sheet-spec.ts b/packages/s2-core/__tests__/unit/sheet-type/pivot-sheet-spec.ts
@@ -53,7 +53,7 @@ describe('PivotSheet Tests', () => {
     hierarchyType: 'grid',
     customSVGIcons: [customSVGIcon],
     tooltip: {
-      showTooltip: true,
+      enable: true,
     },
     interaction: {
       autoResetSheetStyle: false,
@@ -146,7 +146,7 @@ describe('PivotSheet Tests', () => {
     test("should dont't show tooltip when call showTooltipWithInfo if disable tooltip", () => {
       Object.defineProperty(s2.options, 'tooltip', {
         value: {
-          showTooltip: false,
+          enable: false,
         },
         configurable: true,
       });
@@ -162,7 +162,7 @@ describe('PivotSheet Tests', () => {
     test('should show tooltip when call showTooltipWithInfo if enable tooltip', () => {
       Object.defineProperty(s2.options, 'tooltip', {
         value: {
-          showTooltip: true,
+          enable: true,
         },
         configurable: true,
       });
@@ -384,8 +384,8 @@ describe('PivotSheet Tests', () => {
         dataCfg,
         customMerge(s2Options, {
           tooltip: {
-            showTooltip: true,
-            renderTooltip: (spreadsheet) => new CustomTooltip(spreadsheet),
+            enable: true,
+            render: (spreadsheet) => new CustomTooltip(spreadsheet),
             autoAdjustBoundary: null,
           } as S2Options['tooltip'],
         }),
@@ -414,8 +414,8 @@ describe('PivotSheet Tests', () => {
         dataCfg,
         customMerge(s2Options, {
           tooltip: {
-            showTooltip: true,
-            renderTooltip: () => new CustomTooltip(),
+            enable: true,
+            render: () => new CustomTooltip(),
             autoAdjustBoundary: null,
           },
         }),
@@ -908,7 +908,7 @@ describe('PivotSheet Tests', () => {
         expect.anything(),
         expect.anything(),
         {
-          onlyMenu: true,
+          onlyShowOperator: true,
           forceRender: true,
           operator: {
             menus: [
@@ -1254,7 +1254,7 @@ describe('PivotSheet Tests', () => {
     const sheet = new PivotSheet(getContainer(), originalDataCfg, {
       facet: (spreadsheet) => new CustomFacet(spreadsheet),
       tooltip: {
-        showTooltip: false,
+        enable: false,
       },
     });
 

diff --git a/packages/s2-core/__tests__/unit/sheet-type/table-sheet-spec.ts b/packages/s2-core/__tests__/unit/sheet-type/table-sheet-spec.ts
@@ -14,7 +14,7 @@ describe('TableSheet Tests', () => {
     width: 100,
     height: 100,
     tooltip: {
-      showTooltip: true,
+      enable: true,
     },
     interaction: {
       autoResetSheetStyle: false,
@@ -63,7 +63,7 @@ describe('TableSheet Tests', () => {
         [],
         {
           operator: expect.anything(),
-          onlyMenu: true,
+          onlyShowOperator: true,
           forceRender: true,
         },
       );
@@ -199,7 +199,7 @@ describe('TableSheet Tests', () => {
           expect.anything(),
           {
             forceRender: true,
-            onlyMenu: true,
+            onlyShowOperator: true,
             operator: {
               menus: [
                 { icon: 'groupAsc', key: 'asc', text: groupAscText },
@@ -254,7 +254,7 @@ describe('TableSheet Tests', () => {
     const sheet = new TableSheet(getContainer(), dataCfg, {
       facet: (spreadsheet) => new CustomFacet(spreadsheet),
       tooltip: {
-        showTooltip: false,
+        enable: false,
       },
     });
 

diff --git a/packages/s2-core/__tests__/unit/utils/merge-spec.ts b/packages/s2-core/__tests__/unit/utils/merge-spec.ts
@@ -253,12 +253,12 @@ describe('merge test', () => {
         "supportCSSTransform": false,
         "tooltip": Object {
           "autoAdjustBoundary": "body",
+          "enable": false,
           "operation": Object {
             "hiddenColumns": false,
             "menus": Array [],
             "sort": false,
           },
-          "showTooltip": false,
         },
         "totals": Object {},
         "width": 600,
@@ -269,7 +269,7 @@ describe('merge test', () => {
   test('should get custom options', () => {
     const options = getSafetyOptions({
       tooltip: {
-        showTooltip: false,
+        enable: false,
         operation: {
           sort: false,
           menus: [
@@ -285,6 +285,7 @@ describe('merge test', () => {
     expect(options.tooltip).toMatchInlineSnapshot(`
       Object {
         "autoAdjustBoundary": "body",
+        "enable": false,
         "operation": Object {
           "hiddenColumns": false,
           "menus": Array [
@@ -295,7 +296,6 @@ describe('merge test', () => {
           ],
           "sort": false,
         },
-        "showTooltip": false,
       }
     `);
   });

diff --git a/packages/s2-core/__tests__/unit/utils/tooltip-spec.ts b/packages/s2-core/__tests__/unit/utils/tooltip-spec.ts
@@ -277,7 +277,7 @@ describe('Tooltip Utils Tests', () => {
         const type = getCellNameByType(cellType);
 
         const tooltip: Tooltip = {
-          showTooltip: false,
+          enable: false,
           content: '',
           operation: {
             hiddenColumns: true,
@@ -286,7 +286,7 @@ describe('Tooltip Utils Tests', () => {
             menus: [{ key: 'menu-a', text: 'menu-a' }],
           },
           [type]: {
-            showTooltip: true,
+            enable: true,
             operation: {
               hiddenColumns: false,
               menus: [{ key: 'menu-b', text: 'menu-b' }],
@@ -307,7 +307,7 @@ describe('Tooltip Utils Tests', () => {
         );
 
         expect(tooltipOptions).toEqual({
-          showTooltip: true,
+          enable: true,
           content: '',
           operation: {
             hiddenColumns: false,
@@ -465,7 +465,7 @@ describe('Tooltip Utils Tests', () => {
       return getTooltipData({
         cellInfos: [cell as TooltipData],
         options: {
-          showSingleTips: true,
+          onlyShowCellText: true,
         },
         targetCell: cell,
         spreadsheet: s2,
@@ -501,7 +501,7 @@ describe('Tooltip Utils Tests', () => {
       const tooltipData = getTooltipData({
         cellInfos: [selectedCellMetas as TooltipData],
         options: {
-          showSingleTips: false,
+          onlyShowCellText: false,
         },
         targetCell: null,
         spreadsheet: s2,
@@ -552,7 +552,7 @@ describe('Tooltip Utils Tests', () => {
         cellInfos: [],
         options: {
           enableFormat: true,
-          showSingleTips: false,
+          onlyShowCellText: false,
         },
         targetCell: cell.mockCell,
         spreadsheet: s2,

diff --git a/packages/s2-core/__tests__/util/interaction.ts b/packages/s2-core/__tests__/util/interaction.ts
@@ -33,7 +33,7 @@ export const getTestTooltipData = (s2: SpreadSheet, cell: S2CellType) => {
     cellInfos,
     targetCell: cell,
     options: {
-      showSingleTips: true,
+      onlyShowCellText: true,
     },
   });
 };

diff --git a/packages/s2-core/src/common/constant/options.ts b/packages/s2-core/src/common/constant/options.ts
@@ -47,7 +47,7 @@ export const DEFAULT_OPTIONS: Readonly<S2Options> = {
   conditions: {},
   totals: {},
   tooltip: {
-    showTooltip: false,
+    enable: false,
     autoAdjustBoundary: 'body',
     operation: {
       hiddenColumns: false,

diff --git a/packages/s2-core/src/common/interface/basic.ts b/packages/s2-core/src/common/interface/basic.ts
@@ -270,7 +270,7 @@ export type FullyIconName = {
 export type ActionIconName = string | FullyIconName;
 
 export interface HeaderActionIcon {
-  /*
+  /**
    * 已注册的 icon 类型或自定义的 icon 类型名
    * 如果是 string[], 则默认 icon 位置为右侧
    */