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.

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

Save focus from shadow DOM #121

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 9 additions & 3 deletions src/Modal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,15 @@ const Modal: React.ForwardRefExoticComponent<
useImperativeHandle(ref, () => modal, [modal]);

if (canUseDOM && !prevShow && show) {
lastFocusRef.current = activeElement(
ownerWindow?.document,
) as HTMLElement | null;
let last = activeElement(ownerWindow?.document) as HTMLElement | null;
while (
last &&
last.shadowRoot instanceof ShadowRoot &&
last.shadowRoot.activeElement instanceof HTMLElement
) {
last = last.shadowRoot.activeElement;
}
lastFocusRef.current = last;
}

// TODO: I think this needs to be in an effect
Expand Down
43 changes: 43 additions & 0 deletions test/ModalSpec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -329,5 +329,48 @@ describe('<Modal>', () => {
expect(document.activeElement!.classList.contains('modal')).toBe(true);
});
});

it('should return focus to previously focused element in shadow DOM when modal closes', async () => {
class CustomElementImplementation extends HTMLElement {
constructor() {
super();
const shadowRoot = this.attachShadow({ mode: 'open' });
const button = document.createElement('button');
shadowRoot.appendChild(button);
}
}
const CustomElementTag = `focus-test-${Math.floor(
Math.random() * 9999999,
)}`;
window.customElements.define(
CustomElementTag,
CustomElementImplementation,
);
function ButtonAndModal(props: { show?: boolean }) {
return (
<>
<CustomElementTag />
<Modal {...props}>
<input autoFocus />
</Modal>
</>
);
}

const { rerender, container } = render(<ButtonAndModal />);
const element = container.querySelector(CustomElementTag);
const button = element!.shadowRoot!.querySelector('button');
button!.focus();

expect(document.activeElement).toBe(element);
expect(element?.shadowRoot?.activeElement).toBe(button);

rerender(<ButtonAndModal show />);
expect(document.activeElement).not.toBe(button);

rerender(<ButtonAndModal />);
expect(document.activeElement).toBe(element);
expect(element?.shadowRoot?.activeElement).toBe(button);
});
});
});