UI: Update Swagger Title Element#30816
Closed
lane-wetmore wants to merge 2 commits into
Closed
Conversation
github-actions
Bot
added
the
hashicorp-contributed-pr
lane-wetmore
commented
Jun 2, 2025
|
|
||
| // Update the title to be an h1 tag to align with a11y standards | ||
| setTimeout(() => { | ||
| const oldTitle = element.querySelector('.swagger-ui .title'); |
Contributor
Author
There was a problem hiding this comment.
It isn't ideal to replace the tag this way, but it isn't possible to update the title of the Swagger Info component with a plugin unless we replace the entire thing. I've added a test for this in case these selectors change.
Contributor
There was a problem hiding this comment.
This looks fine but I wonder if it would be better to schedule this to run in the afterRender queue rather than waiting for that fixed amount of time? That should fire after all the view rendering has completed which should ensure that the h2 tag you are looking to replace is in the DOM.
|
Build Results: |
|
CI Results: |
drivera258
approved these changes
Jun 6, 2025
Contributor
Author
|
Wrong ticket linked - opened a new PR with correct branch info #30888 |
6 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This PR addresses an a11y violation found in the swagger title.
Previous
Current
TODO only if you're a HashiCorp employee
backport/label that matches the desired release branch. Note that in the CE repo, the latest release branch will look likebackport/x.x.x, but older release branches will bebackport/ent/x.x.x+ent.of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.