Add new rule a11y-no-title-usage
#316
Merged
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: 0c278b7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
TylerJDev
requested review from
francinelucca,
kendallgassner,
khiga8 and
hectahertz
hectahertz
approved these changes
Feb 13, 2025
docs/rules/a11y-no-title-usage.md
Outdated
| const App = () => <RelativeTime date={new Date('2020-01-01T00:00:00Z')} /> | ||
| ``` | ||
|
|
||
| The `noTitle` attribute can be omitted because its default value is `true` internally. |
There was a problem hiding this comment.
Maybe "The noTitle attribute is true by default, so it can be omitted." is a bit easier to read? Just nit picking here
There was a problem hiding this comment.
I like this, your suggestion reads better! Thank you 😄
|
|
||
| The `noTitle` attribute can be omitted because its default value is `true` internally. | ||
|
|
||
| ## With alternative tooltip |
There was a problem hiding this comment.
Great to have this example ❤️
TylerJDev
commented
Feb 13, 2025
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.
Adds new rule
a11y-no-title-usage.This rule recommends that consumers do not utilize the title attribute with the RelativeTime component. This attribute is inherent to the component, so adding the prop noTitle is currently necessary.
The suggested paths for remediating violations found through this rule are:
Tooltipin with an interactive elementtitledate adjacent or near theRelativeTimecomponenttitleif it isn't neededQuestions for reviewers:
relative-time-element, so should the name referencerelative-time-element?noTitlewill also be deprecatedContext: https://github.com/github/primer/issues/4769