Add loading prop for Button and IconButton
#3582
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": minor | ||
| --- | ||
|
|
||
| Add `loading` state to `Button` and `IconButton` |
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
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
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -7,6 +7,8 @@ import {ButtonProps, StyledButton} from './types' | |||||
| import {getVariantStyles, getButtonStyles, getAlignContentSize} from './styles' | ||||||
| import {useRefObjectAsForwardedRef} from '../hooks/useRefObjectAsForwardedRef' | ||||||
| import {defaultSxProp} from '../utils/defaultSxProp' | ||||||
| import VisuallyHidden from '../_VisuallyHidden' | ||||||
| import Spinner from '../Spinner' | ||||||
|
|
||||||
| const ButtonBase = forwardRef( | ||||||
| ({children, as: Component = 'button', sx: sxProp = defaultSxProp, ...props}, forwardedRef): JSX.Element => { | ||||||
|
|
@@ -21,6 +23,8 @@ const ButtonBase = forwardRef( | |||||
| size = 'medium', | ||||||
| alignContent = 'center', | ||||||
| block = false, | ||||||
| loading = false, | ||||||
| loadingMessage = 'Loading', | ||||||
|
There was a problem hiding this comment. Hi! Here's the new place to add props to the documentation: https://github.com/primer/react/blob/main/src/Button/Button.docs.json |
||||||
| ...rest | ||||||
| } = props | ||||||
| const LeadingVisual = leadingVisual ?? leadingIcon | ||||||
|
|
@@ -62,40 +66,60 @@ const ButtonBase = forwardRef( | |||||
| } | ||||||
|
|
||||||
| return ( | ||||||
| <> | ||||||
| <StyledButton | ||||||
| as={Component} | ||||||
| sx={sxStyles} | ||||||
| {...rest} | ||||||
| ref={innerRef} | ||||||
| data-block={block ? 'block' : null} | ||||||
| data-size={size === 'small' || size === 'large' ? size : undefined} | ||||||
| data-no-visuals={!LeadingVisual && !TrailingVisual && !TrailingAction ? true : undefined} | ||||||
| aria-disabled={loading ? true : undefined} | ||||||
| aria-describedby={loading ? 'loading-message' : undefined} | ||||||
|
There was a problem hiding this comment. Should this be?
Suggested change
There was a problem hiding this comment. I'm pretty sure There was a problem hiding this comment. I think we need a unique loading message ID for each button. We could have a page with multiple buttons in a loading state, and we can't have duplicate IDs. I've picked up this PR, so I'll take care of this |
||||||
| > | ||||||
| {Icon ? ( | ||||||
| loading ? ( | ||||||
| <Spinner size="small" /> | ||||||
|
There was a problem hiding this comment. Is the spinner size always small or should it depend on the size of the button? 🤔 There was a problem hiding this comment. Yeah, I think it looks good in the large button as well. I had the same thought 😆 I'll check again There was a problem hiding this comment. Bonus of not changing the size: it always matches the size of leadingVisual for this satisfying interaction: CleanShot.2023-10-11.at.14.55.13.mp4 |
||||||
| ) : ( | ||||||
| <Icon /> | ||||||
| ) | ||||||
| ) : ( | ||||||
| <> | ||||||
| <Box as="span" data-component="buttonContent" sx={getAlignContentSize(alignContent)}> | ||||||
| {loading && ( | ||||||
| <Box as="span" data-component="leadingVisual" sx={{...iconWrapStyles}}> | ||||||
| <Spinner size="small" /> | ||||||
| </Box> | ||||||
| )} | ||||||
| {LeadingVisual && !loading && ( | ||||||
| <Box as="span" data-component="leadingVisual" sx={{...iconWrapStyles}}> | ||||||
| <LeadingVisual /> | ||||||
| </Box> | ||||||
| )} | ||||||
| {children && <span data-component="text">{children}</span>} | ||||||
| {TrailingVisual && ( | ||||||
| <Box as="span" data-component="trailingVisual" sx={{...iconWrapStyles}}> | ||||||
| <TrailingVisual /> | ||||||
| </Box> | ||||||
| )} | ||||||
| </Box> | ||||||
| {TrailingAction && ( | ||||||
| <Box as="span" data-component="trailingAction" sx={{...iconWrapStyles}}> | ||||||
| <TrailingAction /> | ||||||
| </Box> | ||||||
| )} | ||||||
| </> | ||||||
| )} | ||||||
| </StyledButton> | ||||||
| {loading && ( | ||||||
| <VisuallyHidden> | ||||||
| <span aria-live="polite" aria-busy="true" id="loading-message"> | ||||||
| {loadingMessage} | ||||||
| </span> | ||||||
| </VisuallyHidden> | ||||||
| )} | ||||||
| </> | ||||||
| ) | ||||||
| }, | ||||||
| ) as PolymorphicForwardRefComponent<'button' | 'a', ButtonProps> | ||||||
|
|
||||||
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
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
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
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.
Is it an sr-only message?
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, visually hidden. Should the name of this prop be more specific like
hiddenLoadingMessage?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.
Hmm good question. I think it is a good idea to indicate it in the name because I searched the code to see where we display the message and when we add this to the prop data it might not be obvious that it is sr only.
hiddenLoadingMessagesounds like an option.visuallyHiddenLoadingMessageis too long. Issr-onlywording out-dated? 🤔 Could it besrOnlyLoadingMessage?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.
Hi!
The prop should ideally hint at what purpose it serves, but I think it doesn't have to describe implementation details.
If
loadingMessagefeels misguiding as the message is not shown in the button, how do you feel about something along the lines ofloadingAnnouncement? It signals a live region for screen readers without getting into what it doesn't do (visuallyHidden / srOnly)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.
Love that @siddharthkp! Thank you 😄
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.
Love it too 😍