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

chore: Adjust style merge order #1207

Merged
merged 2 commits into from
Nov 26, 2024

Conversation

Wxh16144
Copy link
Contributor

@Wxh16144 Wxh16144 commented Nov 26, 2024

background: ant-design/ant-design#51763 (comment)

Summary by CodeRabbit

  • 新功能

    • 优化了 Cell 组件的样式处理和渲染逻辑,确保用户自定义样式优先应用。
  • 错误修复

    • 改善了渲染逻辑,防止在无效的 React 节点时崩溃。
  • 测试

    • 新增了关于样式合并顺序的测试用例,确保样式正确覆盖对齐属性。

Copy link

vercel bot commented Nov 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
table ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 26, 2024 1:36pm

Copy link

coderabbitai bot commented Nov 26, 2024

Walkthrough

此次更改主要集中在src/Cell/index.tsx中的Cell组件,修改了样式处理和渲染逻辑。最显著的变化是样式合并顺序的调整,确保legacyCellProps.styleadditionalProps.style之前应用,以便用户定义的样式优先。此外,mergedChildNode的确定逻辑得到了优化,以防止在最终childNode无效时崩溃。对ellipsis属性的处理也进行了调整,以便在特定条件下将mergedChildNode包裹在一个span中。tests/Cell.spec.tsx中增加了一个新测试案例,以验证样式合并的行为。

Changes

文件 更改摘要
src/Cell/index.tsx 修改样式合并顺序,优化mergedChildNode逻辑,调整ellipsis处理。
tests/Cell.spec.tsx 新增测试案例“style merge order”,验证样式合并行为。

Possibly related PRs

Suggested reviewers

  • zombieJ
  • MadCcc

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

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.83%. Comparing base (7780307) to head (638b1b9).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1207      +/-   ##
==========================================
+ Coverage   97.72%   97.83%   +0.11%     
==========================================
  Files          75       75              
  Lines        7374     7476     +102     
  Branches     1121     1123       +2     
==========================================
+ Hits         7206     7314     +108     
+ Misses        162      157       -5     
+ Partials        6        5       -1     

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

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

🧹 Outside diff range and nitpick comments (2)
tests/Cell.spec.tsx (1)

127-148: 建议增加反向测试用例

当前测试用例验证了样式覆盖的情况,建议添加一个反向测试用例,验证当没有自定义样式时,默认的对齐方式是否正确应用。

 it('style merge order', () => {
   const wrapper = mount(
     <Table
       columns={[
         {
           align: 'center',
           onHeaderCell: () => ({
             style: {
               color: 'red',
               textAlign: 'end', // overwrite align
             },
           }),
         },
       ]}
     />,
   );

   expect(wrapper.find('thead th').prop('style')).toEqual({
     color: 'red',
     textAlign: 'end',
   });
+
+  // 验证默认对齐方式
+  const wrapper2 = mount(
+    <Table
+      columns={[
+        {
+          align: 'center',
+          onHeaderCell: () => ({
+            style: {
+              color: 'red',
+            },
+          }),
+        },
+      ]}
+    />,
+  );
+
+  expect(wrapper2.find('thead th').prop('style')).toEqual({
+    color: 'red',
+    textAlign: 'center',
+  });
 });
src/Cell/index.tsx (1)

Line range hint 226-231: 建议增强 mergedChildNode 的类型检查

当前的验证逻辑可以防止无效的 React 节点导致崩溃,但建议考虑使用 React.isValidElement 作为主要检查方式,可以更准确地验证节点的有效性。

建议参考以下改进方案:

- if (
-   typeof mergedChildNode === 'object' &&
-   !Array.isArray(mergedChildNode) &&
-   !React.isValidElement(mergedChildNode)
- ) {
+ if (mergedChildNode !== null && !React.isValidElement(mergedChildNode) && !Array.isArray(mergedChildNode)) {
   mergedChildNode = null;
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7780307 and 638b1b9.

📒 Files selected for processing (2)
  • src/Cell/index.tsx (1 hunks)
  • tests/Cell.spec.tsx (1 hunks)
🔇 Additional comments (4)
tests/Cell.spec.tsx (3)

126-127: 测试用例与 GitHub Issue 关联明确

通过注释清晰地引用了相关的 GitHub Issue,有助于理解测试用例的背景和目的。


132-138: 样式优先级验证设计合理

测试用例通过以下方式验证样式合并顺序:

  1. 设置列的默认对齐方式为 center
  2. 通过 onHeaderCell 返回的样式将文本对齐更改为 end

这个设计很好地测试了自定义样式是否能够正确覆盖默认样式。


144-147: 断言验证完整且准确

断言不仅验证了样式覆盖(textAlign: 'end'),还确保了其他自定义样式(color: 'red')得到正确应用,验证逻辑完整。

src/Cell/index.tsx (1)

215-221: 样式合并顺序的调整是合理的!

样式合并顺序的调整确保了用户自定义样式(通过 additionalProps.style)能够正确覆盖默认样式,这与组件库的最佳实践保持一致。注释也清晰地解释了这个改动的原因。

@afc163 afc163 merged commit f3d7284 into react-component:master Nov 26, 2024
9 checks passed
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.

2 participants