Skip to content

docs(avatar): update sizing documentation #3483

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

Conversation

marissahuysentruyt
Copy link
Collaborator

@marissahuysentruyt marissahuysentruyt commented Jan 8, 2025

Description

This PR updates the sizing documentation for avatar. There was an older table that listed the available sizes, but only for S1 avatars. The S2 avatar has more sizes available, so the Sizing story has now been updated to reflect that.

No changeset or VRTs needed since this was a documentation update only.

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

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.

Screenshots

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

@marissahuysentruyt marissahuysentruyt added documentation Because documentation is important and shouldn't be broken size-1 XS ~1-6hrs; nearly trivial, a few hours, could do more than one in a single day. skip_vrt Add to a PR to skip running VRT (but still pass the action) S2 Spectrum 2 labels Jan 8, 2025
@marissahuysentruyt marissahuysentruyt self-assigned this Jan 8, 2025
Copy link

changeset-bot bot commented Jan 8, 2025

⚠️ No Changeset found

Latest commit: 369d01c

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 Jan 8, 2025

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

Copy link
Contributor

github-actions bot commented Jan 8, 2025

File metrics

Summary

Total size: 1.73 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.

Comment on lines -80 to -90
* Avatar is available in many sizes using the required `.spectrum-Avatar--size<number>` class. The available size classes are:

- `spectrum-Avatar--size50`
- `spectrum-Avatar--size75`
- `spectrum-Avatar--size100`
- `spectrum-Avatar--size200`
- `spectrum-Avatar--size300`
- `spectrum-Avatar--size400`
- `spectrum-Avatar--size500`
- `spectrum-Avatar--size600`
- `spectrum-Avatar--size700`
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I elected to remove this list. At first I was just going to add the new S2 sizes, but there's 8 additional sizes, that list got really long, and we're displaying all of the sizes in the canvas. So I worked the sentence here into the first paragraph and updated the range that's referenced instead.

@marissahuysentruyt marissahuysentruyt marked this pull request as ready for review January 8, 2025 15:44
@marissahuysentruyt marissahuysentruyt merged commit dd96363 into spectrum-two Jan 8, 2025
12 checks passed
@marissahuysentruyt marissahuysentruyt deleted the marissahuysentruyt/docs-add-avatar-sizing-table branch January 8, 2025 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Because documentation is important and shouldn't be broken S2 Spectrum 2 size-1 XS ~1-6hrs; nearly trivial, a few hours, could do more than one in a single day. skip_vrt Add to a PR to skip running VRT (but still pass the action)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants