Improve permalink a11y #32
Merged
Conversation
This file contains 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
benmccann
reviewed
Apr 24, 2021
| @@ -566,3 +566,16 @@ input[type='checkbox']::after { | |||
| input[type='checkbox']:checked::after { | |||
| left: calc(100% - 1em + 2px); | |||
| } | |||
|
|
|||
| /* visually hidden, but accessible to assistive tech */ | |||
| .visually-hidden { | |||
There was a problem hiding this comment.
I'm actually not much of a Svelte expert despite working on it a fair bit. Is there a reason to put this here instead of in Permalink.svelte?
There was a problem hiding this comment.
Yeah, I did this intentionally. visually-hidden is a common utility class used to hide content visually but still expose it to screen readers. It won't just be used in the Permalink component -- for instance, if I update the rendered markdown from the API to use that class, it will need to be available globally.
It could also be used in the future to hide other text, e.g. like hiding <h1>s on the Svelte docs.
tomoam
added a commit
to tomoam/sites
that referenced
this pull request
Mar 10, 2023
* fix: OGP for Japanese * fix: OGP for Japanese * fix * add overflow-wrap * fix css * Update Card.svelte
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.
As instructed by @benmccann, moving sveltejs/site-kit#35 to the new sites repo.
The original intention behind this PR was to improve a11y and fix some Axe violations on svelte.dev related to permalinks. To do this, I needed to update some of the site-kit components. I've done so and applied the a11y fixes to kit.svelte.dev.
Summary of the changes:
I was unable to fix all the permalinks, since the docs markdown is now being rendered via a GH action. If these changes look good, I'll make a corresponding PR there to update the permalink rendering.
I'd still like to fix the permalinks on the svelte.dev docs, but I think it's best to wait until it's moved into the site monorepo.