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

[EuiModal] Permanently fix EuiModal to scroll-jumping issues, remove temporary workaround #6360

Merged
merged 5 commits into from
Nov 16, 2022
Merged

[EuiModal] Permanently fix EuiModal to scroll-jumping issues, remove temporary workaround #6360

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b4394ca
Update react-focus-on
cee-chen Oct 26, 2022
4fc41bf
Remove old scroll workaround and use new react-focus-on API
cee-chen Oct 26, 2022
a65fc62
[misc] remove old/outdated comment
cee-chen Oct 26, 2022
8facecf
changelog
cee-chen Oct 26, 2022
83b8f7d
Update snapshot changes (caused by react-focus-on upgrade?)
cee-chen Nov 14, 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
24 changes: 0 additions & 24 deletions src/components/modal/modal.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
*/

import React from 'react';
import { fireEvent } from '@testing-library/dom';
import { render } from '../../test/rtl';
import { requiredProps } from '../../test';

Expand All @@ -24,27 +23,4 @@ describe('EuiModal', () => {
// NOTE: Using baseElement instead of container is required for components that use portals
expect(baseElement).toMatchSnapshot();
});

// TODO: Remove this onFocus scroll workaround after react-focus-on supports focusOptions
// @see https://github.com/elastic/eui/issues/6304
describe('focus/scroll workaround', () => {
it('scrolls back to the original window position on initial modal focus', () => {
window.scrollTo = jest.fn();

const { getByTestSubject } = render(
<EuiModal data-test-subj="modal" onClose={() => {}}>
children
</EuiModal>
);

// For whatever reason, react-focus-lock doesn't appear to trigger focus in RTL so we'll do it manually
fireEvent.focusIn(getByTestSubject('modal'));
// Confirm that scrolling does not occur more than once
fireEvent.focusIn(getByTestSubject('modal'));
fireEvent.focusIn(getByTestSubject('modal'));

expect(window.scrollTo).toHaveBeenCalledTimes(1);
jest.restoreAllMocks();
});
});
});
23 changes: 2 additions & 21 deletions src/components/modal/modal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,7 @@
* Side Public License, v 1.
*/

import React, {
FunctionComponent,
ReactNode,
HTMLAttributes,
useRef,
useCallback,
} from 'react';
import React, { FunctionComponent, ReactNode, HTMLAttributes } from 'react';
import classnames from 'classnames';

import { keys } from '../../services';
Expand Down Expand Up @@ -58,18 +52,6 @@ export const EuiModal: FunctionComponent<EuiModalProps> = ({
style,
...rest
}) => {
// TODO: Remove this onFocus scroll workaround after react-focus-on supports focusOptions
// @see https://github.com/elastic/eui/issues/6304
const bodyScrollTop = useRef<undefined | number>(
typeof window === 'undefined' ? undefined : window.scrollY // Account for SSR
);
const onFocus = useCallback(() => {
if (bodyScrollTop.current != null) {
window.scrollTo({ top: bodyScrollTop.current });
bodyScrollTop.current = undefined; // Unset after first auto focus
}
}, []);

const onKeyDown = (event: React.KeyboardEvent<HTMLDivElement>) => {
if (event.key === keys.ESCAPE) {
event.preventDefault();
Expand All @@ -91,7 +73,7 @@ export const EuiModal: FunctionComponent<EuiModalProps> = ({

return (
<EuiOverlayMask>
<EuiFocusTrap initialFocus={initialFocus} scrollLock>
<EuiFocusTrap initialFocus={initialFocus} scrollLock preventScrollOnFocus>
Copy link
Contributor

Choose a reason for hiding this comment

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

So clean 🤩

{
// Create a child div instead of applying these props directly to FocusTrap, or else
// fallbackFocus won't work.
Expand All @@ -100,7 +82,6 @@ export const EuiModal: FunctionComponent<EuiModalProps> = ({
className={classes}
onKeyDown={onKeyDown}
tabIndex={0}
onFocus={onFocus}
style={newStyle || style}
{...rest}
>
Expand Down