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

do not allow non-modal Alpha::Dialog #2582

Merged
merged 3 commits into from
Mar 26, 2024

Conversation

keithamus
Copy link
Member

@keithamus keithamus commented Feb 9, 2024

Authors: Please fill out this form carefully and completely.

Reviewers: By approving this Pull Request you are approving the code change, as well as its deployment and mitigation plans.
Please read this description carefully. If you feel there is anything unclear or missing, please ask for updates.

What are you trying to accomplish?

Our Primer::Alpha::Dialog component should only ever be shown as modal. Today it's possible to make the Dialog initially open by calling .new(open: true).

While it is certainly contentious to have an initially open Dialog, it is still possible to get the Dialog in a weird state where it's [open] as non-modal.

This patch ensures that any [open]:not(:modal) dialogs are closed and re-opened as modal.

Screenshots

See VRT.

Integration

N/A

List the issues that this change affects.

Closes #2581

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

What approach did you choose and why?

Anything you want to highlight for special attention from reviewers?

Accessibility

  • No new axe scan violation - This change does not introduce any new axe scan violations.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews (Lookbook)
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

Copy link
Contributor

github-actions bot commented Feb 9, 2024

⚠️ Visual differences found

Our visual comparison tests found UI differences. Please review the differences by viewing the files changed tab to ensure that the changes were intentional.

Review visual differences

Copy link

changeset-bot bot commented Feb 9, 2024

🦋 Changeset detected

Latest commit: 7b56f25

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

This PR includes changesets to release 1 package
Name Type
@primer/view-components Patch

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

@keithamus keithamus force-pushed the do-not-allow-non-modal-alpha-dialog branch from 58c0438 to 5552df5 Compare February 9, 2024 18:10
@keithamus keithamus marked this pull request as ready for review February 9, 2024 18:20
@keithamus keithamus requested review from a team and camertron February 9, 2024 18:20
Copy link
Contributor

@camertron camertron left a comment

Choose a reason for hiding this comment

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

This seems cool 😎 We should make sure we test it well before release. Are there any dialogs in dotcom that start in an open state?

@keithamus
Copy link
Member Author

A quick search across the codebase says no, I can’t see any instances that do this in dotcom or education.

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.

Positioning and background of Dialog is wrong when opened without a trigger button
2 participants