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: handle transitionend together with animationend #2773

Merged
merged 1 commit into from
Oct 12, 2024

Conversation

limonte
Copy link
Member

@limonte limonte commented Oct 12, 2024

fixes #2743

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of closing animations to prevent memory leaks.
    • Enhanced event handling for popup animations to ensure proper scrolling visibility.
  • Refactor

    • Improved readability and maintainability of event handler functions related to animations.

Copy link
Contributor

coderabbitai bot commented Oct 12, 2024

Walkthrough

The changes involve improvements to animation event handling in two JavaScript files: close.js and openPopup.js. In close.js, a named function replaces an anonymous function for handling animation events, enhancing readability and allowing for better cleanup of event listeners. In openPopup.js, a new event listener is added to manage scrolling visibility after animations. These updates do not alter the external behavior of the functions but refine the internal logic for managing animations and event listeners.

Changes

File Path Change Summary
src/instanceMethods/close.js Improved animation event handling by replacing an anonymous function with a named function for animationend and transitionend events. Enhanced cleanup of event listeners.
src/utils/openPopup.js Added a new transitionend event listener in setScrollingVisibility to manage scrolling visibility after animations. Updated swalOpenAnimationFinished to clean up event listeners.

Possibly related PRs

  • fix: use animationend event #2770: This PR modifies the close.js and openPopup.js files to standardize the use of the animationend event, which directly relates to the changes made in the main PR that also focus on improving animation event handling in these files.

Poem

🐇 In the land of popups, where animations play,
A rabbit hops swiftly, brightening the day.
With events now named, and cleanup in sight,
Our close and open dance with pure delight!
So let the transitions flow, smooth and free,
For every popup's joy is a sight to see! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@limonte limonte force-pushed the fix/handle-transitionend branch from 75c5c1a to 292511c Compare October 12, 2024 17:47
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
src/instanceMethods/close.js (1)

190-199: Improved animation event handling, consider performance optimization

The changes to the animatePopup function are well-implemented and address potential issues with animation handling:

  1. The introduction of the named function swalCloseAnimationFinished improves readability and allows for easier removal of event listeners.
  2. Adding listeners for both 'animationend' and 'transitionend' ensures compatibility with different types of animations.
  3. The function removes itself after execution, preventing multiple calls.

Consider replacing the delete operator with an undefined assignment for potential performance improvement:

- delete globalState.swalCloseEventFinishedCallback
+ globalState.swalCloseEventFinishedCallback = undefined

This change addresses the static analysis hint while maintaining the intended functionality.

🧰 Tools
🪛 Biome

[error] 193-193: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4ed136a and 292511c.

📒 Files selected for processing (2)
  • src/instanceMethods/close.js (1 hunks)
  • src/utils/openPopup.js (2 hunks)
🧰 Additional context used
🪛 Biome
src/instanceMethods/close.js

[error] 193-193: Avoid the delete operator which can impact performance.

Unsafe fix: Use an undefined assignment instead.

(lint/performance/noDelete)

🔇 Additional comments (3)
src/utils/openPopup.js (3)

60-60: Excellent addition for comprehensive event listener cleanup!

The addition of popup.removeEventListener('transitionend', swalOpenAnimationFinished) is a great improvement. It ensures that both 'animationend' and 'transitionend' event listeners are properly removed when the animation or transition finishes. This change prevents potential memory leaks and unexpected behavior, especially in scenarios where the popup might be opened multiple times.


72-72: Great enhancement for handling both animations and transitions!

The addition of popup.addEventListener('transitionend', swalOpenAnimationFinished) is a valuable improvement. This change allows the setScrollingVisibility function to handle both CSS animations and transitions effectively. By listening for both 'animationend' and 'transitionend' events, you ensure that the scrolling visibility is correctly set to 'auto' after either type of animation completes. This enhancement provides more flexibility in how the popup's appearance can be animated or transitioned.


60-60: Summary: Improved event handling for animations and transitions

The changes made to this file significantly improve the handling of both CSS animations and transitions for the popup. By adding 'transitionend' event listeners and their corresponding cleanup, you've ensured that the popup behaves correctly regardless of whether it uses CSS animations or transitions for its opening effect. This enhancement increases the flexibility of the popup's animation options and prevents potential issues related to event listener management. Great job on these improvements!

Also applies to: 72-72

@limonte limonte changed the title fix: handle transitionend fix: handle transitionend together with animationend Oct 12, 2024
@limonte limonte merged commit 3441fc5 into main Oct 12, 2024
3 checks passed
@limonte limonte deleted the fix/handle-transitionend branch October 12, 2024 20:41
github-actions bot pushed a commit that referenced this pull request Oct 12, 2024
## [11.14.3](v11.14.2...v11.14.3) (2024-10-12)

### Bug Fixes

* handle `transitionend` together with `animationend` ([#2773](#2773)) ([3441fc5](3441fc5))
@limonte
Copy link
Member Author

limonte commented Oct 12, 2024

🎉 This PR is included in version 11.14.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

Adding Custom Animations Causes DOM Not to be Destroyed
1 participant