LG-4580: tooltip pinning #2837
Open
LG-4580: tooltip pinning #2837
+521
−158
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…heck, add options to off/on callbacks, and add showTooltip callback
…ltipVisibility hook
🦋 Changeset detectedLatest commit: a892fcd The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Size Change: +1.61 kB (+0.11%) Total Size: 1.5 MB
ℹ️ View Unchanged
|
stephl3
force-pushed
the
steph/ch-tooltip-pinning
branch
from
56c6da7 to
b12995e
Compare
stephl3
commented
May 2, 2025
| @@ -27,14 +29,13 @@ | |||
| "@lg-charts/colors": "workspace:^", | |||
| "@lg-charts/series-provider": "workspace:^", | |||
| "echarts": "^5.5.1", | |||
| "lodash.debounce": "^4.0.8" | |||
There was a problem hiding this comment.
removed debounce in previous PR but forgot to drop this dep
| }); | ||
| } | ||
| }, [echart, hideTooltip, off, on, ready]); | ||
| const { tooltipPinned, setTooltipMounted } = useTooltipVisibility({ echart }); |
There was a problem hiding this comment.
abstracted all tooltip visibility logic into useTooltipVisibility hook
| @@ -50,14 +55,25 @@ export function CustomTooltip({ | |||
| } | |||
|
|
|||
| return ( | |||
| <div className={getContainerStyles(theme)}> | |||
There was a problem hiding this comment.
moved container styles up to the echarts tooltip root because this isn't reactive to theme changes
Comment on lines
+105
to
+110
| options?: Partial<{ useCanvasAsTrigger: boolean }>, | ||
| ): void; | ||
| ( | ||
| event: 'zoomselect', | ||
| callback: (params: EChartZoomSelectionEvent) => void, | ||
| options?: Partial<{ useCanvasAsTrigger: boolean }>, |
There was a problem hiding this comment.
open to feedback on naming here. this will make sure the event listener is attached to the full canvas
https://echarts.apache.org/en/tutorial.html#Events%20and%20Actions%20in%20ECharts
| @@ -171,7 +171,7 @@ export function useEchart({ | |||
| const isZoomed = params?.start !== 0 || params?.end !== 100; | |||
|
|
|||
| if (isZoomed) { | |||
| echartsInstance?.dispatchAction({ | |||
| echartsInstance!.dispatchAction({ | |||
There was a problem hiding this comment.
updated these to echartsInstance! because withInstanceCheck has already checked for the existence of an instance
stephl3
commented
May 2, 2025
Comment on lines
+115
to
+124
| if ( | ||
| params.componentType === 'markPoint' || | ||
| params.componentType === 'markLine' | ||
| ) { | ||
| hideTooltip(); | ||
| on(EChartEvents.MouseMove, hideTooltip); | ||
| off(EChartEvents.Click, pinTooltipOnClick, { | ||
| useCanvasAsTrigger: true, | ||
| }); | ||
| } |
There was a problem hiding this comment.
proactively updated this to apply to mark lines as well
…ltip stories, remove console.log
tsck
reviewed
May 2, 2025
There was a problem hiding this comment.
I think there might be some issues with this when multiple charts are rendered: https://642700aa3e49e32bdbf0b0fc-bjcjukghmg.chromatic.com/?path=/story/charts-core--synced-by-group-id
When I keep them synced, the behavior appears a bit erratic:
https://github.com/user-attachments/assets/158141f9-f0fd-47e7-8f20-74ae28e5b572
If I unsync them and just have them both render I'm seeing some z-index issues:
I'm also noticing that sometimes if I move the mouse around enough, one tooltip will become frozen on one chart even though I never clicked and pinned it:
stephl3
force-pushed
the
steph/ch-tooltip-pinning
branch
from
5a638e3 to
5796f15
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✍️ Proposed changes
Primary changes:
ChartTooltipvisibility intouseTooltipVisibilityhookAdditional changes:
echartsInstancein callbacks that are wrappedwithInstanceCheckChartTooltipto useTOOLTIP_IDconstant🎟 Jira ticket: LG-4580
✅ Checklist
For bug fixes, new features & breaking changes
pnpm changesetand documented my changes🧪 How to test changes
WithZoomAndTooltipstory