search

tsparticles / svelte

Svelte tsParticles official plugin
MIT License
41 stars 4 forks source link

Fix particles beeing loaded before component ist mounted on navigation in SvelteKit #55

Closed SAG-Storck closed 1 month ago

SAG-Storck commented 2 months ago

When navigating back to a page that includes the Particles component in SvelteKit (at least in Svelte 5), the load function of the engine is sometimes ran before the Particles component is fully mounted.

When this happens, the DOM element ist not present yet and as a fallback, the engine will create a new element directly below the body. This will cause a duplicate particles div to exist.

By checking if the component is mounted before loading the particles, this should be prevented.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The update introduces a new boolean variable mounted in the Particles.svelte component. This variable enhances the component's lifecycle management by ensuring that certain actions within the loadParticles function only execute if the component is still mounted, preventing potential errors related to asynchronous operations after the component has been unmounted.

Changes

File Path Change Summary
components/.../Particles.svelte Added mounted variable and updated loadParticles logic.

Poem

🐰✨ In the realm of code, where particles dance,
A wise rabbit adds a check with a glance.
"Are we still mounted?" it asks with care,
Ensuring stability is present, not just flair.
Hop and code, let errors be banned! 🎉
🐰✨

Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between d760dcdc09d6593dd493c2c5bce3d7fd13f1a29c and feeb2d3708b3dde09a34a3db05a8fa5449882e21.
Files selected for processing (1) * components/svelte/src/lib/Particles.svelte (2 hunks)
Additional comments not posted (3)
components/svelte/src/lib/Particles.svelte (3)
`12-12`: The introduction of the `mounted` variable is correctly implemented for tracking the component's mount state. --- `49-49`: Setting `mounted` to `true` in `onMount` and the non-blocking call to `loadParticles` are correctly implemented to align with component lifecycle events. --- `56-56`: The addition of the `mounted` check in `loadParticles` is crucial for ensuring that the component is fully ready before loading particles, thus addressing the issue of premature loading.
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Solcany commented 1 month ago

Hey, thanks for your work, can this be merged into the main? Due to this bug Particles is unusable in Sveltekit apps