feat(tooltip): enhance tooltip by lijinke666 · Pull Request #862 · antvis/S2

lijinke666 · 2021-12-03T08:18:58Z

👀 PR includes

✨ Feature

New feature

🐛 Bugfix

Solve the issue and close 🐛 单元格默认点击展示tooltips行为异常 / 框选功能 / 右键/选择单元格 #852

📝 Description

新增 tooltip.content 支持回调形式, 用于根据当前单元格信息自定义 tooltip 内容

const TooltipContent = (props) => <div>...</div>
const s2options = {
  tooltip: {
    content: (cell) => {
      const meta = cell.getMeta()
      return <TooltipContent {...meta}/>
    },
  },
};

新增 tooltip 支持 corner 配置, tooltip.cell 重命名为 tooltip.data, 保持和内部单元格命名一致, 避免歧义

const s2options = {
  tooltip: {
    row: {},
    col: {},
+   corner: {},
-   cell: {},
+   data: {}
  },
};

新增组件层新增单元格 hover 事件的透出 eg. onRowCellHover

<SheetComponent onRowCellHover={} onRowCellClick={} onDataCellHover={} onDataCellClick={} />

修复组件层注销时, 部分 canvas 的事件没有注销, 取消组件层的 unBindEvent 修改为 core 层统一注销
修复单击单元格出现 tooltip 时, 点击鼠标右键出现浏览器菜单后, 误判为刷选模式
修复单击单元格时未清空 hoverFocusTimer 800ms 的计时器, 导致有几率关闭 tooltip 后再次出现的问题
修复组件层自定义 content 控制台警告 (重复的key)
完善相关文档
- tooltip
- 自定义 tooltip content 示例
- 通过自定义交互自定义 tooltip 示例
- 新增 BaseCell 基础类 API

🖼️ Screenshot

Before	After

🔗 Related issue link

close #852

🔍 Self Check before Merge

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

github-actions · 2021-12-03T08:19:12Z

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

github-actions · 2021-12-03T08:24:12Z

Size Change: +104 B (0%)

Total Size: 185 kB

Filename	Size	Change
`./packages/s2-core/dist/index.min.js`	113 kB	+25 B (0%)
`./packages/s2-react/dist/index.min.js`	68.6 kB	+79 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-12-03T08:28:05Z

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

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

codecov · 2021-12-03T10:41:28Z

Codecov Report

Merging #862 (20ac4b7) into master (025ec55) will increase coverage by 0.68%.
The diff coverage is 93.33%.

@@            Coverage Diff             @@
##           master     #862      +/-   ##
==========================================
+ Coverage   71.13%   71.81%   +0.68%     
==========================================
  Files         168      170       +2     
  Lines       11654    12561     +907     
  Branches     2729     3047     +318     
==========================================
+ Hits         8290     9021     +731     
- Misses       2220     2318      +98     
- Partials     1144     1222      +78

Impacted Files	Coverage Δ
packages/s2-core/src/ui/tooltip/index.ts	`87.32% <ø> (ø)`
packages/s2-core/src/utils/tooltip.ts	`44.01% <ø> (+0.04%)`	⬆️
...ackages/s2-core/src/interaction/brush-selection.ts	`84.43% <85.71%> (+0.38%)`	⬆️
packages/s2-core/src/facet/header/corner.ts	`76.72% <100.00%> (ø)`
...eraction/base-interaction/click/data-cell-click.ts	`76.36% <100.00%> (+0.21%)`	⬆️
packages/s2-core/src/sheet-type/spread-sheet.ts	`81.30% <100.00%> (+1.12%)`	⬆️
packages/s2-core/src/cell/corner-cell.ts	`70.61% <0.00%> (-0.11%)`	⬇️
packages/s2-core/src/interaction/root.ts	`84.75% <0.00%> (-0.01%)`	⬇️
... and 19 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 025ec55...20ac4b7. Read the comment docs.

packages/s2-core/src/interaction/brush-selection.ts

packages/s2-react/playground/index.tsx

packages/s2-react/src/components/sheets/grid-analysis-sheet/index.tsx

xingwanying · 2021-12-05T10:51:21Z

如果设置了 cell 是不是默认的content就失效了? 如果分类别去枚举配置,这个cell的定义有些奇怪, 毕竟 row 和 col 也属于cell 范围, 此外还有corner cell 和 series cell 是否也需要一并考虑?

s2-site/docs/manual/basic/tooltip.zh.md

lijinke666 · 2021-12-06T03:50:19Z

如果设置了 cell 是不是默认的content就失效了? 如果分类别去枚举配置,这个cell的定义有些奇怪, 毕竟 row 和 col 也属于cell 范围, 此外还有corner cell 和 series cell 是否也需要一并考虑?

cell 改成 data 吧, 和内部单元格命名保持一致, cell 确实有歧义, 之前蒺藜设计的这块, 没太注意, 序号没啥必要, 等有用户反馈再说吧, corner 可以支持

xingwanying

LG

github-actions · 2021-12-06T09:14:29Z

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

The release is available on:

Your semantic-release bot 📦🚀

github-actions · 2021-12-06T09:17:00Z

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

The release is available on:

Your semantic-release bot 📦🚀

* feat(tooltip): enhance tooltip * feat(tooltip): update docs * feat(tooltip): fix test * feat(tooltip): fix test * feat(tooltip): fix test * feat(tooltip): update docs * feat(tooltip): update demo * feat(tooltip): update docs * feat(tooltip): support config corner and rename cell => data * feat(tooltip): update docs

feat(tooltip): enhance tooltip

f4070de

github-actions bot added the pr(feature) new feature label Dec 3, 2021

github-actions bot assigned lijinke666 Dec 3, 2021

github-actions bot requested review from YardWill, qubaomingg, stone-lyl, wjgogogo, xingwanying, yangzhanmei and zxc0328 December 3, 2021 08:19

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

lijinke666 added 4 commits December 3, 2021 17:36

feat(tooltip): update docs

0a1cc3e

feat(tooltip): fix test

3ec5636

feat(tooltip): fix test

36a528d

feat(tooltip): fix test

aa1438e

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

lijinke666 added 2 commits December 3, 2021 20:26

feat(tooltip): update docs

a93dddf

feat(tooltip): update demo

16c93a5

xingwanying reviewed Dec 5, 2021

View reviewed changes

packages/s2-core/src/interaction/brush-selection.ts Outdated Show resolved Hide resolved

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

packages/s2-react/src/components/sheets/grid-analysis-sheet/index.tsx Show resolved Hide resolved

xingwanying reviewed Dec 5, 2021

View reviewed changes

s2-site/docs/manual/basic/tooltip.zh.md Show resolved Hide resolved

lijinke666 added 3 commits December 6, 2021 10:59

feat(tooltip): update docs

eca8f23

feat(tooltip): support config corner and rename cell => data

8ec9aac

feat(tooltip): update docs

20ac4b7

xingwanying approved these changes Dec 6, 2021

View reviewed changes

xingwanying merged commit 9e411b5 into master Dec 6, 2021

xingwanying deleted the enhance-tooltip branch December 6, 2021 05:40

github-actions bot added the released label Dec 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tooltip): enhance tooltip#862

feat(tooltip): enhance tooltip#862
xingwanying merged 10 commits intomasterfrom
enhance-tooltip

lijinke666 commented Dec 3, 2021 •

edited

Loading

Uh oh!

github-actions bot commented Dec 3, 2021 •

edited

Loading

Uh oh!

github-actions bot commented Dec 3, 2021 •

edited

Loading

Uh oh!

github-actions bot commented Dec 3, 2021 •

edited

Loading

Uh oh!

codecov bot commented Dec 3, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xingwanying commented Dec 5, 2021

Uh oh!

Uh oh!

lijinke666 commented Dec 6, 2021

Uh oh!

xingwanying left a comment

Uh oh!

github-actions bot commented Dec 6, 2021

Uh oh!

github-actions bot commented Dec 6, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

lijinke666 commented Dec 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

👀 PR includes

📝 Description

🖼️ Screenshot

🔗 Related issue link

🔍 Self Check before Merge

Uh oh!

github-actions bot commented Dec 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xingwanying commented Dec 5, 2021

Uh oh!

Uh oh!

lijinke666 commented Dec 6, 2021

Uh oh!

xingwanying left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 6, 2021

Uh oh!

github-actions bot commented Dec 6, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lijinke666 commented Dec 3, 2021 •

edited

Loading

github-actions bot commented Dec 3, 2021 •

edited

Loading

github-actions bot commented Dec 3, 2021 •

edited

Loading

github-actions bot commented Dec 3, 2021 •

edited

Loading

codecov bot commented Dec 3, 2021 •

edited

Loading