Add accessibility props to Seat #4512
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
DSil
force-pushed
the
dsil/add-a11y-seat
branch
from
7e881a9
to
000462e
Compare
Deploying orbit with
|
| Latest commit: |
b6ec76a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://de745834.orbit.pages.dev |
| Branch Preview URL: | https://dsil-add-a11y-seat.orbit.pages.dev |
|
Storybook staging is available at https://kiwicom-orbit-dsil-add-a11y-seat.surge.sh |
|
Size Change: +46 B (+0.01%) Total Size: 459 kB
ℹ️ View Unchanged
|
sarkaaa
reviewed
Nov 8, 2024
@sarkaaa you mean as controls or as defined props? I don't think we should have as controls, as it visually does not change anything on the story. I don't mind adding dummy constant values to the rendered components in stories, so we can try them with screen readers, if we want |
domi and I added those props to Playground stories as well, although they are dummies props. It doesn't have any impact on the story itself at all, it's just a convention that we created in summer. :D |
docs/src/documentation/03-components/08-visuals/seat/03-accessibility.mdx
Show resolved
Hide resolved
DSil
force-pushed
the
dsil/add-a11y-seat
branch
from
ac10505
to
336c97b
Compare
sarkaaa
reviewed
Nov 14, 2024
DSil
force-pushed
the
dsil/add-a11y-seat
branch
from
336c97b
to
320152d
Compare
DSil
force-pushed
the
dsil/add-a11y-seat
branch
from
9e8e308
to
101c89a
Compare
domihustinova
approved these changes
Nov 18, 2024
There was a problem hiding this comment.
There are some changes needed in the Story file after your changes:
titleanddescriptioncan be removed fromexcludein the Default story as they no longer have default values - they won't be displayed in controls without default values.aria-labelledbyneeds to be added to theexcludein the Default story as now there is broken control withSet objectbutton.- Also Playground story needs to be handled similarly.
So there are two options:
- If you want to exclude
aria-labelledbyfrom both Default and Playground stories,aria-labelledbyneeds to be added toexcludeon meta (this will exclude it from Playground story) and also added to the Default story exclude (withtitleanddescriptionremoved). - If you want to exclude it only from the Default story, Default exclude need to be adjusted but also
texttype needs to be set on meta argTypes as it seem to be incorrectly inferred :/
"aria-labelledby": {
control: {
type: "text",
},
},
101c89a
to
343031a
Compare
BREAKING CHANGE: `title` and `description` props no longer have default values. They can be manually set with text to be announced by screen readers.
It receives a string of id(s)
BREAKING CHANGE: `label` and `price` props now only accept string. They no longer accept ReactNode
DSil
force-pushed
the
dsil/add-a11y-seat
branch
from
343031a
to
b6ec76a
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.
Proposal for adding accessibility to Seat component.
New prop
aria-labelledbyadded to Seat component. Thetitleanddescriptionprops no longer have default values (Breaking change).New prop
aria-labeladded to SeatLegend component.New accessibility documentation page added for Seat component.
FEPLT-2157