Skip to content

fix(popper): [tooltip,popover] enhance the isScrollElement function to add judgment on element type and scroll bar #3411

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

Merged
merged 1 commit into from
May 9, 2025

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented May 9, 2025

fix(popper): 增强isScrollElement函数,增加对元素类型和滚动条的判断
image

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes
    • Improved detection of scrollable elements, ensuring more accurate behavior when identifying elements with scrollable content.

Copy link

coderabbitai bot commented May 9, 2025

Walkthrough

The isScrollElement function in packages/utils/src/popper/index.ts was updated to more accurately determine if an element is scrollable. The new implementation adds checks for valid elements, uses a regex to match overflow-related CSS properties, and verifies that the element has actual scrollable content.

Changes

File(s) Change Summary
packages/utils/src/popper/index.ts Enhanced isScrollElement to check for valid elements, match overflow properties with regex, and verify actual scrollable content.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant isScrollElement
    participant Element

    Caller->>isScrollElement: Call with Element
    isScrollElement->>isScrollElement: Check if Element is valid and element node
    alt Invalid Element
        isScrollElement-->>Caller: Return false
    else Valid Element
        isScrollElement->>Element: Get computed styles (overflow, overflow-x, overflow-y)
        isScrollElement->>isScrollElement: Test overflow properties with regex
        isScrollElement->>Element: Compare scrollHeight/clientHeight and scrollWidth/clientWidth
        alt Overflow matches and content is scrollable
            isScrollElement-->>Caller: Return true
        else
            isScrollElement-->>Caller: Return false
        end
    end
Loading

Poem

A scroll check refined, with care and delight,
Now peeks at the styles, and content in sight.
No more false alarms, or scrolls missed in haste,
Only true scrollable elements embraced.
With regex and logic, our function’s anew—
A hop, a skip, and a scroll just for you!
🐇✨

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/utils/src/popper/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 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 d9135bb and 446e2f2.

📒 Files selected for processing (1)
  • packages/utils/src/popper/index.ts (1 hunks)
🔇 Additional comments (1)
packages/utils/src/popper/index.ts (1)

101-115: Great improvement to the isScrollElement function!

The updated implementation significantly enhances the accuracy of detecting scrollable elements by:

  1. Adding a guard clause to prevent errors with invalid elements
  2. Using a regex pattern to match a wider range of overflow values ('auto', 'scroll', 'overlay', 'clip')
  3. Checking for actual scrollable content by comparing scrollHeight/scrollWidth with clientHeight/clientWidth

This change will reduce false positives when elements have overflow properties set but don't actually have content that overflows.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • 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.

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 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.

@github-actions github-actions bot added the bug Something isn't working label May 9, 2025
Copy link

Walkthrough

The PR enhances the isScrollElement function by adding checks for element type and scrollbar presence. It now verifies if an element is a valid node and checks for scrollable content using computed styles and overflow properties.

Changes

File Summary
packages/utils/src/popper/index.ts Enhanced isScrollElement to include checks for element type and scrollbar presence, using computed styles and overflow properties.

@@ -99,13 +99,19 @@ const getBoundingClientRect = (el: HTMLElement) => {

/** 判断el的overflow是不是可能滚动的 */
const isScrollElement = (el: HTMLElement) => {
const scrollTypes = ['scroll', 'auto']
if (!el || el.nodeType !== 1) {

Choose a reason for hiding this comment

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

Ensure that the element is a valid node before proceeding with overflow checks. This prevents errors when el is null or not an element node.

@zzcr zzcr changed the title fix(popper): enhance the isScrollElement function to add judgment on element type and scroll bar fix(popper): [tooltip,popover] enhance the isScrollElement function to add judgment on element type and scroll bar May 9, 2025
@kagol kagol merged commit 3cb511e into dev May 9, 2025
16 checks passed
@kagol kagol deleted the fix-dropdown-in-grid-scroll-0509 branch May 9, 2025 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants