Wrong a11y wargning on <dialog> with autofocus attribute
#9225
Development PR
closes #9225
Before submitting the PR, please make sure you do the following
- It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
- Prefix your PR title with
feat:,fix:,chore:, ordocs:. - This message body should clearly illustrate what problems it solves.
- Ideally, include a test that fails without this PR but passes with it.
- If this PR changes code within
packages/svelte/src, add a changeset (npx changeset).
Tests and linting
- Run the tests with
pnpm testand lint the project withpnpm lint
Issue
Describe the bug
Ally warning "Avoid using autofocus" appears on <dialog autofocus> element definition.
But using of autofocus on dialog or its descendants is recommended by the standard: https://html.spec.whatwg.org/multipage/interactive-elements.html#the-dialog-element
As such, authors should use the autofocus attribute on the descendant element of the dialog that the user is expected to immediately interact with after the dialog opens. If there is no such element, then authors should use the autofocus attribute on the dialog element itself.
Reproduction
<dialog autofocus>
I'm a dialog
</dialog>https://svelte.dev/repl/483135a2842e4da6ba6f24ea63430cf2?version=4.2.0
Logs
No response
System Info
N/ASeverity
annoyance
Info
It may not be necessary in many cases; as the spec states:
The dialog focusing steps attempt to pick a good candidate for initial focus when a dialog is shown
It looks like browsers will already focus the first interactive element and if there is none, the dialog itself. So you should only need it...
- on an interactive element if it is not the first but you want to focus it instead
- on the dialog if there are interactive elements inside but you do not want to focus those
I guess a common case would be a close button you want to skip, though.
Agree that using this attribute could be not necessary, but still recommended and definitely not an error, so should not be treated as an a11y issue.
I'd like to bump this issue since I just encountered it. The MDN docs specifically say to use autofocus on the <dialog> when there isn't a specific element that should have first focus.