Skip to content

fix: replace throttle in useScroll with watchThrottled for shadow DOM…#111

Merged
hexqi merged 1 commit intoopentiny:release/v0.2.xfrom
gene9831:fix/useScroll-in-shadow-dom
Jun 13, 2025
Merged

fix: replace throttle in useScroll with watchThrottled for shadow DOM…#111
hexqi merged 1 commit intoopentiny:release/v0.2.xfrom
gene9831:fix/useScroll-in-shadow-dom

Conversation

@gene9831
Copy link
Copy Markdown
Collaborator

@gene9831 gene9831 commented Jun 13, 2025

… compatibility

Summary by CodeRabbit

  • Bug Fixes
    • Improved scrolling behavior in suggestion popovers to ensure smoother performance and compatibility with shadow DOM environments.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 13, 2025

Walkthrough

The code updates how scrolling state is tracked in a Vue component. Instead of using the throttle option in useScroll, it now uses watchThrottled to manually throttle updates to the isScrolling state, addressing issues with shadow DOM compatibility.

Changes

File(s) Change Summary
packages/components/src/suggestion-popover/index.vue Replaced throttled useScroll with manual throttling using watchThrottled for isScrolling state

Poem

A scroll in the shadow, a gentle new way,
Throttle by hand, let the scroll state play.
Vue’s popover listens, with patience anew,
No errors in darkness, just updates that grew.
The rabbit approves, with a hop and a cheer,
For smoother suggestions, all crystal clear!

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/components/src/suggestion-popover/index.vue

Oops! Something went wrong! :(

ESLint: 9.28.0

Error: The 'jiti' library is required for loading TypeScript configuration files. Make sure to install it.
at /node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/config/config-loader.js:145:10
at async loadTypeScriptConfigFileWithJiti (/node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/config/config-loader.js:144:3)
at async loadConfigFile (/node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/config/config-loader.js:266:11)
at async ConfigLoader.calculateConfigArray (/node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/config/config-loader.js:589:23)
at async #calculateConfigArray (/node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/config/config-loader.js:770:23)
at async /node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/eslint/eslint.js:761:6
at async Promise.all (index 0)
at async ESLint.lintFiles (/node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/eslint/eslint.js:758:19)
at async Object.execute (/node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/lib/cli.js:637:14)
at async main (/node_modules/.pnpm/eslint@9.28.0/node_modules/eslint/bin/eslint.js:175:19)

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch fix/useScroll-in-shadow-dom
  • Post Copyable Unit Tests in Comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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.

@gene9831 gene9831 marked this pull request as draft June 13, 2025 03:52
@gene9831 gene9831 marked this pull request as ready for review June 13, 2025 06:16
@gene9831
Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 13, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Copy Markdown

@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

🧹 Nitpick comments (1)
packages/components/src/suggestion-popover/index.vue (1)

96-105: Minor clean-up: capture the stop-handle returned by watchThrottled

watchThrottled returns a disposer that Vue will usually auto-collect under <script setup>, but explicitly storing it increases clarity and lets you stop the watcher manually should the need arise (e.g., when toggling virtual scrollers).

 const { isScrolling: listScrolling } = useScroll(listRef)
-watchThrottled(
+const stopScrollingWatcher = watchThrottled(
   listScrolling,
   (value) => {
     isScrolling.value = value
   },
   { throttle: 100, leading: true, trailing: true },
 )

Not critical, yet improves maintainability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c9f666 and edfc93d.

📒 Files selected for processing (1)
  • packages/components/src/suggestion-popover/index.vue (2 hunks)
🔇 Additional comments (1)
packages/components/src/suggestion-popover/index.vue (1)

2-9:

Details

✅ Verification successful

Ensure watchThrottled exists in the installed @vueuse/core version

watchThrottled landed in @vueuse/core v9.1.0.
If the repository is still on an older minor, this import will break the build.

Run the quick check below to confirm the declared version in package.json (or pnpm-lock / yarn.lock):


🏁 Script executed:

#!/bin/bash
# Print the declared vueuse version so we know whether watchThrottled is available
jq -r '.dependencies["@vueuse/core"] // .devDependencies["@vueuse/core"]' package.json

Length of output: 93


🏁 Script executed:

#!/bin/bash
echo "1. Searching for @vueuse/core in all package.json files"
find . -type f -name 'package.json' -exec grep -n '"@vueuse/core"' {} \; || true

echo
echo "2. Checking lockfiles for installed @vueuse/core versions"
for lockfile in pnpm-lock.yaml yarn.lock package-lock.json; do
  if [ -f "$lockfile" ]; then
    echo "$lockfile:"
    grep -n "@vueuse/core@" "$lockfile" || echo "  No entries found"
  fi
done

Length of output: 628


No action required — watchThrottled is supported in @vueuse/core v13.1.0
Verified that package.json declares "@vueuse/core": "^13.1.0", which is ≥ 9.1.0.

@hexqi hexqi merged commit f5b3e85 into opentiny:release/v0.2.x Jun 13, 2025
@gene9831 gene9831 deleted the fix/useScroll-in-shadow-dom branch June 13, 2025 06:59
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.

3 participants