[AuButton] deprecate the default loading message #497
Merged
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.
The default loading message is a footgun. Many projects forget to properly set this which means the default is used, even though it's not a good fit for the context. This is only made worse by the fact that the AuButton component didn't visually display the loading message originally, so a lot of older code doesn't set this message explicitly.
By requiring an explicit loading message this should no longer be an issue.
Migration guide
Simply add a
@loadingMessage
argument if you are using the@loading
argument on a<AuButton>
component. To get the exact same result as the current behavior you can use the following code:There are few places where the default loading message makes sense in buttons though, so we recommend evaluating all places where the loading state of the button is used and using a good loading message for the context it is used in.
Closes #495