TanStack / TanStack/tanstack.com

Define focus restoration for controlled dialogs

Open
#1,209 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

source-audit
Dominant language
TypeScript
Stars
1.1k
Forks
401
Avg merge
18h 14m
Merged PRs (30d)
56

Description

Evidence

Merged PR #1205 moved shipping overlays onto the shared Radix-backed Dialog, but the controlled-dialog call sites do not register an opener with DialogTrigger.

Current source has 16 controlled Dialog roots and no shipping DialogTrigger usage. Radix stores the trigger in context.triggerRef, then its modal onCloseAutoFocus handler prevents the browser default and calls context.triggerRef.current?.focus(). Without a registered trigger, that ref is null, so keyboard focus is not restored to the control that opened the dialog.

This is straightforward for colocated single openers, such as the NPM baseline package picker. It is not one mechanical change for every caller:

  • Some dialogs are controlled by an opener in a parent component.
  • The admin role removal dialog has one dynamic opener per table row.
  • Some design-system examples currently keep their opener outside the Dialog root.

Repeated title, body, keyword, and open-PR searches found no existing owner. Issue #775 tracks unrelated empty-name, label, landmark, and skip-navigation findings.

Expected impact

Closing a dialog should return keyboard and assistive-technology users to the control that opened it. Falling back to the document body loses their place and makes repeated actions harder.

Proposed direction

Adopt one explicit controlled-dialog focus contract:

  1. Require DialogTrigger asChild for dialogs with one colocated opener.
  2. Add a typed shared API for external or dynamic openers, such as an explicit restore-focus ref or a narrowly exposed Radix close-auto-focus callback.
  3. Add a browser-level regression test that opens a dialog, closes it with Escape and the close button, and verifies focus returns to the actual opener.

Alternatives and tradeoffs

  • Requiring DialogTrigger everywhere keeps the shared API smallest, but dynamic table-row openers would need dialog state and content moved per row or another structural change.
  • Restoring the previously active element automatically inside DialogContent reduces call-site work, but it changes every dialog and can restore focus to a stale or unrelated node when opening is indirect.
  • Exposing only onCloseAutoFocus matches Radix directly, but every caller must repeat the same focus logic and the shared primitive cannot enforce consistency.

Decision needed

@tannerlinsley, should the shared controlled-dialog contract support both DialogTrigger for colocated openers and an explicit restore-focus ref for external or dynamic openers, or should every dialog be restructured so one DialogTrigger always owns the opener?

Source: #1205

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the 16 controlled Dialog roots, including the NPM baseline package picker, the admin role removal dialog, and the design-system examples. Compare their opener arrangements with the shared Radix-backed Dialog and define the contract after the pending decision is resolved. Done means the chosen focus-restoration behavior is implemented and a browser-level regression test verifies focus returns after Escape and close-button dismissal.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
accessibility, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.