Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[charts] Fix ScatterChart tooltip wrong defaults #15537

Merged
merged 2 commits into from
Nov 21, 2024
Merged

[charts] Fix ScatterChart tooltip wrong defaults #15537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36d2997
[charts] Fix `ScatterChart` tooltip being defaulted to `axis`
JCQuintas Nov 21, 2024
79c70ef
add test for scatter tooltip
JCQuintas Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions packages/x-charts/src/ChartsTooltip/contentDisplayed.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import * as React from 'react';
import { expect } from 'chai';
import { createRenderer, fireEvent } from '@mui/internal-test-utils';
import { BarChart } from '@mui/x-charts/BarChart';
import { firePointerEvent } from '../tests/firePointerEvent';

const config = {
dataset: [
Expand Down Expand Up @@ -55,7 +54,7 @@ describe('ChartsTooltip', () => {
const svg = document.querySelector<HTMLElement>('svg')!;

fireEvent.pointerEnter(svg); // Trigger the tooltip
firePointerEvent(svg, 'pointermove', {
fireEvent.pointerMove(svg, {
clientX: 198,
clientY: 60,
});
Expand All @@ -74,7 +73,7 @@ describe('ChartsTooltip', () => {
'2',
]);

firePointerEvent(svg, 'pointermove', {
fireEvent.pointerMove(svg, {
clientX: 201,
clientY: 60,
});
Expand Down Expand Up @@ -122,7 +121,7 @@ describe('ChartsTooltip', () => {
const svg = document.querySelector<HTMLElement>('svg')!;

fireEvent.pointerEnter(svg); // Trigger the tooltip
firePointerEvent(svg, 'pointermove', {
fireEvent.pointerMove(svg, {
clientX: 150,
clientY: 60,
});
Expand All @@ -141,7 +140,7 @@ describe('ChartsTooltip', () => {
'2',
]);

firePointerEvent(svg, 'pointermove', {
fireEvent.pointerMove(svg, {
clientX: 150,
clientY: 220,
});
Expand Down Expand Up @@ -194,7 +193,7 @@ describe('ChartsTooltip', () => {
fireEvent.pointerEnter(rectangles[0]);

fireEvent.pointerEnter(svg); // Trigger the tooltip
firePointerEvent(svg, 'pointermove', {
fireEvent.pointerMove(svg, {
clientX: 150,
clientY: 60,
}); // Only to set the tooltip position
Expand Down Expand Up @@ -239,7 +238,7 @@ describe('ChartsTooltip', () => {
fireEvent.pointerEnter(rectangles[0]);

fireEvent.pointerEnter(svg); // Trigger the tooltip
firePointerEvent(svg, 'pointermove', {
fireEvent.pointerMove(svg, {
clientX: 150,
clientY: 60,
}); // Only to set the tooltip position
Expand Down
50 changes: 49 additions & 1 deletion packages/x-charts/src/ScatterChart/ScatterChart.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import * as React from 'react';
import { createRenderer } from '@mui/internal-test-utils/createRenderer';
import { createRenderer, fireEvent } from '@mui/internal-test-utils/createRenderer';
import { describeConformance } from 'test/utils/describeConformance';
import { ScatterChart } from '@mui/x-charts/ScatterChart';
import { expect } from 'chai';

const isJSDOM = /jsdom/.test(window.navigator.userAgent);

describe('<ScatterChart />', () => {
const { render } = createRenderer();
Expand Down Expand Up @@ -38,4 +41,49 @@ describe('<ScatterChart />', () => {
],
}),
);

const config = {
dataset: [
{ id: 1, x: 0, y: 10 },
{ id: 2, x: 10, y: 10 },
{ id: 3, x: 10, y: 0 },
{ id: 4, x: 0, y: 0 },
{ id: 5, x: 5, y: 5 },
],
margin: { top: 0, left: 0, bottom: 0, right: 0 },
width: 100,
height: 100,
};

it('should show the tooltip without errors in default config', function test() {
if (isJSDOM) {
// svg.createSVGPoint not supported by JSDom https://github.com/jsdom/jsdom/issues/300
this.skip();
}
render(
<div
style={{
margin: -8, // Removes the body default margins
width: 100,
height: 100,
}}
>
<ScatterChart {...config} series={[{ id: 's1', data: config.dataset }]} />
</div>,
);
const svg = document.querySelector<HTMLElement>('svg')!;
const marks = document.querySelectorAll<HTMLElement>('circle');

fireEvent.pointerEnter(marks[0]);

fireEvent.pointerEnter(svg); // Trigger the tooltip
fireEvent.pointerMove(marks[0]); // Only to set the tooltip position

let cells = document.querySelectorAll<HTMLElement>('.MuiChartsTooltip-root td');
expect([...cells].map((cell) => cell.textContent)).to.deep.equal(['', '', '(0, 10)']);

fireEvent.pointerEnter(marks[4]);
cells = document.querySelectorAll<HTMLElement>('.MuiChartsTooltip-root td');
expect([...cells].map((cell) => cell.textContent)).to.deep.equal(['', '', '(5, 5)']);
});
});
2 changes: 1 addition & 1 deletion packages/x-charts/src/ScatterChart/ScatterChart.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ const ScatterChart = React.forwardRef(function ScatterChart(
<ChartsOverlay {...overlayProps} />
{!props.hideLegend && <ChartsLegend {...legendProps} />}
<ChartsAxisHighlight {...axisHighlightProps} />
{!props.loading && <Tooltip {...props.slotProps?.tooltip} />}
{!props.loading && <Tooltip trigger="item" {...props.slotProps?.tooltip} />}
{children}
</ZAxisContextProvider>
</ChartContainer>
Expand Down