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(search): storybook doc migrations #3174

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

aramos-adobe
Copy link
Collaborator

@aramos-adobe aramos-adobe commented Sep 27, 2024

Description

Added disabled, quiet, helptext docs

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

Search now has the HelpText component in components/search/template.js.

  • Added example for Disabled state
  • Added example for Sizes
  • Added help text boolean control in story
  • No changes to the VRT suite

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 27, 2024

⚠️ No Changeset found

Latest commit: 91fe168

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 27, 2024

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

Copy link
Contributor

github-actions bot commented Sep 27, 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
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 great! I left one small comment about how our clear button behaves, but I don't think that necessarily needs to block merging!

* A search field is used for searching and filtering items.
*
* ## Usage Notes
* This component contains a single input field with both a magnifying glass icon and a clear (“reset”) button displayed within it. When making use of this component, the clear button should only be displayed when the input has a value.
Copy link
Collaborator

Choose a reason for hiding this comment

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

the clear button should only be displayed when the input has a value.

I'm seeing the clear button on this all the time (except when the component is disabled), I'm wondering if that's a change we would want to make to our template at some point?

@castastrophe castastrophe force-pushed the aramos-adobe/css938-search-migration-docs branch from 91fe168 to 71eff67 Compare October 1, 2024 15:48
@castastrophe castastrophe enabled auto-merge (squash) October 1, 2024 15:49
@castastrophe castastrophe merged commit 4efcfcf into main Oct 1, 2024
17 of 24 checks passed
@castastrophe castastrophe deleted the aramos-adobe/css938-search-migration-docs branch October 1, 2024 15:57
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