feat(theme): add custom label for social links #2466
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Currently, the accessibility label for social links is derived from the icon name. When using a custom icon with an SVG, the aria-label is empty.
This PR adds an optional field to SocialLink called
label.When a SocialLink includes the
labelstring, it will be used as the aria-label. This allows custom icons to have a label and improve accessibility, and also to overwrite the default labels if so desired.Behaviour is unchanged if the new optional field is not present.
This PR also updates the documentation and includes an example.
I understand that the word label might be confusing and users could be expecting the default theme to render this label as an icon subtext instead of it being an accessibility label. Please let me know if you think a different name would be more suitable.