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

Jump to bottom

Improve performance of tabbing #967

Merged
merged 6 commits into from
Jun 17, 2022
Merged

Improve performance of tabbing #967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ab035fd
Add just-in-time focusable check
camchenry Jun 7, 2022
1d07c84
Remove alternative implementation
camchenry Jun 7, 2022
ada2883
refactor: inline filter
ph-fritsche Jun 8, 2022
a4dda8c
refactor: simplify loop
ph-fritsche Jun 8, 2022
543e212
Merge pull request #1 from testing-library/pr-967
camchenry Jun 8, 2022
e732ee9
Merge branch 'main' into pr/improve-tab-performance
ph-fritsche Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 20 additions & 10 deletions src/utils/focus/getTabDestination.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,11 @@ export function getTabDestination(activeElement: Element, shift: boolean) {
const enabledElements = Array.from(focusableElements).filter(
el =>
el === activeElement ||
(el.getAttribute('tabindex') !== '-1' &&
!isDisabled(el) &&
// Hidden elements are not tabable
isVisible(el)),
!(Number(el.getAttribute('tabindex')) < 0 || isDisabled(el)),
)

if (activeElement.getAttribute('tabindex') !== '-1') {
// tabindex has no effect if the active element has tabindex="-1"
// tabindex has no effect if the active element has negative tabindex
if (Number(activeElement.getAttribute('tabindex')) >= 0) {
enabledElements.sort((a, b) => {
const i = Number(a.getAttribute('tabindex'))
const j = Number(b.getAttribute('tabindex'))
Expand Down Expand Up @@ -73,9 +70,22 @@ export function getTabDestination(activeElement: Element, shift: boolean) {
prunedElements.push(el)
})

const currentIndex = prunedElements.findIndex(el => el === activeElement)
for (let index = prunedElements.findIndex(el => el === activeElement); ; ) {
index += shift ? -1 : 1

const nextIndex = shift ? currentIndex - 1 : currentIndex + 1
const defaultIndex = shift ? prunedElements.length - 1 : 0
return prunedElements[nextIndex] || prunedElements[defaultIndex]
// loop at overflow
if (index === prunedElements.length) {
index = 0
} else if (index === -1) {
index = prunedElements.length - 1
}

if (
prunedElements[index] === activeElement ||
prunedElements[index] === document.body ||
isVisible(prunedElements[index])
) {
return prunedElements[index]
}
}
}
8 changes: 5 additions & 3 deletions tests/utils/focus/getTabDestination.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,13 @@ test('get next focusable element in tab order', () => {
const {
elements: [elA, elB, elC, elD, elE, elF],
} = setup(`
<input id="a" tabIndex="2"/>
<input id="a" tabIndex="2">
<input id="b" tabIndex="0">
<input id="c" tabIndex="-1"/>
<input id="c" tabIndex="-1">
<input id="d" tabIndex="0">
<input id="e" tabIndex="1">
<input id="f" />
<input id="f">
<input id="g" tabIndex="-999">
`)

assertTabOrder([elE, elA, elB, elD, elF])
Expand All @@ -72,6 +73,7 @@ test('exclude hidden elements', () => {
} = setup(`
<input/>
<input type="hidden"/>
<input hidden />
<input style="visibility: hidden"/>
<input style="display: none"/>
`)
Expand Down