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

Fix modal fading issue #30122

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

madalynbartman
Copy link

@madalynbartman madalynbartman commented Dec 21, 2024

Closes #29247

What I did

  • Add default onInteractOutside event handler to prevent the modal from closing unexpectedly.

  • Make sure handleInteractOutside event parameter matches expected types.

  • Update modal component to only perform onInteractOutside if an actual handler is provided. Otherwise, default to no-op.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run a Sandbox
  2. Go to http://localhost:6006/?path=/story/components-modal--default
  3. Verify clicking outside the modal does not close it unexpectedly or cause any fading issues
  4. Repeat with remaining modals under the Modal drop down
  5. Look at the console logs to ensure the onInteractOutside event handler is triggered correctly when interacting outside the modal

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Fixes modal fading and interaction issues by modifying CSS animations and event handling to prevent unintended behavior when interacting outside the modal.

  • Added explicit opacity: 1 and transition: none to Overlay and Container components in /code/core/src/components/components/Modal/Modal.styled.tsx
  • Added default onInteractOutside handler in /code/core/src/components/components/Modal/Modal.tsx to prevent unexpected modal closing
  • Updated modal component to only trigger onInteractOutside when handler is provided
  • Fixed issue where screen would become unclickable when interacting with elements outside modal

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines 39 to +41
animation: `${fadeIn} 200ms`,
opacity: 1,
transition: 'none',
Copy link
Contributor

Choose a reason for hiding this comment

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

style: consider using a CSS custom property for the opacity value to make it more maintainable

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Elements > Modal> Screen fading issue
1 participant