-
Notifications
You must be signed in to change notification settings - Fork 50
Upgrade ember-a11y-refocus to v5.1.0
#3234
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.
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
shleewhite
wants to merge
25
commits into
main-5.0.0
Choose a base branch
from
chore/upgrade-ember-a11y-focus
base: main-5.0.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
5 tasks
dchyun
reviewed
Sep 24, 2025
|
we need to bring it styles manually now as addon it self now v2 which means styles will not be auto included https://github.com/ember-a11y/ember-a11y-refocus?tab=readme-ov-file#usage also my comments on original PR is still valid #2950 (comment) |
didoo
reviewed
Sep 25, 2025
aklkv
reviewed
Sep 25, 2025
aklkv
reviewed
Sep 25, 2025
b01d049 to
8893776
Compare
051a07c to
4d32c92
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📌 Summary
This PR upgrades
ember-a11y-refocustov5.1.0, which required a few related dependency, type, and style updates to ensure everything compiles and functions correctly.Changes
@glimmer/componenttov2.0EmberA11yRefocusRegistryto correctly import type signatures forNavigationNarrator.NavigationNarratorwould remain untyped.package.jsonto forcev2.0.0. This prevents build failures in Showcase and Website caused by mismatched versions.@a11yRefocusRouteChangeValidatorargumentsSideNavandAppHeader, this arg was previously typed asstring.(transition: Transition) => booleansince it is forwarded to theNavigationNarratorcomponent.Ownertyping inth-resize-handle@glimmer/component@2.0.0throws ifOwneris not typed correctly.Ownerbeing typed asunknown.NavigationNarratorstyles to Website CSSember-a11y-refocus@5.1.0no longer auto-imports its styles for the website nav.website/ember-cli-build.jsandwebsite/app/styles/app.scssfollowing the recommended usage.Open discussion
There is still a question around what is the best way to handle the
ember-a11y-refocusstyles. Before, the way the build worked made it so the consumer would installember-a11y-refocusby installing the design system and that would implicitly import the styles. This is no longer the case, so either we need to export the styles for them or they need to manually import them.In this instance, we can treat the showcase app as a demo consumer of the design system. The easiest way to verify that the styles are imported are to check the SideNav skip link example in the showcase. If the link has an underline, the styles are not imported.
The solution in this PR is Lee's preference
Ultimately, the main style we need is
text-decoration: noneand ember-a11y-refocus is not likely to change the styles frequently so I think it is reasonably safe to copy their styles and include them in our exported stylesheet.Option 2: Require all consumers add
ember-a11y-refocusas a dependencySPIKE PR: #3251
In this option, we don't export the ember-a11y-refocus styles so the consumer has to include the path in their ember-cli-build and add it as a dependency. This approach is similar to how the tokens styles work.
This would require all consumers to update their ember-cli-build file and we'd have to change the guidance on our website. If you don't do this, the design system package builds fine, but the showcase fails to build because it does not have access to the stylesheet.
👀 Component checklist
💬 Please consider using conventional comments when reviewing this PR.
📋 PCI review checklist
Examples of changes to controls include access controls, encryption, logging, etc.
Examples include changes to operating systems, ports, protocols, services, cryptography-related components, PII processing code, etc.