Skip to content

chore(dialog): use isOpen type for open control#3562

Merged
marissahuysentruyt merged 1 commit into
spectrum-twofrom
marissahuysentruyt/fix-dialog-open-control
Feb 17, 2025
Merged

chore(dialog): use isOpen type for open control#3562
marissahuysentruyt merged 1 commit into
spectrum-twofrom
marissahuysentruyt/fix-dialog-open-control

Conversation

@marissahuysentruyt
Copy link
Copy Markdown
Collaborator

@marissahuysentruyt marissahuysentruyt commented Feb 17, 2025

Description

This PR correctly implements the isOpen shared type on the dialog pages. This should correct the display of the isOpen control.

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

  • Pull down the branch to run locally or visit the deploy preview
  • Visit the dialog docs page.
  • In the Properties table towards the bottom of the page, verify the "Open" control is capitalized. It should not be displayed or formatted like a variable (i.e. isOpen).
Screenshot 2025-02-17 at 11 19 33 AM Screenshot 2025-02-17 at 11 22 37 AM

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

Before 🚫
Screenshot 2025-02-17 at 11 37 41 AM
Screenshot 2025-02-17 at 11 37 32 AM

After ✅
Screenshot 2025-02-17 at 11 22 37 AM

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • ✨ This pull request is ready to merge. ✨

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Feb 17, 2025

🦋 Changeset detected

Latest commit: f78350f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@spectrum-css/infieldprogresscircle Major

Not sure what this means? Click here to learn what changesets are.

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

@marissahuysentruyt marissahuysentruyt changed the base branch from main to spectrum-two February 17, 2025 15:54
@marissahuysentruyt marissahuysentruyt self-assigned this Feb 17, 2025
@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. storybook labels Feb 17, 2025
@marissahuysentruyt marissahuysentruyt changed the title Marissahuysentruyt/fix dialog open control chore(dialog): use isOpen type for open control Feb 17, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 17, 2025

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 17, 2025

File metrics

Summary

Total size: 1.42 MB*

🎉 No changes detected in any packages

* Size is the sum of all main files for packages in the library.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@marissahuysentruyt marissahuysentruyt added the skip_vrt Add to a PR to skip running VRT (but still pass the action) label Feb 17, 2025
@marissahuysentruyt marissahuysentruyt marked this pull request as ready for review February 17, 2025 16:38
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 ready-for-review 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