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

Jump to bottom

fix: Merge mouseleave detection logic #1374

Merged
merged 1 commit into from
Jul 28, 2023
Merged

fix: Merge mouseleave detection logic #1374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/internal/components/chart-popover/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ function ChartPopover(
return (
<div
{...baseProps}
className={clsx(popoverStyles.root, styles.root, baseProps.className, { [styles.dismissable]: dismissButton })}
className={clsx(popoverStyles.root, styles.root, baseProps.className)}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

styles.dismissible does not exist and this renders className="undefined"

ref={popoverRef}
onMouseEnter={onMouseEnter}
onMouseLeave={onMouseLeave}
Expand Down
8 changes: 8 additions & 0 deletions src/internal/utils/__tests__/dom.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,12 @@ describe('nodeContains', () => {
expect(nodeContains(null, null)).toBe(false);
});

test('returns false if descendant is not a valid node', () => {
const div = document.createElement('div');
expect(nodeContains(div, window)).toBe(false);
expect(nodeContains(div, new EventTarget())).toBe(false);
});

const testCases: Record<string, string> = {
regular: `<div id="parent">
<div id="inbetween">
Expand Down Expand Up @@ -149,6 +155,8 @@ describe('nodeContains', () => {
const inbetween = div.querySelector('#inbetween');
const child = div.querySelector('#child');

expect(nodeContains(parent, parent)).toBe(true);
expect(nodeContains(child, child)).toBe(true);
expect(nodeContains(parent, child)).toBe(true);
expect(nodeContains(parent, inbetween)).toBe(true);
expect(nodeContains(inbetween, child)).toBe(true);
Expand Down
4 changes: 2 additions & 2 deletions src/internal/utils/dom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ export function parseCssVariable(value: string) {
* @param parent Parent node
* @param descendant Node that is checked to be a descendant of the parent node
*/
export function nodeContains(parent: Node | null, descendant: Node | null) {
if (!parent || !descendant) {
export function nodeContains(parent: Node | null, descendant: Node | EventTarget | null) {
if (!parent || !descendant || !(descendant instanceof Node)) {
Comment on lines +106 to +107
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have many instances of nodeContains(node, event.relatedTarget) which may fail, when target is not a node. Fixed this once for all cases

return false;
}

Expand Down
40 changes: 37 additions & 3 deletions src/pie-chart/__tests__/pie-chart.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,29 @@ describe('Details popover', () => {
expect(detailPopover?.findHeader()?.getElement()).toHaveTextContent(defaultData[0].title);
});

test('allow mouse to be move between segment and popover ', () => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: typo in "to be move" (could be either "to move" or "to be moved" instead)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

grammar is hard. Since this issue is kinda critical, I am going to merge and fix it next time

const { wrapper } = renderPieChart(<PieChart data={defaultData} />);
fireEvent.mouseOver(wrapper!.findSegments()[0].getElement());

expect(wrapper.findDetailPopover()).toBeTruthy();

fireEvent.mouseOut(wrapper.findDetailPopover()!.getElement(), {
relatedTarget: wrapper!.findSegments()[0].getElement(),
});

expect(wrapper.findDetailPopover()).toBeTruthy();

fireEvent.mouseOut(wrapper!.findSegments()[0].getElement(), {
relatedTarget: wrapper.findDetailPopover()!.getElement(),
});

expect(wrapper.findDetailPopover()).toBeTruthy();

fireEvent.mouseOut(wrapper!.findSegments()[0].getElement(), { relatedTarget: window });

expect(wrapper.findDetailPopover()).toBeFalsy();
});

test('close popover when mouse leaves it ', () => {
const { wrapper } = renderPieChart(<PieChart data={defaultData} />);
wrapper.findApplication()!.focus();
Expand Down Expand Up @@ -565,13 +588,24 @@ describe('Details popover', () => {

test('dismisses when clicking same segment', () => {
const { wrapper } = renderPieChart(<PieChart data={defaultData} />);
wrapper.findSegments()[0].click();
expect(wrapper.findDetailPopover()).toBeDefined();

wrapper.findSegments()[0].click();
fireEvent.mouseDown(wrapper.findSegments()[0].getElement());
expect(wrapper.findDetailPopover()).toBeTruthy();

fireEvent.mouseDown(wrapper.findSegments()[0].getElement());
expect(wrapper.findDetailPopover()).toBeNull();
});

test('stays open with mouseleave events when pinned', () => {
const { wrapper } = renderPieChart(<PieChart data={defaultData} />);

fireEvent.mouseDown(wrapper.findSegments()[0].getElement());
expect(wrapper.findDetailPopover()).toBeTruthy();

fireEvent.mouseOut(wrapper.findSegments()[0].getElement());
expect(wrapper.findDetailPopover()).toBeTruthy();
});

test('can be dismissed with click on the dismiss button', () => {
const { wrapper } = renderPieChart(<PieChart data={defaultData} />);
wrapper.findSegments()[1].click();
Expand Down
4 changes: 0 additions & 4 deletions src/pie-chart/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,6 @@ const PieChart = function PieChart<T extends PieChartProps.Datum = PieChartProps
}
);

const [pinnedSegment, setPinnedSegment] = useState<T | null>(null);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not used directly in this component. Moved it down where it is actually used to simplify


const visibleData = useMemo(
() => data.filter(d => visibleSegments?.indexOf(d.datum) !== -1),
[data, visibleSegments]
Expand Down Expand Up @@ -212,8 +210,6 @@ const PieChart = function PieChart<T extends PieChartProps.Datum = PieChartProps
onHighlightChange={onHighlightChange}
highlightedSegment={highlightedSegment}
legendSegment={legendSegment}
pinnedSegment={pinnedSegment}
setPinnedSegment={setPinnedSegment}
detailPopoverSize={detailPopoverSize}
pieData={pieData}
dataSum={dataSum}
Expand Down
43 changes: 19 additions & 24 deletions src/pie-chart/pie-chart.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { nodeBelongs } from '../internal/utils/node-belongs';
import clsx from 'clsx';
import { useVisualRefresh } from '../internal/hooks/use-visual-mode';
import { useHeightMeasure } from '../internal/hooks/container-queries/use-height-measure';
import { nodeContains } from '../internal/utils/dom';

export interface InternalChartDatum<T> {
index: number;
Expand All @@ -42,9 +43,6 @@ interface InternalPieChartProps<T extends PieChartProps.Datum>

legendSegment: T | null;

pinnedSegment: T | null;
setPinnedSegment: React.Dispatch<React.SetStateAction<T | null>>;

pieData: PieArcDatum<InternalChartDatum<T>>[];
dataSum: number;
}
Expand Down Expand Up @@ -76,11 +74,10 @@ export default <T extends PieChartProps.Datum>({
highlightedSegment,
onHighlightChange,
legendSegment,
pinnedSegment,
setPinnedSegment,
pieData,
dataSum,
}: InternalPieChartProps<T>) => {
const [pinnedSegment, setPinnedSegment] = useState<T | null>(null);
const plotRef = useRef<ChartPlotRef>(null);
const containerRef = useRef<HTMLDivElement>(null);
const focusedSegmentRef = useRef<SVGGElement>(null);
Expand Down Expand Up @@ -158,6 +155,21 @@ export default <T extends PieChartProps.Datum>({
onHighlightChange(null);
}, [onHighlightChange, setTooltipOpen]);

const checkMouseLeave = (event: React.MouseEvent) => {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deduplicated onMouseOut and onPopoverLeave in this single handler

if (pinnedSegment !== null) {
return;
}

if (
nodeContains(popoverRef.current, event.relatedTarget) ||
nodeContains(focusedSegmentRef.current, event.relatedTarget)
) {
return;
}

clearHighlightedSegment();
};

useEffect(() => {
const onKeyDown = (event: KeyboardEvent) => {
if (event.key === 'Escape') {
Expand Down Expand Up @@ -194,16 +206,7 @@ export default <T extends PieChartProps.Datum>({
},
[pinnedSegment, highlightSegment]
);
const onMouseOut = useCallback(
(event: React.MouseEvent<SVGElement, MouseEvent>) => {
if (pinnedSegment !== null || popoverRef.current?.contains(event.relatedTarget as Node)) {
return;
}

clearHighlightedSegment();
},
[pinnedSegment, clearHighlightedSegment]
);
const onKeyDown = useCallback(
(event: React.KeyboardEvent) => {
const keyCode = event.keyCode;
Expand Down Expand Up @@ -283,13 +286,6 @@ export default <T extends PieChartProps.Datum>({
}
};

const onPopoverLeave = (event: React.MouseEvent) => {
if (pinnedSegment !== null || focusedSegmentRef.current!.contains(event.relatedTarget as Node)) {
return;
}
clearHighlightedSegment();
};

return (
<div
className={clsx(styles['chart-container'], fitHeight && styles['chart-container--fit-height'])}
Expand Down Expand Up @@ -319,7 +315,7 @@ export default <T extends PieChartProps.Datum>({
onFocus={onFocus}
onBlur={onBlur}
onKeyDown={onKeyDown}
onMouseOut={onMouseOut}
onMouseOut={checkMouseLeave}
>
<Segments
pieData={pieData}
Expand All @@ -331,7 +327,6 @@ export default <T extends PieChartProps.Datum>({
segmentAriaRoleDescription={i18nStrings?.segmentAriaRoleDescription}
onMouseDown={onMouseDown}
onMouseOver={onMouseOver}
onMouseOut={onMouseOut}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is redundant

<ChartPlot onMouseOut={onMouseOut}>
   <Segment onMouseOut={onMouseOut} />
</ChartPlot>

The inner one can be removed

/>
{hasLabels && (
<Labels
Expand Down Expand Up @@ -385,7 +380,7 @@ export default <T extends PieChartProps.Datum>({
onDismiss={onPopoverDismiss}
container={plotRef.current?.svg || null}
size={detailPopoverSize}
onMouseLeave={onPopoverLeave}
onMouseLeave={checkMouseLeave}
>
{tooltipContent}
{detailPopoverFooterContent && <InternalBox margin={{ top: 's' }}>{detailPopoverFooterContent}</InternalBox>}
Expand Down
4 changes: 1 addition & 3 deletions src/pie-chart/segments.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ interface SegmentsProps<T> {
segmentAriaRoleDescription?: string;
onMouseDown: (datum: InternalChartDatum<T>) => void;
onMouseOver: (datum: InternalChartDatum<T>) => void;
onMouseOut: (event: React.MouseEvent<SVGElement>) => void;
}

export default function Segments<T extends PieChartProps.Datum>({
Expand All @@ -33,7 +32,6 @@ export default function Segments<T extends PieChartProps.Datum>({
segmentAriaRoleDescription,
onMouseDown,
onMouseOver,
onMouseOut,
}: SegmentsProps<T>) {
const i18n = useInternalI18n('pie-chart');

Expand Down Expand Up @@ -68,7 +66,7 @@ export default function Segments<T extends PieChartProps.Datum>({
}, [highlightedSegment, pieData, arcFactory]);

return (
<g onMouseLeave={event => onMouseOut(event)}>
<g>
{pieData.map(datum => {
const isHighlighted = highlightedSegment === datum.data.datum;
const isDimmed = highlightedSegment !== null && !isHighlighted;
Expand Down
Loading