Skip to content
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

docs(meter): let meter use its rootclass in storybook #3231

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

jawinn
Copy link
Collaborator

@jawinn jawinn commented Oct 10, 2024

Description

An update to the meter component storybook templates to help with simplifying the comparison between rootClass values in #3129. The Meter component was the only component using a rootClass arg value that is not unique and its own (previously it was using spectrum-ProgressBar).

Details

Meter's Storybook template was using the rootClass for progress bar, rather than its own rootClass. It was set up this way because of the way the two components are housed together, and meter primarily just uses ProgressBar, with some added classes.

This value not being unique made it difficult to compare and match up the value of rootClass in the package.json spectrum data to the actual rootClass defined in the story files default args.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

  • Meter still displays correctly
  • The static color background color option still works in meter; the class spectrum-Meter--staticWhite gets applied to the component root and the teal background still appears.

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • The pages render correctly, are accessible, and are responsive.
  1. If components have been modified, VRTs have been run on this branch:
  • VRTs have been run and looked at.
  • Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

To-do list

  • I have read the contribution guidelines.
  • If my change impacts other components, I have tested to make sure they don't break.
  • ✨ This pull request is ready to merge. ✨

Copy link

changeset-bot bot commented Oct 10, 2024

⚠️ No Changeset found

Latest commit: a30fe10

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Oct 10, 2024

File metrics

Summary

Total size: 4.31 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@jawinn jawinn mentioned this pull request Oct 10, 2024
51 tasks
@jawinn jawinn force-pushed the jawinn/fix-meter-storybook-rootclass branch 3 times, most recently from 1e1a0b3 to 4c87ab0 Compare October 11, 2024 15:21
Copy link
Contributor

github-actions bot commented Oct 11, 2024

🚀 Deployed on https://pr-3231--spectrum-css.netlify.app

@jawinn jawinn marked this pull request as ready for review October 11, 2024 15:28
@jawinn jawinn force-pushed the jawinn/fix-meter-storybook-rootclass branch from 4c87ab0 to eb69843 Compare October 11, 2024 15:30
Copy link
Collaborator

@marissahuysentruyt marissahuysentruyt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for tracking this down! This definitely helps with the doc block PR!

Meter's Storybook template was using the rootClass for progress bar,
rather than its own rootClass. It was set up this way because of the
way the two components are housed together, and meter primarily just
uses ProgressBar, with some added classes.

This value not being unique made it difficult to compare and match up
the value of rootClass in the packageJson spectrum data to the actual
rootClass defined in the story files default args.
@marissahuysentruyt marissahuysentruyt force-pushed the jawinn/fix-meter-storybook-rootclass branch from eb69843 to a30fe10 Compare October 16, 2024 13:56
@marissahuysentruyt marissahuysentruyt merged commit 50372e0 into main Oct 16, 2024
12 checks passed
@marissahuysentruyt marissahuysentruyt deleted the jawinn/fix-meter-storybook-rootclass branch October 16, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants