Skip to content

fix(utils): update focus utility to add focus states without keydown #30116

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

fix(utils): update focus utility to add focus states without keydown #30116

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
51a6dd6
test(angular): add new pages to navigate between lazy and standalone …
brandyscarney Dec 6, 2024
3cb9e13
test(angular): add split pane test
brandyscarney Dec 6, 2024
d4230a8
fix(utils): update focus visible to remove keydown approach
brandyscarney Jan 7, 2025
4f34ba1
Merge branch 'main' into ROU-11380
brandyscarney Jan 7, 2025
44649b7
test(angular): styleUrl support did not exist in ng16
brandyscarney Jan 7, 2025
169af4a
test(angular): update lazy tabs test
brandyscarney Jan 9, 2025
f38a078
Merge branch 'main' into ROU-11380
brandyscarney Apr 11, 2025
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
41 changes: 7 additions & 34 deletions core/src/utils/focus-visible.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,5 @@
const ION_FOCUSED = 'ion-focused';
const ION_FOCUSABLE = 'ion-focusable';
const FOCUS_KEYS = [
'Tab',
'ArrowDown',
'Space',
'Escape',
' ',
'Shift',
'Enter',
'ArrowLeft',
'ArrowRight',
'ArrowUp',
'Home',
'End',
];

export interface FocusVisibleUtility {
destroy: () => void;
Expand All @@ -22,7 +8,6 @@ export interface FocusVisibleUtility {

export const startFocusVisible = (rootEl?: HTMLElement): FocusVisibleUtility => {
let currentFocus: Element[] = [];
let keyboardMode = true;

const ref = rootEl ? rootEl.shadowRoot! : document;
const root = rootEl ? rootEl : document.body;
Expand All @@ -32,43 +17,31 @@ export const startFocusVisible = (rootEl?: HTMLElement): FocusVisibleUtility =>
elements.forEach((el) => el.classList.add(ION_FOCUSED));
currentFocus = elements;
};

const pointerDown = () => {
keyboardMode = false;
setFocus([]);
};

const onKeydown = (ev: Event) => {
keyboardMode = FOCUS_KEYS.includes((ev as KeyboardEvent).key);
if (!keyboardMode) {
setFocus([]);
}
};
const onFocusin = (ev: Event) => {
if (keyboardMode && ev.composedPath !== undefined) {
const toFocus = ev.composedPath().filter((el: any) => {
// TODO(FW-2832): type
if (el.classList) {
return el.classList.contains(ION_FOCUSABLE);
}
return false;
}) as Element[];
setFocus(toFocus);
}
const toFocus = ev.composedPath().filter((el): el is HTMLElement => {
return el instanceof HTMLElement && el.classList.contains(ION_FOCUSABLE);
});

setFocus(toFocus);
};

const onFocusout = () => {
if (ref.activeElement === root) {
setFocus([]);
}
};

ref.addEventListener('keydown', onKeydown);
ref.addEventListener('focusin', onFocusin);
ref.addEventListener('focusout', onFocusout);
ref.addEventListener('touchstart', pointerDown, { passive: true });
ref.addEventListener('mousedown', pointerDown);

const destroy = () => {
ref.removeEventListener('keydown', onKeydown);
ref.removeEventListener('focusin', onFocusin);
ref.removeEventListener('focusout', onFocusout);
ref.removeEventListener('touchstart', pointerDown);
Expand Down
Loading