[Badge] Add customAccessibilityLabel prop #4028
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
emma-boardman
added
Accessibility
kyledurand
reviewed
Mar 3, 2021
src/components/Badge/Badge.tsx
Outdated
| @@ -23,6 +23,8 @@ export interface BadgeProps { | |||
| * @default 'medium' | |||
| */ | |||
| size?: Size; | |||
| /** Pass a custom accessibilityLabel (overrides status and progress labels) */ | |||
| customAccessibilityLabel?: string; | |||
There was a problem hiding this comment.
This PR looks good to me but I worry that this prop might be misunderstood and get misused. I like that it's different from the default accessibilityLabel prop but I'm not sure the name tells you enough about what it does.
What about something terribly verbose?
statusAndProgressLabelOverride
emma-boardman
force-pushed
the
badge-add-custom-a11y-label
branch
from
4ab7db0
to
cc4bf2a
Compare
kyledurand
approved these changes
Mar 3, 2021
src/components/Badge/README.md
Outdated
| <Badge | ||
| status="success" | ||
| progress="complete" | ||
| customAccessibilityLabel="Status: Published. Your online store is visible." |
There was a problem hiding this comment.
Suggested change
| customAccessibilityLabel="Status: Published. Your online store is visible." | |
| statusAndProgressLabelOverride="Status: Published. Your online store is visible." |
alex-page
approved these changes
Mar 3, 2021
|
Hello again 👋 😄 First time merging since Percy got added - do I need to be authorised in Percy to approve? I can access the UI, but my
|
|
✅ Percy requires a polaris admin to approve Good to 🚢 now! Thanks Emma! |
This was referenced Mar 18, 2021
sylvhama
pushed a commit
that referenced
this pull request
Mar 26, 2021
* add customA11yLabel prop, update docs and tests * update unreleased * update prop name and description * update readme
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.
WHY are these changes introduced?
Experimenting with a proposed feature request #4027
WHAT is this pull request doing?
customAccessibilityLabelfor consumer's who need to pass more specific labels.How to 🎩
Badge with customAccessibilityLabelstory🎩 checklist
README.mdwith documentation changes