-
Notifications
You must be signed in to change notification settings - Fork 534
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
TextInput: Refactor TextInputInnerAction
to use the default icon button tooltip
#4733
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"@primer/react": patch | ||
--- | ||
|
||
TextInput: Refactor TextInputInnerAction to use the default icon button tooltip (No changes in the behaviour or DOM is expected) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -79,7 +79,16 @@ const ConditionalTooltip: React.FC< | |
|
||
const TextInputAction = forwardRef<HTMLButtonElement, TextInputActionProps>( | ||
( | ||
{'aria-label': ariaLabel, tooltipDirection, children, icon, sx: sxProp, variant = 'invisible', ...rest}, | ||
{ | ||
'aria-label': ariaLabel, | ||
'aria-labelledby': ariaLabelledBy, | ||
tooltipDirection, | ||
children, | ||
icon, | ||
sx: sxProp, | ||
variant = 'invisible', | ||
...rest | ||
}, | ||
forwardedRef, | ||
) => { | ||
const sx = | ||
|
@@ -92,13 +101,28 @@ const TextInputAction = forwardRef<HTMLButtonElement, TextInputActionProps>( | |
console.warn('Use the `aria-label` prop to provide an accessible label for assistive technology') | ||
} | ||
|
||
const accessibleLabel = ariaLabel | ||
? {'aria-label': ariaLabel} | ||
: ariaLabelledBy | ||
? {'aria-labelledby': ariaLabelledBy} | ||
: { | ||
'aria-label': '', | ||
} | ||
|
||
return ( | ||
<Box as="span" className="TextInput-action" marginLeft={1} marginRight={1} lineHeight="0"> | ||
{icon && !children ? ( | ||
<Tooltip direction={tooltipDirection ?? 's'} text={ariaLabel ?? ''} type="label"> | ||
{/* @ts-ignore we intentionally do add aria-label to IconButton because Tooltip v2 adds an aria-labelledby instead. */} | ||
<IconButton variant={variant} type="button" icon={icon} size="small" sx={sx} {...rest} ref={forwardedRef} /> | ||
</Tooltip> | ||
{icon && !children && ariaLabel ? ( | ||
<IconButton | ||
{...accessibleLabel} | ||
tooltipDirection={tooltipDirection ?? 's'} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sparkle @joshblack for helping me fix this obscure type issue ✨ |
||
variant={variant} | ||
type="button" | ||
icon={icon} | ||
size="small" | ||
sx={sx} | ||
{...rest} | ||
ref={forwardedRef} | ||
/> | ||
) : ( | ||
<ConditionalTooltip aria-label={ariaLabel}> | ||
<Button variant={variant} type="button" sx={sx} {...rest} ref={forwardedRef}> | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This gives priority to aria-label over aria-labelledby which is opposite of what browsers do. Is that intentional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, kind of.
Because
aria-label
is a prop on theTextInputInnerAction
component and it is used to provide tooltip text as well.If there is
aria-labelledby
, the tooltip wiring needs to be manually. So to my understanding,aria-label
is encouraged and preferred.Let me know if you have any concerns or anything I am missing here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see!