Skip to content

Dialog - Fix Unimplemented TransitionEnd Event #2299

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
merged 4 commits into from
Feb 15, 2022
Merged

Dialog - Fix Unimplemented TransitionEnd Event #2299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05b2f2e
fire transition callbacks when not support event
bartoszlorek Feb 12, 2022
77f1f28
add more callback tests
bartoszlorek Feb 12, 2022
64be9a9
rename
bartoszlorek Feb 12, 2022
3d4d0b6
Merge branch 'master' into dialog-fix-unimplemented-transition-end-event
bartoszlorek Feb 15, 2022
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
58 changes: 35 additions & 23 deletions src/components/dialog/Dialog.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import cx from 'classnames';
import {useBodyNoScroll} from './useBodyNoScroll';
import {useFocusTrap} from './useFocusTrap';

// https://github.com/jsdom/jsdom/issues/1781
const supportsTransitions = window.TransitionEvent !== undefined;

export type DialogPropsType = $ReadOnly<{
open: boolean,
children: React.Node,
Expand Down Expand Up @@ -78,44 +81,53 @@ function BaseDialog({
*/
const [deferredOpen, setDeferredOpen] = React.useState<boolean>(false);

const fireTransitionEndCallbacks = React.useCallback(() => {
if (open) {
if (onEntryTransitionEnd) {
onEntryTransitionEnd();
}
} else if (onExitTransitionEnd) {
onExitTransitionEnd();
}
}, [open, onEntryTransitionEnd, onExitTransitionEnd]);

React.useEffect(() => {
setDeferredOpen(open);
}, [open]);

useBodyNoScroll();
useFocusTrap({dialogRef: containerRef, overlayRef});
if (!supportsTransitions) {
fireTransitionEndCallbacks();
}
}, [open, fireTransitionEndCallbacks]);

const handleOverlayClick = React.useCallback(
(event: SyntheticMouseEvent<HTMLDivElement>) => {
if (onDismiss && event.target === event.currentTarget) {
onDismiss();
}
},
[onDismiss]
);
useBodyNoScroll();
useFocusTrap({
dialogRef: containerRef,
overlayRef,
});

const handleTransitionEnd = React.useCallback(
(event: TransitionEvent) => {
if (
event.target !== event.currentTarget ||
event.propertyName !== lastTransitionName
event.target === event.currentTarget &&
event.propertyName === lastTransitionName
) {
return;
fireTransitionEndCallbacks();
}
},
[fireTransitionEndCallbacks, lastTransitionName]
);

if (open) {
if (onEntryTransitionEnd) {
onEntryTransitionEnd();
}
} else if (onExitTransitionEnd) {
onExitTransitionEnd();
const handleOverlayClick = React.useCallback(
(event: SyntheticMouseEvent<HTMLDivElement>) => {
if (onDismiss && event.target === event.currentTarget) {
onDismiss();
}
},
[open, lastTransitionName, onEntryTransitionEnd, onExitTransitionEnd]
[onDismiss]
);

const handleKeyUp = React.useCallback(
event => {
(event: SyntheticKeyboardEvent<HTMLDivElement>) => {
if (onDismiss && event.key === 'Escape') {
onDismiss();
event.stopPropagation();
Expand Down Expand Up @@ -158,7 +170,7 @@ function BaseDialog({
role="dialog"
ref={containerRef}
className={containerClass}
onTransitionEnd={handleTransitionEnd}
onTransitionEnd={supportsTransitions ? handleTransitionEnd : undefined}
aria-modal="true"
aria-labelledby={ariaLabelledBy}
aria-label={ariaLabel}
Expand Down
40 changes: 27 additions & 13 deletions src/components/dialog/Dialog.spec.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ describe('<Dialog>', () => {

it('fires onDismiss callback on Escape key', () => {
const onDismiss = jest.fn();

const wrapper = mount(
<Dialog onDismiss={onDismiss} open>
content text
Expand All @@ -68,16 +67,13 @@ describe('<Dialog>', () => {

it('fires onEntryTransitionEnd callback on entry', () => {
const onEntryTransitionEnd = jest.fn();
const wrapper = mount(

mount(
<Dialog onEntryTransitionEnd={onEntryTransitionEnd} open>
content text
</Dialog>
);

wrapper.find('[role="dialog"]').simulate('transitionEnd', {
propertyName: 'transform',
});
Comment on lines -77 to -79
Copy link
Contributor Author

Choose a reason for hiding this comment

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

...and the simulation is no longer needed to just open/close a dialog.


expect(onEntryTransitionEnd).toHaveBeenCalledTimes(1);
});

Expand All @@ -90,22 +86,40 @@ describe('<Dialog>', () => {
);

wrapper.setProps({open: false});
wrapper.find('[role="dialog"]').simulate('transitionEnd', {
propertyName: 'opacity',
});

expect(onExitTransitionEnd).toHaveBeenCalledTimes(1);
});

it('does not fire onEntryTransitionEnd callback before open', () => {
const onEntryTransitionEnd = jest.fn();

mount(
<Dialog onEntryTransitionEnd={onEntryTransitionEnd} open={false}>
content text
</Dialog>
);

expect(onEntryTransitionEnd).toHaveBeenCalledTimes(0);
});

it('does not fire onExitTransitionEnd callback before open', () => {
const onExitTransitionEnd = jest.fn();

mount(
<Dialog onExitTransitionEnd={onExitTransitionEnd} open={false}>
content text
</Dialog>
);

expect(onExitTransitionEnd).toHaveBeenCalledTimes(0);
});

it('returns null after exit transition', () => {
const wrapper = mount(<Dialog open>content text</Dialog>);

expect(wrapper.isEmptyRender()).toBe(false);

wrapper.setProps({open: false});
wrapper.find('[role="dialog"]').simulate('transitionEnd', {
propertyName: 'opacity',
});
wrapper.update();

expect(wrapper.isEmptyRender()).toBe(true);
});
Expand Down