Skip to content
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

fix: click on shadowDOM popup should not close it #480

Merged
merged 9 commits into from
Sep 3, 2024

Conversation

iahu
Copy link
Contributor

@iahu iahu commented Aug 29, 2024

Summary by CodeRabbit

Summary by CodeRabbit

  • 修复 bug
    • 修复了 action 为 click 且 popup 包含 shadowDOM 时,点击 popup 内的 shadowDOM 意外关闭弹窗的问题。
  • 重构
    • 简化了事件目标的容器检查逻辑,提高了代码可读性和可维护性。
  • 新功能
    • 新增了对自定义 JSX 元素 custom-element 的支持,增强了与 React 应用的兼容性。
    • 新增了针对 Popup.Shadow 组件的测试,确保其在与影子 DOM 元素和自定义组件交互时的正确行为。

Copy link

coderabbitai bot commented Aug 29, 2024

Warning

Rate limit exceeded

@afc163 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 22 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between fb4ff21 and b06750f.

Walkthrough

此次更改引入了一个新的辅助函数 inContainer,用于判断目标元素是否位于指定容器或其阴影根内。该函数被用于现有的 inPopupOrChild 函数中,以简化事件目标是否包含在相关 DOM 元素中的检查。同时,新增了针对 Popup.Shadow 组件的测试套件,确保其在与阴影 DOM 元素和自定义组件交互时的行为正确。此外,还添加了 TypeScript 声明以支持自定义 JSX 元素。

Changes

文件 更改摘要
src/index.tsx 引入 inContainer 辅助函数,简化 inPopupOrChild 中的 DOM 包含检查。
tests/shadow.test.tsx 新增 Popup.Shadow 组件的测试套件,包含自定义元素的交互行为测试。
global.d.ts 新增自定义 JSX 元素 custom-element 的 TypeScript 声明。

Poem

在草地上跳跃的小兔子,
新函数如春风轻拂,
检查容器不再繁琐,
代码清晰如明月,
感谢这些小变化,
让我们欢快又快乐! 🌼🐇


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

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c629b9c and 539bb11.

Files selected for processing (1)
  • src/index.tsx (1 hunks)
Additional comments not posted (2)
src/index.tsx (2)

275-282: 代码看起来不错!

inContainer 函数正确实现了目标元素是否在指定容器或其 shadow root 内的逻辑,提高了代码的可读性和可维护性。

代码更改已批准。


288-291: 代码看起来不错!

inPopupOrChild 函数使用 inContainer 简化了检查事件目标是否包含在相关 DOM 元素中的逻辑,提高了代码结构。

代码更改已批准。

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 539bb11 and 1a764b1.

Files selected for processing (1)
  • tests/shadow.test.tsx (1 hunks)
Additional comments not posted (6)
tests/shadow.test.tsx (6)

Line range hint 3-10: 代码看起来不错!

beforeEachafterEach 方法正确地设置和清理了测试环境。


Line range hint 12-22: 代码看起来不错!

Demo 组件正确地渲染了 Trigger 组件和一个占位符 div


Line range hint 24-37: 代码看起来不错!

renderShadow 函数正确地创建了一个 shadow DOM 并在其中渲染了 Demo 组件。


Line range hint 39-54: 代码看起来不错!

renderMultiLevelShadow 函数正确地创建了一个嵌套的 shadow DOM 并在其中渲染了 Demo 组件。


212-223: 代码看起来不错!

CustomElement 类正确地实现了 connectedCallbackdisconnectedCallback 生命周期方法,并正确地附加了 shadow DOM。


227-318: 代码看起来不错!

测试用例正确地验证了与 shadow DOM 元素交互时弹出窗口的行为,并涵盖了必要的场景。

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1a764b1 and 271112e.

Files selected for processing (1)
  • src/index.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/index.tsx

@afc163
Copy link
Member

afc163 commented Sep 3, 2024

image

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 271112e and 9f887ad.

Files selected for processing (1)
  • global.d.ts (1 hunks)
Additional comments not posted (1)
global.d.ts (1)

1-6: 代码看起来不错!

这个声明文件通过扩展 JSX 命名空间,添加了一个新的内置元素 custom-element。这允许在 TypeScript React 项目中使用 <custom-element> 作为有效的 JSX 元素。

React.DetailedHTMLProps 类型用于定义 custom-element 的属性,它继承了 React.HTMLAttributes<HTMLElement> 中的标准 HTML 属性。HTMLElement 类型被用作第二个泛型参数,以指定 DOM 元素的类型。

这个声明是正确定义的,并遵循了 TypeScript 和 React 的类型定义。

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9f887ad and fb4ff21.

Files selected for processing (1)
  • tests/shadow.test.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • tests/shadow.test.tsx

tests/shadow.test.tsx Outdated Show resolved Hide resolved
tests/shadow.test.tsx Outdated Show resolved Hide resolved
tests/shadow.test.tsx Outdated Show resolved Hide resolved
Copy link

codecov bot commented Sep 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.85%. Comparing base (c629b9c) to head (b06750f).
Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #480      +/-   ##
==========================================
+ Coverage   97.71%   97.85%   +0.14%     
==========================================
  Files          13       13              
  Lines         787      793       +6     
  Branches      234      229       -5     
==========================================
+ Hits          769      776       +7     
+ Misses         18       17       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@afc163 afc163 merged commit 6414517 into react-component:master Sep 3, 2024
8 checks passed
zombieJ pushed a commit that referenced this pull request Sep 3, 2024
@zombieJ
Copy link
Member

zombieJ commented Sep 10, 2024

Revert since:
image

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