Skip to content

fix: tree focus management #9531

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

Open
snowystinger wants to merge 7 commits into
base: main
Choose a base branch
from
+120 −3
Open

fix: tree focus management #9531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5d7b0bf
fix: tree focus management
snowystinger Jan 27, 2026
6f2e951
one possible fix
snowystinger Jan 28, 2026
4548829
fix issue in treeview directly
snowystinger Jan 28, 2026
799c982
Merge branch 'main' into fix-tree-focus-management
snowystinger Jan 28, 2026
bc17972
add table test because behavior should be different
snowystinger Jan 28, 2026
3a18f6e
fix lint
snowystinger Jan 28, 2026
c2d55c7
Merge branch 'main' into fix-tree-focus-management
snowystinger Jan 28, 2026
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
6 changes: 6 additions & 0 deletions packages/@react-aria/selection/src/useSelectableItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,12 @@ export function useSelectableItem(options: SelectableItemOptions): SelectableIte
};
}

useEffect(() => {
if (isDisabled && manager.focusedKey === key) {
manager.setFocusedKey(null);
}
}, [manager, isDisabled, key]);

Comment on lines +203 to +208
Copy link
Member

@LFDanLu LFDanLu Jan 28, 2026

Choose a reason for hiding this comment

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

wonder if this could be handled via useListState since there is already logic there to handle a similar case (aka when the focused key is deleted). I think this is fine for now though, think we wanted to refactor that code in the future anyways.

Copy link
Member Author

@snowystinger snowystinger Jan 29, 2026

Choose a reason for hiding this comment

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

yeah. I'm super torn on where to put it, at one point i had it in useSelectableCollection, I had also done it in useTreeState, which also has a very similar effect for if an item is deleted. This logic is all over the place

// With checkbox selection, onAction (i.e. navigation) becomes primary, and occurs on a single click of the row.
// Clicking the checkbox enters selection mode, after which clicking anywhere on any row toggles selection for that row.
// With highlight selection, onAction is secondary, and occurs on double click. Single click selects the row.
Expand Down
44 changes: 42 additions & 2 deletions packages/@react-spectrum/s2/test/TableView.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,21 @@ import {
TableView,
Text
} from '../src';
import {DisabledBehavior} from '@react-types/shared';
import Filter from '../s2wf-icons/S2_Icon_Filter_20_N.svg';
import React from 'react';
import {User} from '@react-aria/test-utils';
import {pointerMap, User} from '@react-aria/test-utils';
import React, {useState} from 'react';
import userEvent from '@testing-library/user-event';

// @ts-ignore
window.getComputedStyle = (el) => el.style;

describe('TableView', () => {
let offsetWidth, offsetHeight;
let user;
let testUtilUser = new User({advanceTimer: jest.advanceTimersByTime});
beforeAll(function () {
user = userEvent.setup({delay: null, pointerMap});
offsetWidth = jest.spyOn(window.HTMLElement.prototype, 'clientWidth', 'get').mockImplementation(() => 400);
offsetHeight = jest.spyOn(window.HTMLElement.prototype, 'clientHeight', 'get').mockImplementation(() => 200);
jest.useFakeTimers();
Expand Down Expand Up @@ -108,4 +112,40 @@ describe('TableView', () => {
await tableTester.triggerColumnHeaderAction({column: 1, action: 0, interactionType: 'keyboard'});
expect(onAction).toHaveBeenCalledTimes(1);
});

it('if the previously focused cell\'s row is disabled, the focus should still be restored to the cell when the disabled behavior is changed and the user navigates to the collection', async () => {
function Example() {
let [disabledBehavior, setDisabledBehavior] = useState<DisabledBehavior>('selection');
return (
<>
<button>Before</button>
<TableView aria-label="Dynamic table" disabledBehavior={disabledBehavior} disabledKeys={['2']}>
<TableHeader columns={columns}>
{(column) => <Column {...column}>{column.name}</Column>}
</TableHeader>
<TableBody>
<Row id="1"><Cell>Foo 1</Cell><Cell>Bar 1</Cell><Cell>Baz 1</Cell><Cell>Yah 1</Cell></Row>
<Row id="2"><Cell>Foo 2</Cell><Cell>Bar 2</Cell><Cell>Baz 2</Cell><Cell>Yah 2</Cell></Row>
<Row id="3"><Cell>Foo 3</Cell><Cell>Bar 3</Cell><Cell>Baz 3</Cell><Cell>Yah 3</Cell></Row>
</TableBody>
</TableView>
<button onClick={() => setDisabledBehavior('all')}>After</button>
</>
);
}

let {getAllByRole, getByRole} = render(<Example />);
await user.click(document.body);

let cells = getAllByRole('gridcell');
let afterButton = getByRole('button', {name: 'After'});
await user.click(cells[3]); // Bar 2
expect(document.activeElement).toBe(cells[3]);

await user.click(afterButton);
await user.tab({shift: true});
await user.tab({shift: true});
await user.tab();
expect(document.activeElement).toBe(cells[3]);
});
});
73 changes: 72 additions & 1 deletion packages/@react-spectrum/s2/test/TreeView.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ import {
TreeViewItemContent
} from '../src';
import {AriaTreeTests} from '../../../react-aria-components/test/AriaTree.test-util';
import {DisabledBehavior} from '@react-types/shared';
import FileTxt from '../s2wf-icons/S2_Icon_FileText_20_N.svg';
import Folder from '../s2wf-icons/S2_Icon_Folder_20_N.svg';
import React from 'react';
import React, {useState} from 'react';
import userEvent from '@testing-library/user-event';

AriaTreeTests({
Expand Down Expand Up @@ -493,4 +494,74 @@ describe('TreeView', () => {
let menu = queryByRole('menu');
expect(menu).not.toBeInTheDocument();
});

it('if the previously focused item is disabled, the focus should move to the first item when coming back to the collection', async () => {
function Example() {
let [disabledBehavior, setDisabledBehavior] = useState<DisabledBehavior>('selection');
return (
<>
<button>Before</button>
<TreeView aria-label="Test tree" disabledBehavior={disabledBehavior} disabledKeys={['school']}>
<TreeViewItem id="projects" textValue="Projects">
<TreeViewItemContent>
<Text>Projects</Text>o
<Folder />
<ActionMenu>
<MenuItem id="edit">
<Text>Edit</Text>
</MenuItem>
<MenuItem id="delete">
<Text>Delete</Text>
</MenuItem>
</ActionMenu>
</TreeViewItemContent>
</TreeViewItem>
<TreeViewItem id="school" textValue="School">
<TreeViewItemContent>
<Text>School</Text>o
<Folder />
<ActionMenu>
<MenuItem id="edit">
<Text>Edit</Text>
</MenuItem>
<MenuItem id="delete">
<Text>Delete</Text>
</MenuItem>
</ActionMenu>
</TreeViewItemContent>
<TreeViewItem id="homework-1" textValue="Homework-1" isDisabled>
<TreeViewItemContent>
<Text>Homework-1</Text>
<Folder />
<ActionMenu>
<MenuItem id="edit">
<Text>Edit</Text>
</MenuItem>
<MenuItem id="delete">
<Text>Delete</Text>
</MenuItem>
</ActionMenu>
</TreeViewItemContent>
</TreeViewItem>
</TreeViewItem>
</TreeView>
<button onClick={() => setDisabledBehavior('all')}>After</button>
</>
);
}

let {getAllByRole, getByRole} = render(<Example />);
await user.click(document.body);

let rows = getAllByRole('row');
let afterButton = getByRole('button', {name: 'After'});
await user.click(rows[1]);
expect(document.activeElement).toBe(rows[1]);

await user.click(afterButton);
await user.tab({shift: true});
await user.tab({shift: true});
await user.tab();
expect(document.activeElement).toBe(rows[0]);
});
});