Skip to content

fix(react-utilities): useOnClickOutside should consider text selection from inside to outside as inside click #28765

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

Merged
YuanboXue-Amber merged 8 commits into from
Aug 23, 2023
Merged

fix(react-utilities): useOnClickOutside should consider text selection from inside to outside as inside click #28765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e2d1cc7
fix
YuanboXue-Amber Aug 7, 2023
75c9b9b
remove click to keep pr only about selection
YuanboXue-Amber Aug 8, 2023
bb2c160
chg
YuanboXue-Amber Aug 8, 2023
3c5eed7
test
YuanboXue-Amber Aug 8, 2023
bb9d91e
test
YuanboXue-Amber Aug 8, 2023
aea50e7
try suggestion
YuanboXue-Amber Aug 9, 2023
8c5c523
cleanup
YuanboXue-Amber Aug 23, 2023
f4c2233
Merge branch 'master' into drag-scroll
ling1726 Aug 23, 2023
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
7 changes: 7 additions & 0 deletions change/@fluentui-react-utilities-62a5aa48-dba4-4ff0-974d-d5ea0a87b2fc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "fix: `useOnClickOutside` should consider text selection starting inside and finishing outside as an inside click",
"packageName": "@fluentui/react-utilities",
"email": "yuanboxue@microsoft.com",
"dependentChangeType": "patch"
}
17 changes: 17 additions & 0 deletions packages/react-components/react-utilities/src/hooks/useOnClickOutside.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,21 @@ describe('useOnClickOutside', () => {
expect(onOutsideClick).to.be.calledTwice;
});
});

it('should not call callback with inside text selection finishing outside', () => {
const onOutsideClick = cy.spy();

mount(<Example useShadowDOM={false} onOutsideClick={onOutsideClick} />);

cy.get('#inside-button')
.trigger('mousedown', { which: 1 })
.trigger('mousemove')
.get('#outside-buttonA')
.trigger('mousemove')
.trigger('mouseup')
.trigger('click')
.then(() => {
expect(onOutsideClick).to.not.be.called;
});
});
});
6 changes: 3 additions & 3 deletions packages/react-components/react-utilities/src/hooks/useOnClickOutside.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ describe('useOnClickOutside', () => {
jest.useRealTimers();
});

const supportedEvents = ['click', 'touchstart', 'contextmenu', 'fuiframefocus'];
const supportedEvents = ['click', 'touchstart', 'contextmenu', 'fuiframefocus', 'mousedown'];

it.each(supportedEvents)('should add %s listener', event => {
// Arrange
Expand All @@ -16,7 +16,7 @@ describe('useOnClickOutside', () => {
renderHook(() => useOnClickOutside({ element, callback: jest.fn(), refs: [] }));

// Assert
expect(element.addEventListener).toHaveBeenCalledTimes(4);
expect(element.addEventListener).toHaveBeenCalledTimes(supportedEvents.length);
expect(element.addEventListener).toHaveBeenCalledWith(event, expect.anything(), true);
});

Expand All @@ -29,7 +29,7 @@ describe('useOnClickOutside', () => {
unmount();

// Assert
expect(element.removeEventListener).toHaveBeenCalledTimes(4);
expect(element.removeEventListener).toHaveBeenCalledTimes(supportedEvents.length);
expect(element.removeEventListener).toHaveBeenCalledWith(event, expect.anything(), true);
});

Expand Down
22 changes: 19 additions & 3 deletions packages/react-components/react-utilities/src/hooks/useOnClickOutside.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,16 @@ export const useOnClickOutside = (options: UseOnClickOrScrollOutsideOptions) =>
const timeoutId = React.useRef<number | undefined>(undefined);
useIFrameFocus(options);

const isMouseDownInsideRef = React.useRef(false);

const contains: UseOnClickOrScrollOutsideOptions['contains'] =
containsProp || ((parent, child) => !!parent?.contains(child));

const listener = useEventCallback((ev: MouseEvent | TouchEvent) => {
const contains: UseOnClickOrScrollOutsideOptions['contains'] =
containsProp || ((parent, child) => !!parent?.contains(child));
if (isMouseDownInsideRef.current) {
isMouseDownInsideRef.current = false;
return;
}

const target = ev.composedPath()[0] as HTMLElement;
const isOutside = refs.every(ref => !contains(ref.current || null, target));
Expand All @@ -54,6 +61,13 @@ export const useOnClickOutside = (options: UseOnClickOrScrollOutsideOptions) =>
}
});

const handleMouseDown = useEventCallback((ev: MouseEvent) => {
// Selecting text from inside to outside will rigger click event.
// In this case click event target is outside but mouse down event target is inside.
// And this click event should be considered as inside click.
isMouseDownInsideRef.current = refs.some(ref => contains(ref.current || null, ev.target as HTMLElement));
});

React.useEffect(() => {
if (disabled) {
return;
Expand All @@ -78,6 +92,7 @@ export const useOnClickOutside = (options: UseOnClickOrScrollOutsideOptions) =>
element?.addEventListener('click', conditionalHandler, true);
element?.addEventListener('touchstart', conditionalHandler, true);
element?.addEventListener('contextmenu', conditionalHandler, true);
element?.addEventListener('mousedown', handleMouseDown, true);

// Garbage collect this event after it's no longer useful to avoid memory leaks
timeoutId.current = window.setTimeout(() => {
Expand All @@ -88,11 +103,12 @@ export const useOnClickOutside = (options: UseOnClickOrScrollOutsideOptions) =>
element?.removeEventListener('click', conditionalHandler, true);
element?.removeEventListener('touchstart', conditionalHandler, true);
element?.removeEventListener('contextmenu', conditionalHandler, true);
element?.removeEventListener('mousedown', handleMouseDown, true);

clearTimeout(timeoutId.current);
currentEvent = undefined;
};
}, [listener, element, disabled]);
}, [listener, element, disabled, handleMouseDown]);
};

const getWindowEvent = (target: Node | Window): Event | undefined => {
Expand Down