Improve badge dimension calculations and add theme.button.badge.align #6692
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.
What does this PR do?
This PR fixes some issues with how badge was calculating its dimensions. Because of the use of
useLayoutEffect
, instead of handling height/width of badge withuseState
, we apply the style directly to the DOM.Additionally,
theme.button.badge.align
was added. If the value is specified ascontainer
then the badge will always offset from the button container.Snapshot changes are due to the offset/width/height being applied directly to the DOM as opposed to in the CSS styles.
Where should the reviewer start?
src/js/components/Button/Badge.js
What testing has been done on this PR?
Local storybook with HPE next theme, grommet theme
How should this be manually tested?
Do Jest tests follow these best practices?
screen
is used for querying.userEvent
is used in place offireEvent
.asFragment()
is used for snapshot testing.Any background context you want to provide?
What are the relevant issues?
Screenshots (if appropriate)
Do the grommet docs need to be updated?
Should this PR be mentioned in the release notes?
Yes. Added
theme.button.badge.align
.Is this change backwards compatible or is it a breaking change?
Yes.