Refine headless support for userbar and accessibility checker #13224
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
laymonage
force-pushed
the
fix/headless-userbar-fixes
branch
from
d1eee75 to
5d11ba1
Compare
This allows us to ensure Axe has the right config as soon as possible without having to run it first, and also avoids reconfiguration on every run which hopefully improves performance a bit
laymonage
force-pushed
the
fix/headless-userbar-fixes
branch
from
5d11ba1 to
e95342e
Compare
… the userbar and wait for the userbar to post the w-userbar:axe-ready message before running the checks from the page editor.
There's no need for them to be within the dialog. In fact, having them in the dialog could cause trouble if we reuse the dialog instance for subsequent runs, as the template elements will no longer be within the dialog after it's instantiated
laymonage
force-pushed
the
fix/headless-userbar-fixes
branch
from
e95342e to
ef79950
Compare
thibaudcolas
approved these changes
Jul 12, 2025
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.
There are some other race condition issues that cause Axe and the scroll restoration to not work on headless. This usually happens if the page contains other JS code that blocks the page
loadevent, which means thedocument.readyStateisinteractiveand theDOMContentLoadedevent has been fired. An example of this can be found on the "Bolani" bread page, which has a YouTube embed that blocks the page load by a few seconds.Fix this by ensuring
axe.configure()is run immediately during init and not on every run (as per #13164 (comment)), and by waiting for thewindow.loadevent instead ofdocument.DOMContentLoaded.In addition, some unrelated minor improvements:
getWagtailMessagesimplification per Implement scroll restoration for cross-domain preview iframes #13165 (comment)document.querySelector('wagtail-userbar').runAxe()multiple times on demand. Without this, the template element disappears after the first render of the results, because we wipe the content of the dialog. Without the template elements,runAxebails out early.TODO: