feat(avatar): add label prop for alternative text & aria-label #6910
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
anveshmekala
added
the
pr ready for visual snapshots
geospatialem
reviewed
May 3, 2023
src/components/avatar/avatar.tsx
Outdated
| @@ -77,7 +80,7 @@ export class Avatar { | |||
| const initials = this.generateInitials(); | |||
| const backgroundColor = this.generateFillColor(); | |||
| return ( | |||
| <span class="background" style={{ backgroundColor }}> | |||
| <span aria-label={this.label || this.fullName} class="background" style={{ backgroundColor }}> | |||
There was a problem hiding this comment.
To ensure the aria-label is supported, we'll need to add a role to the span element. It seems like the figure role is the best fit.
src/components/avatar/avatar.tsx
Outdated
| @@ -39,6 +39,9 @@ export class Avatar { | |||
| /** Specifies the unique id of the user. */ | |||
| @Prop({ reflect: true }) userId: string; | |||
|
|
|||
| /** When `thumbnail` is defined, specifies alternate text for the image. Otherwise specifies accessible label for the component.*/ | |||
There was a problem hiding this comment.
Since this could also apply to a non-image, how about the following?:
Accessible name for the component. Specifies alternative text when
thumbnailis defined, otherwise specifies an accessible label.
There was a problem hiding this comment.
For line 33, can it reflect the support for non-images?
Specifies the full name of the user. When
labelandthumbnailare not defined, specifies the accessible name for the component.
anveshmekala
added
pr ready for visual snapshots
geospatialem
approved these changes
May 4, 2023
jcfranco
approved these changes
May 4, 2023
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.
Related Issue: #5564
Summary
This PR will add a
labelproperty incalcite-avatarwhich is used to provide context for Assistive Technology users.