feat(badge): Support better customization with semantic classNames/styles as function#54977
feat(badge): Support better customization with semantic classNames/styles as function#54977zombieJ merged 14 commits intoant-design:nextfrom meet-student:badge
Conversation
|
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit 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
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. 🧪 Early access (Sonnet 4.5): enabledWe are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience. Note:
Comment |
|
|
👁 Visual Regression Report for PR #54977 Failed ❌
Important There are 4 diffs found in this PR: 🔄
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @meet-student, 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 introduces a significant enhancement to the Badge and Badge.Ribbon components, allowing developers to apply highly dynamic and context-aware styling. By enabling classNames and styles props to accept functions, the components can now respond to their own properties to generate custom CSS classes and inline styles for their semantic DOM elements. This change greatly improves the customization capabilities, making the components more adaptable to diverse design requirements.
Highlights
- Enhanced Customization for Badge Components: The
BadgeandBadge.Ribboncomponents now support more flexible styling by allowing theirclassNamesandstylesprops to accept functions. This enables dynamic application of CSS classes and inline styles based on the component's current properties. - Integration of
useMergeSemanticHook: A newuseMergeSemantichook has been integrated into bothBadgeandRibboncomponents. This hook is responsible for merging and applying the potentially function-basedclassNamesandstylesfrom component props and context, ensuring proper cascade and customization. - New Demo and Documentation: A new demo file (
style-class.tsx) and corresponding documentation (style-class.md,index.en-US.md,index.zh-CN.md) have been added to illustrate how to utilize the new function-basedclassNamesandstylesfor advanced customization. - Comprehensive Test Coverage: New test cases have been added to
index.test.tsxandribbon.test.tsxto validate the correct behavior of function-basedclassNamesandstylesfor bothBadgeandRibboncomponents, ensuring the feature works as expected.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces function-based classNames and styles props for the Badge and Badge.Ribbon components, enabling dynamic styling based on component props. The implementation is well-structured, leveraging the useMergeSemantic hook to consolidate styling logic. The changes are clean and the new functionality is well-tested. I have a couple of suggestions to enhance the documentation and the new demo file to better illustrate this powerful new feature.
Bundle ReportChanges will increase total bundle size by 7.91MB (210.52%) ⬆️
Affected Assets, Files, and Routes:view changes for bundle: antd.min-array-pushAssets Changed:
|
More templates
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #54977 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 798 798
Lines 14749 14753 +4
Branches 3896 3896
=========================================
+ Hits 14749 14753 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the Badge component to support better customization by allowing semantic classNames and styles to be passed as functions in addition to objects. The function-based approach enables dynamic styling based on component props.
- Support function-based classNames/styles that receive component props as parameters
- Update Badge and Badge.Ribbon components to use a new useMergeSemantic hook for handling both object and function-based semantic customization
- Add comprehensive test coverage and demo showcasing the new functionality
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| components/badge/index.tsx | Main Badge component updated to support function-based semantic styling with useMergeSemantic hook |
| components/badge/Ribbon.tsx | Badge.Ribbon component updated to support function-based semantic styling |
| components/badge/index.en-US.md | Updated API documentation to reflect function-based classNames/styles support |
| components/badge/index.zh-CN.md | Updated Chinese API documentation with function-based classNames/styles support |
| components/badge/demo/style-class.tsx | New demo showcasing object and function-based semantic styling capabilities |
| components/badge/demo/style-class.md | Documentation for the new demo |
| components/badge/tests/index.test.tsx | Test coverage for function-based semantic styling in Badge component |
| components/badge/tests/ribbon.test.tsx | Test coverage for function-based semantic styling in Badge.Ribbon component |
| components/badge/tests/snapshots/demo.test.tsx.snap | Updated snapshots for new demo |
| components/badge/tests/snapshots/demo-extend.test.ts.snap | Updated snapshots for new demo in extended context |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
3 participants
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
💡 Background and Solution
📝 Change Log