feat(tooltip): add `appendTo` option to allow customizing tooltip container #18436

viking7982 · 2023-03-28T14:56:21Z

Brief Information

This pull request is in the type of:

bug fixing
new feature
others

What does this PR do?

允许用户指定tooltip的容器

Fixed issues

[Feature] 指定Tooltip的父节点 #18435

Details

Before: What was the problem?

Tooltip只能插入到在当前DOM节点或者document.body中

After: How does it behave after the fixing?

用户可以指定tooltip的父节点

Document Info

One of the following should be checked.

This PR doesn't relate to document changes
The document should be updated later
The document changes have been made in doc: add doc for 5.5.0 pull requets echarts-doc#384

Misc

ZRender Changes

This PR depends on ZRender changes (ecomfe/zrender#xxx).

Related test cases or examples to use the new APIs

N.A.

Others

Merging options

Please squash the commits into a single one when merging.

Other information

echarts-bot · 2023-03-28T14:56:28Z

Thanks for your contribution!
The community will review it ASAP. In the meanwhile, please checkout the coding standard and Wiki about How to make a pull request.

Document changes are required in this PR. Please also make a PR to apache/echarts-doc for document changes and update the issue id in the PR description. When the doc PR is merged, the maintainers will remove the PR: awaiting doc label.

src/component/tooltip/TooltipHTMLContent.ts

…ainer => container

plainheart

Thanks for your contribution! I've left some comments. BTW, it would be better to add some test cases for this feature.

src/component/tooltip/TooltipModel.ts

src/component/tooltip/TooltipView.ts

src/component/tooltip/TooltipModel.ts

src/component/tooltip/TooltipHTMLContent.ts

…ainer => container

src/component/tooltip/TooltipHTMLContent.ts

plainheart · 2023-04-03T11:50:17Z

@viking7982 It looks good to me. As the tooltip is appended to a scrollable container with a fixed height #config and its overflow is not set to be visible, so it's partially hidden.

src/component/tooltip/TooltipHTMLContent.ts

viking7982 · 2023-05-15T07:04:48Z

@plainheart Hi. What is the current status for this pr?

plainheart · 2023-05-15T07:15:47Z

@viking7982 I'll take some time to review it again later, and merge it if there are no problems. It would be better if any other maintainer could leave their comments.

viking7982 · 2023-05-15T10:25:07Z

@plainheart Got it. Thanks~

src/component/tooltip/TooltipHTMLContent.ts

src/component/tooltip/TooltipModel.ts

github-actions · 2023-09-02T07:02:56Z

The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-18436@2864cd1

…ip-container

…ing or null

echarts-bot · 2023-09-02T09:01:17Z

Congratulations! Your PR has been merged. Thanks for your contribution! 👍

Ovilia · 2024-02-01T11:13:37Z

src/component/tooltip/TooltipModel.ts

-     * If append popup dom to document.body
-     * Only available when renderMode is html
+     * @deprecated
+     * use appendTo: 'body' instead
     */
    appendToBody?: boolean


Since the implementation of appendToBody is totally removed from the source code, it's better to remove this option instead of making it deprecated. This should be fixed in the future versions.

@Ovilia The appendToBody option is not removed yet. See https://github.com/apache/echarts/pull/18436/files#diff-c4bf8caece88579c9e2ae0092955d9505397b706065a6dce98f5b74c7c7209baR175.

@plainheart OK. Thanks for correcting.

feat: allow customed tooltip container

c4efc1f

echarts-bot bot added PR: awaiting doc Document changes is required for this PR. PR: awaiting review PR: first-time contributor labels Mar 28, 2023

pull-request-size bot added the size/M label Mar 28, 2023

plainheart added the discussion-required Further discussion is required before we decide if this issue should be fixed. label Mar 28, 2023

plainheart reviewed Mar 28, 2023

View reviewed changes

src/component/tooltip/TooltipHTMLContent.ts Outdated Show resolved Hide resolved

危翰 added 3 commits March 29, 2023 15:51

refactor: rename variables: getAppendElement => teleport & customCont…

e188b20

…ainer => container

feat: support 3 options to locale the tooltip container

92bcf21

refactor: rename customContainer to container

723e13b

viking7982 requested review from plainheart and Ovilia March 31, 2023 10:49

fix: add model params name

a1b9d0f

plainheart added this to the 5.5.0 milestone Apr 2, 2023

plainheart requested changes Apr 3, 2023

View reviewed changes

echarts-bot bot added PR: revision needed PR: awaiting review and removed PR: awaiting review PR: revision needed labels Apr 3, 2023

pull-request-size bot added size/L and removed size/M labels Apr 3, 2023

refactor: rename variables: getAppendElement => teleport & customCont…

19f68c5

…ainer => container

viking7982 force-pushed the tooltip-container branch from 7cd4240 to 19f68c5 Compare April 3, 2023 04:23

pull-request-size bot added size/M and removed size/L labels Apr 3, 2023

危翰 added 2 commits April 3, 2023 12:39

refactor: update based on cr

77e48e4

fix: add missing variable

d038881

plainheart reviewed Apr 3, 2023

View reviewed changes

src/component/tooltip/TooltipHTMLContent.ts Outdated Show resolved Hide resolved

src/component/tooltip/TooltipHTMLContent.ts Show resolved Hide resolved

src/component/tooltip/TooltipHTMLContent.ts Show resolved Hide resolved

test: add test case for appendTo

eb8793f

plainheart reviewed Apr 4, 2023

View reviewed changes

src/component/tooltip/TooltipHTMLContent.ts Outdated Show resolved Hide resolved

plainheart changed the title ~~feat: allow customed tooltip container~~ feat(tooltip): add appendTo option to allow customized tooltip container Apr 4, 2023

refactor: rename element name

6ecd62b

viking7982 requested a review from plainheart April 7, 2023 02:18

plainheart mentioned this pull request Aug 6, 2023

[Bug] Tooltip not shown on fullscreen #18944

Closed

plainheart reviewed Aug 7, 2023

View reviewed changes

src/component/tooltip/TooltipHTMLContent.ts Show resolved Hide resolved

src/component/tooltip/TooltipModel.ts Outdated Show resolved Hide resolved

fix: clearing the _container & el in the dispose function

368d0a8

viking7982 force-pushed the tooltip-container branch from ae8cf31 to 368d0a8 Compare August 8, 2023 14:34

fix: chartContainer always exists

7df2718

viking7982 requested a review from plainheart September 2, 2023 05:06

plainheart added 3 commits September 2, 2023 15:56

test: tweak test case

757877e

Merge branch 'master' of https://github.com/apache/echarts into toolt…

8d7aa91

…ip-container

chore: tweak comment

de730f9

plainheart changed the title ~~feat(tooltip): add appendTo option to allow customized tooltip container~~ feat(tooltip): add appendTo option to allow customizing tooltip container Sep 2, 2023

plainheart added 2 commits September 2, 2023 16:30

fix(tooltip): fix potential exception when appendTo is an empty string

fd4ef78

fix(tooltip): fix potential exception when appendTo is an empty str…

2864cd1

…ing or null

plainheart approved these changes Sep 2, 2023

View reviewed changes

echarts-bot bot removed the PR: awaiting review label Sep 2, 2023

plainheart merged commit 428e2ad into apache:master Sep 2, 2023
2 checks passed

plainheart removed the discussion-required Further discussion is required before we decide if this issue should be fixed. label Sep 2, 2023

Ovilia reviewed Feb 1, 2024

View reviewed changes

Ovilia added a commit to apache/echarts-doc that referenced this pull request Feb 2, 2024

doc: add doc for apache/echarts#18436

3d7d72d

echarts-bot bot added PR: doc ready and removed PR: awaiting doc Document changes is required for this PR. labels Feb 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(tooltip): add `appendTo` option to allow customizing tooltip container #18436

feat(tooltip): add `appendTo` option to allow customizing tooltip container #18436

viking7982 commented Mar 28, 2023 •

edited by Ovilia

echarts-bot bot commented Mar 28, 2023

plainheart left a comment

plainheart commented Apr 3, 2023 •

edited

viking7982 commented May 15, 2023

plainheart commented May 15, 2023

viking7982 commented May 15, 2023

github-actions bot commented Sep 2, 2023 •

edited

echarts-bot bot commented Sep 2, 2023

Ovilia Feb 1, 2024

plainheart Feb 1, 2024

Ovilia Feb 2, 2024

feat(tooltip): add appendTo option to allow customizing tooltip container #18436

feat(tooltip): add appendTo option to allow customizing tooltip container #18436

Conversation

viking7982 commented Mar 28, 2023 • edited by Ovilia

Brief Information

What does this PR do?

Fixed issues

Details

Before: What was the problem?

After: How does it behave after the fixing?

Document Info

Misc

ZRender Changes

Related test cases or examples to use the new APIs

Others

Merging options

Other information

echarts-bot bot commented Mar 28, 2023

plainheart left a comment

Choose a reason for hiding this comment

plainheart commented Apr 3, 2023 • edited

viking7982 commented May 15, 2023

plainheart commented May 15, 2023

viking7982 commented May 15, 2023

github-actions bot commented Sep 2, 2023 • edited

echarts-bot bot commented Sep 2, 2023

Ovilia Feb 1, 2024

Choose a reason for hiding this comment

plainheart Feb 1, 2024

Choose a reason for hiding this comment

Ovilia Feb 2, 2024

Choose a reason for hiding this comment

feat(tooltip): add `appendTo` option to allow customizing tooltip container #18436

feat(tooltip): add `appendTo` option to allow customizing tooltip container #18436

viking7982 commented Mar 28, 2023 •

edited by Ovilia

plainheart commented Apr 3, 2023 •

edited

github-actions bot commented Sep 2, 2023 •

edited