Skip to content

Conversation

@shenjunjian
Copy link
Collaborator

@shenjunjian shenjunjian commented Mar 14, 2025

PR

PR Checklist

修复popper用在自定义元素内部时,向上找父节点报错的问题。 ---- 同步代码

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
    • Enhanced handling of shadow DOM elements to ensure consistent element recognition, accurate positioning, and smoother layout behavior across key components.

@coderabbitai
Copy link

coderabbitai bot commented Mar 14, 2025

Walkthrough

The changes update three functions across different modules to improve support for Shadow DOM elements. In each case, the logic now checks for the presence of a host property and reassigns the element or reference accordingly. This adjustment simplifies previous conditions such as checking for getAttribute and allows the functions to correctly traverse the DOM hierarchy when encountering Shadow DOM components.

Changes

File(s) Change Summary
packages/renderless/.../dom.ts, packages/utils/.../index.ts, packages/vue-hooks/.../vue-popper.ts Updated functions (hasDataTag, isFixed, getReferMaxZIndex) to handle Shadow DOM elements by checking for a host property and reassigning the element/reference accordingly, simplifying earlier attribute checks.

Sequence Diagram(s)

sequenceDiagram
  participant Caller
  participant Function
  participant Element
  
  Caller->>Function: Call function with element
  Function->>Element: Check for 'host' property
  alt Element has 'host'
      Element-->>Function: Return host
      Function->>Function: Reassign element = element.host
  else No host
      Element-->>Function: Continue with original element
  end
  Function->>Caller: Return processed result
Loading

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • zzcr

Poem

I'm a rabbit with a coding flair,
Hopping through DOMs with gentle care.
Now each shadow finds its home so bright,
With host in check, everything feels right.
Cheerful hops and bouncy delight,
Celebrating fixes from morning to night!
🐰🌟

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.

 ERR_PNPM_OPTIONAL_DEPS_REQUIRE_PROD_DEPS  Optional dependencies cannot be installed without production dependencies

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 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 9e381e3 and f5cdc6c.

📒 Files selected for processing (3)
  • packages/renderless/src/grid/utils/dom.ts (1 hunks)
  • packages/utils/src/popper/index.ts (1 hunks)
  • packages/vue-hooks/src/vue-popper.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (3)
packages/utils/src/popper/index.ts (1)

79-82: Good addition for Shadow DOM support.

This change correctly handles the case when encountering a shadow root during DOM traversal by reassigning el to its host element. This allows the isFixed function to properly continue up the DOM tree when determining if an element has a fixed positioned ancestor.

packages/vue-hooks/src/vue-popper.ts (1)

61-64: Well-structured check for shadow root elements.

The implementation correctly identifies shadow roots and accesses their host elements using a proper type check with instanceof ShadowRoot. This ensures correct z-index calculation when traversing the DOM tree through shadow boundaries.

packages/renderless/src/grid/utils/dom.ts (1)

191-198:

✅ Verification successful

Improved support for Shadow DOM but simplified error checking.

The code now handles shadow roots correctly, but it has removed what appears to be a previous check for getAttribute functionality. While this simplifies the code, ensure this doesn't impact scenarios where non-DOM elements might be passed to this function.

Run the following script to verify if there are any callers that might pass non-DOM elements to this function:


🏁 Script executed:

#!/bin/bash
# Search for calls to hasDataTag that might pass non-DOM elements
rg -A 3 -B 3 "hasDataTag\(" packages/

Length of output: 595


Shadow DOM handling verified and error checking deemed safe.
The change to reassign el to el.host when encountering a shadow root correctly supports Shadow DOM. Our grep check confirms that all callers (e.g., in the event-handling loop) first validate the element using a nodeType check, which ensures that only DOM elements are passed to this function. The removal of the previous getAttribute check does not appear to introduce issues for non-DOM inputs.

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

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 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 Mar 14, 2025
@petercat-assistant
Copy link

Walkthrough

This PR addresses an issue with the popper component when used inside custom elements. It fixes errors related to finding parent nodes and retrieving the z-index by handling cases where shadow DOMs are involved.

Changes

File Summary
packages/renderless/src/grid/utils/dom.ts Adjusted logic to handle shadow DOMs by checking for el.host and updating the element reference accordingly.
packages/utils/src/popper/index.ts Added handling for shadow DOMs by checking for el.host and updating the element reference.
packages/vue-hooks/src/vue-popper.ts Modified logic to handle shadow DOMs by checking for reference.host and updating the reference.

el = el.host
}

return (' ' + el.getAttribute('data-tag') + ' ').includes(' ' + value + ' ')

Choose a reason for hiding this comment

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

Ensure that el.getAttribute('data-tag') is not null before using it in the includes method to avoid potential runtime errors.

if (el.host) {
el = el.host
}
return el.parentNode ? isFixed(el.parentNode as HTMLElement) : false

Choose a reason for hiding this comment

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

Ensure that el.parentNode is not null before passing it to isFixed to avoid potential runtime errors.

reference = reference.host
}

if (reference) {

Choose a reason for hiding this comment

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

Ensure that getZIndex(reference) handles cases where reference might not have a valid z-index to avoid potential runtime errors.

@zzcr zzcr merged commit a304f42 into dev Mar 17, 2025
10 of 11 checks passed
@kagol kagol deleted the shen/sync-aui-popper-transfer branch April 14, 2025 12:27
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.

3 participants