fix: spinner may stop playing animation after dismiss

[mynetfan]

Description

修复Spinner组件在未显示时仍然播放动画的问题。
该问题将导致即使页面处于闲置状态，后台Dom数量不能稳定且Cpu占用率也没有维持在应有的低水平

该修复方案仅仅在不显示Spinner时暂停了动画，没有改变dom结构。
fix: #5318

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features
  • Introduced dynamic control over the spinner animation state with a new paused class.
• Style
  • Updated spinner component's class binding to use dynamic rendering.
  • Added new CSS styles for the paused class to control animation playback.
  • Simplified loading logic by removing related comments.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 50ced79

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/@core/ui-kit/shadcn-ui/src/components/spinner/spinner.vue

Oops! Something went wrong! :(

ESLint: 9.17.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

Walkthrough

The pull request introduces changes to the spinner.vue component in the UI kit. It implements a new conditional class binding for the loader <div>, which applies the paused class based on the renderSpinner reactive reference. This allows for dynamic control of the animation state, pausing it when renderSpinner is false. Additionally, new CSS styles for the .paused class have been added, while comments related to the startTime variable have been removed, simplifying the loading logic without altering the core functionality.

Changes

File	Change Summary
packages/@core/ui-kit/shadcn-ui/src/components/spinner/spinner.vue	- Added conditional class binding for loader <div> based on renderSpinner - Introduced new CSS styles for .paused class - Removed comments related to startTime variable

Assessment against linked issues

Objective	Addressed	Explanation
Reduce CPU Usage [#5318]	❓	The impact of the spinner changes on CPU usage is unclear and requires further investigation.

Suggested Reviewers

• anncwb
• vince292007

Poem

🐰 A spinner's dance, a class so light,
Reactive binding, rendering just right.
No more comments, sleek and clean,
Performance whispers, barely seen.
Code rabbit hops with glee tonight! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 05cca66 and 50ced79.

📒 Files selected for processing (1)

• packages/@core/ui-kit/shadcn-ui/src/components/spinner/spinner.vue (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/@core/ui-kit/shadcn-ui/src/components/spinner/spinner.vue

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: Lint (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: Test (windows-latest)
• GitHub Check: post-update (windows-latest)
• GitHub Check: Check (ubuntu-latest)
• GitHub Check: Test (ubuntu-latest)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: post-update (ubuntu-latest)

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/@core/ui-kit/shadcn-ui/src/components/spinner/spinner.vue (1)

Line range hint 28-42: Consider adding a safeguard for rapid state changes.

The current implementation might lead to inconsistent states if the spinning prop toggles rapidly. Consider clearing both state flags when spinning becomes false:

 watch(
   () => props.spinning,
   (show) => {
     if (!show) {
       showSpinner.value = false;
+      renderSpinner.value = false;
       clearTimeout(timer.value);
       return;
     }

This ensures the animation stops immediately when dismissed, preventing any lingering animations.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8cf6e8e and 05cca66.

📒 Files selected for processing (1)

• packages/@core/ui-kit/shadcn-ui/src/components/spinner/spinner.vue (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (9)

• GitHub Check: Test (windows-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: Test (ubuntu-latest)
• GitHub Check: Lint (windows-latest)
• GitHub Check: Check (ubuntu-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: post-update (windows-latest)
• GitHub Check: post-update (ubuntu-latest)

🔇 Additional comments (3)

packages/@core/ui-kit/shadcn-ui/src/components/spinner/spinner.vue (3)

Line range hint 28-29: LGTM! Good simplification of the loading logic.

Removing the unnecessary performance timing and introducing renderSpinner ref provides cleaner state management for the animation.

Also applies to: 31-31

---

76-77: Good fix for the animation control!

The dynamic class binding using renderSpinner ensures the animation stops when the spinner is dismissed, which should reduce unnecessary CPU usage. The base styles remain intact while the animation classes are toggled appropriately.

---

Line range hint 28-42: Verify the fix resolves the CPU usage issue.

The implementation looks good and should fix the spinner animation issue. To verify:

1. The animation now stops properly on dismiss through renderSpinner
2. CPU usage should decrease when spinner is hidden

Please test the following scenarios:

• Rapid toggling of the spinner
• Long-running spinner followed by dismiss
• Multiple spinners on the same page

Would you like me to create a test suite covering these scenarios?

Also applies to: 76-77