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(actiongroup): migrating docs to storybook #3160

Merged
merged 7 commits into from
Oct 8, 2024

Conversation

aramos-adobe
Copy link
Collaborator

Description

Adding horizontal, vertical, and justified layouts

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.
  • I have tested these changes in Windows High Contrast mode.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

Copy link

changeset-bot bot commented Sep 24, 2024

⚠️ No Changeset found

Latest commit: f7af338

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 Sep 24, 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.

Copy link
Contributor

github-actions bot commented Sep 24, 2024

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

@rise-erpelding rise-erpelding self-requested a review October 1, 2024 11:10
Copy link
Collaborator

@rise-erpelding rise-erpelding left a comment

Choose a reason for hiding this comment

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

This looks really nice! I really like the way that you've grouped things (with the default, icon-only, quiet variants all together) to keep the number of variants from feeling overwhelming or confusing. I also really like that there are lots of examples (particularly in the sizing) of icons & text together in an action button. And the Overflow section and testing coverage is such a great addition! Overall this is such a huge improvement over the old docs site.

There were two small things I noticed that I think could use improvement, but I'm happy to hear arguments to the contrary:

  • We're not showing the emphasized variant for action group. Since we generally do show it for components that have it, and there's a control for it, and we're testing it, it seems like something we ought to be displaying on our Docs page.
  • For testing coverage, there are lots of variants, I don't know that every single combination needs to be tested (for instance icon-only compact, or compact quiet, or justified compact, etc.), but one case that I think would be beneficial would be more for vertical action groups, particularly vertical compact.

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.

Nice work, this one is coming along!

I think I agree with Rise, that if we're testing the isEmphasized, maybe we should showcase it on the docs page. (which I think you actually just pushed up a fix for). I had some similar thoughts around the isDisabled.

I had some comments on adding controls too, so let me know what you think!

Copy link
Collaborator

@rise-erpelding rise-erpelding left a comment

Choose a reason for hiding this comment

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

I can see lots of those extra suggestions were added--this looks great!

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 making those updates! I found a few more updates I think we should make 😊

components/actiongroup/stories/actiongroup.stories.js Outdated Show resolved Hide resolved
components/actiongroup/stories/actiongroup.stories.js Outdated Show resolved Hide resolved
Comment on lines 180 to 182
HorizontalSizing.parameters = {
chromatic: { disableSnapshot: true },
};
Copy link
Collaborator

Choose a reason for hiding this comment

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

Whoops- this is duplicated on this story.

components/actiongroup/stories/actiongroup.stories.js Outdated Show resolved Hide resolved
components/actiongroup/stories/actiongroup.stories.js Outdated Show resolved Hide resolved
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.

@aramos-adobe thanks for making all of the updates! This looks fantastic! I think all of the additions gives users so much context and explanation for this component now, in comparison to the current docs site!

I did a quick check of the CHANGELOG and I think the migration guide is all included, so boom- approved!

@aramos-adobe aramos-adobe merged commit 96df53b into main Oct 8, 2024
12 checks passed
@aramos-adobe aramos-adobe deleted the aramos-adobe/css928-actiongroup-migration-docs branch October 8, 2024 14:49
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.

4 participants