Skip to content

Comments

feat(descriptions): Support better customization with semantic classNames/styles#55118

Merged
thinkasany merged 24 commits intoant-design:nextfrom
tanjiahao24:semantic-classname
Sep 29, 2025
Merged

feat(descriptions): Support better customization with semantic classNames/styles#55118
thinkasany merged 24 commits intoant-design:nextfrom
tanjiahao24:semantic-classname

Conversation

@tanjiahao24
Copy link
Contributor

@tanjiahao24 tanjiahao24 commented Sep 22, 2025

中文版模板 / Chinese template

🤔 This is a ...

  • 🆕 New feature
  • 🐞 Bug fix
  • 📝 Site / documentation improvement
  • 📽️ Demo improvement
  • 💄 Component style improvement
  • 🤖 TypeScript definition improvement
  • 📦 Bundle size optimization
  • ⚡️ Performance optimization
  • ⭐️ Feature enhancement
  • 🌐 Internationalization
  • 🛠 Refactoring
  • 🎨 Code style optimization
  • ✅ Test Case
  • 🔀 Branch merge
  • ⏩ Workflow
  • ⌨️ Accessibility improvement
  • ❓ Other (about what?)

🔗 Related Issues

  • Describe the source of related requirements, such as links to relevant issue discussions.
  • For example: close #xxxx, fix #xxxx

💡 Background and Solution

  • The specific problem to be addressed.
  • List the final API implementation and usage if needed.
  • If there are UI/interaction changes, consider providing screenshots or GIFs.

📝 Change Log

Language Changelog
🇺🇸 English feat(space): Support better customization with semantic classNames/styles as function
🇨🇳 Chinese 使用语义类名/样式作为函数,支持更好的自定义

@bolt-new-by-stackblitz
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 22, 2025

Preview is ready

@github-actions
Copy link
Contributor

github-actions bot commented Sep 22, 2025

👁 Visual Regression Report for PR #55118 Failed ❌

🎯 Target branch: next (12da26b)
📖 View Full Report ↗︎
📖 Alternative Report ↗︎
📊 Summary: 🔄 2 changed, 🆕 3 added

Expected (Branch next) Actual (Current PR) Diff
list-vertical.dark.png list-vertical.dark.png list-vertical.dark.png list-vertical.dark.png
table-sticky.default.png table-sticky.default.png table-sticky.default.png table-sticky.default.png
descriptions-style-class.compact.png descriptions-style-class.compact.png 🆕🆕🆕 Added 🆕🆕🆕
descriptions-style-class.dark.png descriptions-style-class.dark.png 🆕🆕🆕 Added 🆕🆕🆕
descriptions-style-class.default.png descriptions-style-class.default.png 🆕🆕🆕 Added 🆕🆕🆕

Important

There are 5 diffs found in this PR: 🔄 2 changed, 🆕 3 added.
Please check all items:

  • Visual diff is acceptable

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @tanjiahao24, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the customization capabilities of the Descriptions component by introducing flexible classNames and styles props. These new props allow developers to dynamically apply CSS classes and inline styles to specific semantic parts of the component, such as the root, header, title, labels, and content. This enhancement provides greater control over the component's appearance, making it easier to integrate into diverse design systems and achieve specific visual requirements.

Highlights

  • Enhanced Customization for Descriptions Component: Introduced new classNames and styles props to the Descriptions component, allowing for more granular control over its semantic DOM elements.
  • Dynamic Styling Support: The classNames and styles props now accept functions, enabling dynamic application of CSS classes and inline styles based on component properties.
  • New useMergeSemantic Hook: A new utility hook was added to efficiently merge and apply dynamic class names and styles from various sources.
  • Comprehensive Demo and Tests: New demo files (style-class.tsx, style-class.md) and a dedicated test file (semantic.test.tsx) have been added to showcase and validate the new customization features.
  • Documentation Updates: The official documentation (English and Chinese) has been updated to reflect the new classNames and styles props and their usage.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a valuable enhancement to the Descriptions component, allowing classNames and styles props to be functions for more dynamic customization. The implementation is clean, leveraging a useMergeSemantic hook to centralize the logic. The changes are well-supported with new tests and a demo. I've identified a minor redundancy in the code and some duplication in the documentation that should be addressed.

@meet-student meet-student changed the title feat(descriptions): Support better customization with semantic classN… feat(descriptions): Support better customization with semantic classNames/styles Sep 22, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Sep 22, 2025

More templates

npm i https://pkg.pr.new/ant-design/ant-design/antd@55118

commit: b8b1fb8

@codecov
Copy link

codecov bot commented Sep 22, 2025

Bundle Report

Changes will increase total bundle size by 13.13kB (0.11%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
antd.min-array-push 11.65MB 13.13kB (0.11%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: antd.min-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
antd-with-locales.js 6.57kB 6.13MB 0.11%
antd.js 6.57kB 5.52MB 0.12%

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 22, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Sep 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (dba8b74) to head (b8b1fb8).
⚠️ Report is 8 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff            @@
##              next    #55118   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          796       798    +2     
  Lines        14673     14716   +43     
  Branches      3890      3893    +3     
=========================================
+ Hits         14673     14716   +43     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tanjiahao24 and others added 3 commits September 22, 2025 18:34
import type { DescriptionsProps } from 'antd';

// Object-based classNames
const classNamesObject: DescriptionsProps['classNames'] = {
Copy link
Member

Choose a reason for hiding this comment

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

demo 参考下这个精简下。样式搭配和谐一些

https://github.com/ant-design/ant-design/pull/54957/files#diff-71c24f063ec1a30f721c1a2bfb648454753dfa9f3b907e9e87fe7302472b3727

classNames 使用同一个,然后 styles 根据 props (尽量选择 type、size、variant)做一下区分

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

meet-student and others added 5 commits September 27, 2025 15:52
Co-authored-by: thinkasany <[email protected]>
Signed-off-by: 遇见同学 <[email protected]>
Co-authored-by: thinkasany <[email protected]>
Signed-off-by: 遇见同学 <[email protected]>
Co-authored-by: thinkasany <[email protected]>
Signed-off-by: 遇见同学 <[email protected]>
Co-authored-by: thinkasany <[email protected]>
Signed-off-by: 遇见同学 <[email protected]>
@meet-student
Copy link
Member

image

这个配色

@thinkasany
Copy link
Member

同步完可以@review 同学帮忙点一下 ap ci,不然可能会不执行。
image

classNames: {
label: classNames(contextClassNames.label, descriptionsClassNames?.label),
content: classNames(contextClassNames.content, descriptionsClassNames?.content),
label: classNames(mergedClassNames.label),
Copy link
Member

Choose a reason for hiding this comment

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

这里的 classNames 没有用了,下面的也检查一下

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image 大佬上面一个评论改了发现有问题 内部判断有点点问题会导致有 undefined

Copy link
Member

Choose a reason for hiding this comment

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

@zombieJ 这个地方先这样子 classNames 包着吧,等合了以后,我后面排查一下原因,去解一下里面的问题

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 29, 2025
@thinkasany thinkasany merged commit 3a2b41c into ant-design:next Sep 29, 2025
39 checks passed
@github-actions
Copy link
Contributor

🎉 Thank you for your contribution! If you have not yet joined our DingTalk community group, please feel free to join us (when joining, please provide the link to this PR).

🎉 感谢您的贡献!如果您还没有加入钉钉社区群,请扫描下方二维码加入我们(加群时请提供此 PR 链接)。

钉钉社区群二维码

@zombieJ zombieJ mentioned this pull request Nov 4, 2025
17 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants