mirror of
https://github.com/pybricks/pybricks-code.git
synced 2026-09-12 09:36:27 +00:00
"@blueprintjs/core": "^3.53.0"
This allows us to drop the monkey patch to work around an upstream bug.
This commit is contained in:
@@ -1,73 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT
|
||||
// Copyright (c) 2021 The Pybricks Authors
|
||||
|
||||
import { Button, IRef } from '@blueprintjs/core';
|
||||
import { Tooltip2 } from '@blueprintjs/popover2';
|
||||
import {
|
||||
fireEvent,
|
||||
render,
|
||||
screen,
|
||||
waitFor,
|
||||
waitForElementToBeRemoved,
|
||||
} from '@testing-library/react';
|
||||
import userEvent from '@testing-library/user-event';
|
||||
import React from 'react';
|
||||
import { useTooltip2MonkeyPatch } from './monkey-patch';
|
||||
|
||||
const testTooltipText = 'Test tooltip.';
|
||||
const testButtonId = 'test-button';
|
||||
|
||||
type TestComponentProps = { monkeyPatch: boolean };
|
||||
|
||||
const TestComponent: React.FC<TestComponentProps> = (props) => {
|
||||
const tooltipRef = props.monkeyPatch ? useTooltip2MonkeyPatch() : undefined;
|
||||
|
||||
return (
|
||||
<Tooltip2
|
||||
ref={tooltipRef}
|
||||
content={testTooltipText}
|
||||
renderTarget={({
|
||||
ref: tooltipTargetRef,
|
||||
isOpen: _tooltipIsOpen,
|
||||
...tooltipTargetProps
|
||||
}) => (
|
||||
<Button
|
||||
data-testid={testButtonId}
|
||||
elementRef={tooltipTargetRef as IRef<HTMLButtonElement>}
|
||||
{...tooltipTargetProps}
|
||||
>
|
||||
Press Me!
|
||||
</Button>
|
||||
)}
|
||||
/>
|
||||
);
|
||||
};
|
||||
|
||||
it.each([false, true])(
|
||||
'should work around https://github.com/palantir/blueprint/issues/4503',
|
||||
async (monkeyPatch) => {
|
||||
render(<TestComponent monkeyPatch={monkeyPatch} />);
|
||||
|
||||
expect(screen.queryByText(testTooltipText)).not.toBeInTheDocument();
|
||||
|
||||
// pressing the tab key should focus the button and open the tooltip
|
||||
userEvent.tab();
|
||||
|
||||
await waitFor(() => {
|
||||
expect(screen.getByText(testTooltipText)).toBeInTheDocument();
|
||||
});
|
||||
|
||||
// a blur event with renderTarget=null should trigger the bug and workaround
|
||||
fireEvent.blur(screen.getByTestId(testButtonId));
|
||||
|
||||
if (monkeyPatch) {
|
||||
// if the patch was applied, there should not be any error
|
||||
await waitForElementToBeRemoved(screen.getByText(testTooltipText));
|
||||
} else {
|
||||
// if the patch was not applied, the bug should be triggered
|
||||
await expect(
|
||||
waitForElementToBeRemoved(screen.getByText(testTooltipText)),
|
||||
).rejects.toBeInstanceOf(Error);
|
||||
}
|
||||
},
|
||||
);
|
||||
@@ -1,70 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT
|
||||
// Copyright (c) 2021 The Pybricks Authors
|
||||
|
||||
import { Tooltip2 } from '@blueprintjs/popover2';
|
||||
import React, { useEffect, useRef } from 'react';
|
||||
|
||||
/** Hack to access private members of Popover2. */
|
||||
interface Popover2Private {
|
||||
handleTargetBlur: (e: React.FocusEvent<HTMLElement>) => void;
|
||||
handleMouseLeave: (e: React.MouseEvent<HTMLElement>) => void;
|
||||
}
|
||||
/** Hack to access private members of Tooltip2. */
|
||||
interface Tooltip2Private {
|
||||
popover: Popover2Private;
|
||||
}
|
||||
|
||||
/**
|
||||
* Monkey patch Popover2 blur event handler to make tooltips close when
|
||||
* focus is lost.
|
||||
*
|
||||
* https://github.com/palantir/blueprint/issues/4503
|
||||
*
|
||||
* @returns A React ref to be attached to the Tooltip2 component.
|
||||
*/
|
||||
export function useTooltip2MonkeyPatch<T>(): React.RefObject<Tooltip2<T>> {
|
||||
const tooltipRef = useRef<Tooltip2<T>>(null);
|
||||
|
||||
useEffect(() => {
|
||||
// istanbul ignore if: should not happen ever
|
||||
if (!tooltipRef.current) {
|
||||
return;
|
||||
}
|
||||
|
||||
const tooltip = tooltipRef.current as unknown as Tooltip2Private;
|
||||
|
||||
const oldHandleTargetBlur = tooltip.popover.handleTargetBlur;
|
||||
|
||||
tooltip.popover.handleTargetBlur = (e) => {
|
||||
if (e.relatedTarget) {
|
||||
oldHandleTargetBlur(e);
|
||||
} else {
|
||||
closeTooltip2(tooltipRef);
|
||||
}
|
||||
};
|
||||
|
||||
return () => {
|
||||
tooltip.popover.handleTargetBlur = oldHandleTargetBlur;
|
||||
};
|
||||
}, [tooltipRef]);
|
||||
|
||||
return tooltipRef;
|
||||
}
|
||||
|
||||
/**
|
||||
* Hack to access private members of Tooltip2 to programmatically close the tooltip.
|
||||
* @param tooltipRef The reference returned from useTooltip2MonkeyPatch()
|
||||
*/
|
||||
export function closeTooltip2<T>(tooltipRef: React.RefObject<Tooltip2<T>>): void {
|
||||
// istanbul ignore if: should not happen ever
|
||||
if (!tooltipRef.current) {
|
||||
return;
|
||||
}
|
||||
|
||||
const tooltip = tooltipRef.current as unknown as Tooltip2Private;
|
||||
|
||||
// Currently, the event arg is not used so it should be safe to pass undefined.
|
||||
tooltip.popover.handleMouseLeave(
|
||||
undefined as unknown as React.MouseEvent<HTMLElement>,
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user