feat(tooltip): refactor tooltip for react #831

lijinke666 · 2021-11-27T09:33:21Z

👀 PR includes

✨ Feature

New feature

🎨 Enhance

🐛 Bugfix

Solve the issue and close #0

🔧 Chore

📝 Description

*. 重构 react tooltip, 和 core 层解耦, 去除 getTooltipComponent 参数
*. 重构 tooltip 参数配置, 之前的 api 设计太绕了, 其实 tooltipComponent 和 element 就是一个概念

优先级：showTooltip(方法级) content => tooltip.content (配置级) => 默认 content

const s2Options = {
  tooltip: {
-   tooltipComponent: ""
+   content: ""
  }
}

const s2 = new PivotSheet()

- s2.showTooltip({ element: "" })
+ s2.showTooltip({ content: "" })
- s2.tooltip.show({ element: "" })
+ s2.tooltip.show({ content: "" })

*. 新增 s2.tooltip.renderTooltip() 用于继承 BaseTooltip 自定义 tooltip (react 层采用这种方式解耦)

import { BaseTooltip, SpreadSheet } from '@antv/s2';

export class CustomTooltip extends BaseTooltip {
  constructor(spreadsheet: SpreadSheet) {
    super(spreadsheet);
  }

  show(){}
  hide(){}
  destroy(){}
  renderContent(){}
}


const s2Options = {
  tooltip: {
    renderTooltip: (s2) => new CustomTooltip(s2)
  }
}

*. 修复 s2.showTooltip({ element: xx }) 和 s2.tooltip.show({element:xx}) 类型错误

不修复错误, 直接 @ts-ignore 太偷懒了吧 :)

*. 修复组件卸载时 tooltip 报错
*. 修复组件 tooltip 只能点击一次 close #828

*. 修复组件通过实例 s2.tooltip.show 或者 s2.showTooltip 方式调用 tootip 报错 close #813
*. 修复单元格级别的tooltip 无法显示
*. 修复 s2Options.tooltip.content: '' 和 s2.tooltip.show({ content: '' }) 但是依然显示 tooltip 内容

其他:

将 sheet entry demo 移动到 react playground 中
优化 issue template

TODO:

各种场景的测试

🔗 Related issue link

🔍 Self Check before Merge

Add or update relevant Docs.
Add or update relevant Demos.
Add or update relevant TypeScript definitions.

github-actions · 2021-11-27T09:33:34Z

🎊 PR Preview has been successfully built and deployed to https://s2-preview-pr-831.surge.sh

github-actions · 2021-11-27T09:40:08Z

Size Change: +70 B (0%)

Total Size: 184 kB

Filename	Size	Change
`./packages/s2-core/dist/index.min.js`	112 kB	-2 B (0%)
`./packages/s2-react/dist/index.min.js`	67.9 kB	+72 B (0%)

ℹ️ View Unchanged

Filename	Size
`./packages/s2-core/dist/style.min.css`	356 B
`./packages/s2-react/dist/style.min.css`	3.1 kB

_{compressed-size-action}

github-actions · 2021-11-27T09:41:04Z

你好, @lijinke666 CI 执行失败, 请点击 [Details] 按钮查看, 并根据日志修复。

Hello, @lijinke666 CI run failed, please click the [Details] button try to fixed it.

accesslint

There are accessibility issues in these changes.

packages/s2-react/playground/sheet-entry.tsx

packages/s2-core/__tests__/unit/ui/tooltip/index-spec.ts

packages/s2-core/src/common/interface/tooltip.ts

packages/s2-core/src/ui/tooltip/index.ts

lgtm-com · 2021-11-29T06:55:23Z

This pull request introduces 1 alert when merging 0f3b2b6 into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

lgtm-com · 2021-11-29T07:16:52Z

This pull request introduces 1 alert when merging ef32427 into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

lgtm-com · 2021-11-29T08:53:52Z

This pull request introduces 1 alert when merging d81d11e into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

lgtm-com · 2021-11-29T09:09:42Z

This pull request introduces 1 alert when merging 857182e into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

lgtm-com · 2021-11-29T09:35:26Z

This pull request introduces 1 alert when merging b5e9e98 into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

packages/s2-react/playground/index.tsx

lgtm-com · 2021-11-29T09:43:57Z

This pull request introduces 1 alert when merging cea299e into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

packages/s2-core/scripts/test-live.mjs

packages/s2-core/src/common/interface/tooltip.ts

packages/s2-core/__tests__/unit/sheet-type/pivot-sheet-spec.ts

xingwanying · 2021-11-29T10:00:04Z

单测挂了

lgtm-com · 2021-11-29T10:07:32Z

This pull request introduces 1 alert when merging f222754 into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

lgtm-com · 2021-11-29T11:33:24Z

This pull request introduces 1 alert when merging 06e0645 into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

codecov · 2021-11-29T11:35:16Z

Codecov Report

Merging #831 (cb046d0) into master (c4413c9) will increase coverage by 0.38%.
The diff coverage is 71.42%.

❗ Current head cb046d0 differs from pull request most recent head 594e398. Consider uploading reports for the commit 594e398 to get more accurate results

@@            Coverage Diff             @@
##           master     #831      +/-   ##
==========================================
+ Coverage   70.86%   71.24%   +0.38%     
==========================================
  Files         166      167       +1     
  Lines       11541    11550       +9     
  Branches     2702     2701       -1     
==========================================
+ Hits         8178     8229      +51     
+ Misses       2216     2182      -34     
+ Partials     1147     1139       -8

Impacted Files	Coverage Δ
packages/s2-core/src/utils/tooltip.ts	`43.97% <ø> (ø)`
packages/s2-react/src/utils/index.ts	`67.74% <ø> (-1.49%)`	⬇️
...kages/s2-core/src/utils/interaction/merge-cells.ts	`70.62% <33.33%> (+26.34%)`	⬆️
packages/s2-core/src/sheet-type/spread-sheet.ts	`80.63% <80.00%> (ø)`
packages/s2-core/src/ui/tooltip/index.ts	`88.05% <85.71%> (+3.31%)`	⬆️
packages/s2-react/src/common/constant/options.ts	`95.65% <100.00%> (+0.41%)`	⬆️
...kages/s2-react/src/components/tooltip/constants.ts	`100.00% <100.00%> (ø)`
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c4413c9...594e398. Read the comment docs.

accesslint

There are accessibility issues in these changes.

packages/s2-react/playground/sheet-entry.tsx

lgtm-com · 2021-11-29T11:52:17Z

This pull request introduces 1 alert when merging cb046d0 into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

lgtm-com · 2021-11-29T12:05:16Z

This pull request introduces 1 alert when merging 594e398 into f40f70d - view on LGTM.com

new alerts:

1 for Unused variable, import, function or class

stone-lyl

优先级：showTooltip(方法级) content => tooltip.content (配置级) => 默认 content
和 renderTooltip

github-actions · 2021-11-29T12:46:15Z

🎉 This PR is included in version @antv/s2-v1.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2021-11-29T12:48:38Z

🎉 This PR is included in version @antv/s2-react-v1.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2021-11-30T07:15:46Z

🎉 This PR is included in version @antv/s2-v1.0.0-beta.17 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2021-11-30T07:17:58Z

🎉 This PR is included in version @antv/s2-react-v1.0.0-beta.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

github-actions bot assigned lijinke666 Nov 27, 2021

github-actions bot requested review from qubaomingg, stone-lyl, wjgogogo, xingwanying, yangzhanmei, YardWill and zxc0328 November 27, 2021 09:33

github-actions bot added the 🚨 test failed 单元测试挂了 label Nov 27, 2021

lijinke666 changed the title ~~[WIP] refactor(tooltip): custom tooltip for react~~ [WIP] feat(tooltip): refactor tooltip for react Nov 27, 2021

accesslint bot reviewed Nov 28, 2021

View reviewed changes

packages/s2-react/playground/sheet-entry.tsx Show resolved Hide resolved

stone-lyl reviewed Nov 29, 2021

View reviewed changes

packages/s2-core/__tests__/unit/ui/tooltip/index-spec.ts Show resolved Hide resolved

packages/s2-core/src/common/interface/tooltip.ts Show resolved Hide resolved

packages/s2-core/src/ui/tooltip/index.ts Show resolved Hide resolved

lijinke666 changed the title ~~[WIP] feat(tooltip): refactor tooltip for react~~ feat(tooltip): refactor tooltip for react Nov 29, 2021

github-actions bot added the pr(feature) new feature label Nov 29, 2021

stone-lyl previously approved these changes Nov 29, 2021

View reviewed changes

lijinke666 dismissed stone-lyl’s stale review via b5e9e98 November 29, 2021 09:28

lijinke666 commented Nov 29, 2021

View reviewed changes

packages/s2-react/playground/index.tsx Show resolved Hide resolved

lijinke666 commented Nov 29, 2021

View reviewed changes

packages/s2-react/playground/index.tsx Outdated Show resolved Hide resolved

xingwanying reviewed Nov 29, 2021

View reviewed changes

packages/s2-core/scripts/test-live.mjs Show resolved Hide resolved

packages/s2-core/src/common/interface/tooltip.ts Outdated Show resolved Hide resolved

packages/s2-core/__tests__/unit/sheet-type/pivot-sheet-spec.ts Show resolved Hide resolved

github-actions bot removed the 🚨 test failed 单元测试挂了 label Nov 29, 2021

accesslint bot reviewed Nov 29, 2021

View reviewed changes

packages/s2-react/playground/sheet-entry.tsx Show resolved Hide resolved

stone-lyl previously approved these changes Nov 29, 2021

View reviewed changes

feat: refactor react tooltip

594e398

lijinke666 dismissed stone-lyl’s stale review via 594e398 November 29, 2021 12:00

lijinke666 force-pushed the fix-tooltip branch from cb046d0 to 594e398 Compare November 29, 2021 12:00

stone-lyl approved these changes Nov 29, 2021

View reviewed changes

lijinke666 merged commit 3e57279 into master Nov 29, 2021

lijinke666 deleted the fix-tooltip branch November 29, 2021 12:11

github-actions bot added the released label Nov 29, 2021

github-actions bot added the released on @beta label Nov 30, 2021

wjgogogo pushed a commit that referenced this pull request Oct 25, 2023

feat: refactor react tooltip (#831)

b1ec258

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tooltip): refactor tooltip for react #831

feat(tooltip): refactor tooltip for react #831

lijinke666 commented Nov 27, 2021 •

edited

github-actions bot commented Nov 27, 2021 •

edited

github-actions bot commented Nov 27, 2021 •

edited

github-actions bot commented Nov 27, 2021 •

edited

accesslint bot left a comment

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

xingwanying commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

codecov bot commented Nov 29, 2021 •

edited

accesslint bot left a comment

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

stone-lyl left a comment

github-actions bot commented Nov 29, 2021

github-actions bot commented Nov 29, 2021

github-actions bot commented Nov 30, 2021

github-actions bot commented Nov 30, 2021

feat(tooltip): refactor tooltip for react #831

feat(tooltip): refactor tooltip for react #831

Conversation

lijinke666 commented Nov 27, 2021 • edited

👀 PR includes

📝 Description

🔗 Related issue link

🔍 Self Check before Merge

github-actions bot commented Nov 27, 2021 • edited

github-actions bot commented Nov 27, 2021 • edited

github-actions bot commented Nov 27, 2021 • edited

accesslint bot left a comment

Choose a reason for hiding this comment

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

xingwanying commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

codecov bot commented Nov 29, 2021 • edited

Codecov Report

accesslint bot left a comment

Choose a reason for hiding this comment

lgtm-com bot commented Nov 29, 2021

lgtm-com bot commented Nov 29, 2021

stone-lyl left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 29, 2021

github-actions bot commented Nov 29, 2021

github-actions bot commented Nov 30, 2021

github-actions bot commented Nov 30, 2021

lijinke666 commented Nov 27, 2021 •

edited

github-actions bot commented Nov 27, 2021 •

edited

github-actions bot commented Nov 27, 2021 •

edited

github-actions bot commented Nov 27, 2021 •

edited

codecov bot commented Nov 29, 2021 •

edited