Improve accessibility: added aria-label and replaced SimpleGrid #425
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
…nd replaced SimpleGrid
…nd replaced SimpleGrid
AykutSarac
requested changes
Nov 17, 2024
| @@ -95,20 +95,25 @@ export const Section1 = () => { | |||
| optimal view of your data so you can make insights faster than ever. | |||
| </Text> | |||
| <List | |||
| component="ul" | |||
There was a problem hiding this comment.
do we need this? AFAIK the default is ul already
| @@ -119,6 +124,7 @@ export const Section1 = () => { | |||
| <StyledDottedContainer> | |||
| <Image className="jc" src="/assets/jsoncrack.svg" alt="json crack" loading="lazy" /> | |||
| <JsonInput | |||
| aria-label="JSON data" | |||
There was a problem hiding this comment.
this actually a textarea and not svg, so we can remove it
|
@tkim602 — Note that we cannot see the HTML tags in your initial post in this PR. We see text like this —
You need to wrap such tags in code fences. Single backticks work for inline text |
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.
I initially noticed some accessibility issues in features.tsx and section1.tsx and found out that revising only the section1.tsx can improve in the same way. The audit flagged two issues: 1. missing labels for form elements and 2. list structure issues due to items not being contained within
and
elements.
The original code used for layout. I modified the code to utilize
and- tags by setting component="ul" on . This change resolved the list structure issue.
Additionally, I applied an aria-label to the JsonInput in section1.tsx. I guess since the mobile does not include the svg content, it did not impact the Lighthouse score on mobile. But it significantly improved accessibility on desktop, so I chose to leave it.
I am submitting this pull request and would appreciate insights into managing such platform specific discrepancies in accessibility.
Closes Accessibility Improvement: labels for form elements and proper list semantics #423