feat(switch): Support better customization with semantic classNames/styles as function#54994
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. Comment |
|
|
👁 Visual Regression Report for PR #54994 Failed ❌
Important There are 4 diffs found in this PR: 🔄
|
![accesslint[bot]](https://avatars.githubusercontent.com/in/1502?s=60&v=4){kind=small}
components/switch/__tests__/__snapshots__/demo-extend.test.ts.snap
Outdated
Show resolved
Hide resolved
![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 @xkhanhan, 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 significant improvements to the Ant Design Switch component's customization capabilities. By adding new classNames and styles props, developers can now apply custom CSS classes and inline styles to specific semantic parts of the component. This enhancement supports both static object-based definitions and dynamic function-based definitions that respond to the component's props, making the Switch component highly adaptable to various design systems and styling requirements.
Highlights
- Enhanced Customization: The
Switchcomponent now offers more flexible styling options through newclassNamesandstylesprops, allowing for granular control over its semantic sub-elements. - Dynamic Styling with Functions: Both
classNamesandstylesprops can accept either plain objects for static customization or functions that receive the component's current props, enabling dynamic styling based on theSwitch's state or configuration. - Semantic Targeting: Customizations can be applied to specific parts of the
Switchcomponent, such as therootelement and itscontent, providing precise control over appearance. - New API and Documentation: The
Switchcomponent's API documentation has been updated to reflect these newclassNamesandstylesprops, accompanied by a new demo (style-class.tsx) showcasing their practical 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 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 adds a great customization feature to the Switch component by allowing classNames and styles to be passed as functions. The overall implementation is good, but I've found an issue in how the class names are applied, which causes incorrect rendering. I've also left some comments on improving the code clarity, tests, and documentation. Please take a look at my suggestions.
More templates
commit: |
Bundle ReportChanges will increase total bundle size by 7.92MB (211.19%) ⬆️
Affected Assets, Files, and Routes:view changes for bundle: antd.min-array-pushAssets Changed:
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces enhanced customization capabilities for the Switch component by adding support for semantic classNames and styles as functions. This allows developers to dynamically customize the appearance of different parts of the Switch component based on the component's properties and state.
- Adds support for function-based classNames and styles that receive component props as parameters
- Integrates the useMergeSemantic hook for better handling of semantic styling
- Provides comprehensive demo and test coverage for the new functionality
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| components/switch/index.tsx | Core implementation adding function-based classNames/styles support and useMergeSemantic integration |
| components/switch/index.en-US.md | English documentation updates describing the new classNames/styles function support |
| components/switch/index.zh-CN.md | Chinese documentation updates describing the new classNames/styles function support |
| components/switch/demo/style-class.tsx | Demo component showcasing both object and function-based customization |
| components/switch/demo/style-class.md | Demo documentation explaining the new feature |
| components/switch/tests/style-class.test.tsx | Comprehensive test coverage for the new functionality |
| components/switch/tests/snapshots/demo.test.ts.snap | Updated snapshots for demo tests |
| components/switch/tests/snapshots/demo-extend.test.ts.snap | Updated snapshots for extended demo tests |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
meet-student
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #54994 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 793 793
Lines 14661 14665 +4
Branches 3893 3892 -1
=========================================
+ Hits 14661 14665 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…tyles as function
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: thinkasany <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: thinkasany <[email protected]>
Signed-off-by: thinkasany <[email protected]>
Signed-off-by: thinkasany <[email protected]>
Signed-off-by: 遇见同学 <[email protected]>
Signed-off-by: 遇见同学 <[email protected]>
Signed-off-by: 遇见同学 <[email protected]>
Co-authored-by: lijianan <[email protected]> Signed-off-by: 遇见同学 <[email protected]>
components/switch/__tests__/__snapshots__/demo-extend.test.ts.snap
Outdated
Show resolved
Hide resolved
|
冲突看一下 |
Signed-off-by: thinkasany <[email protected]>
Signed-off-by: thinkasany <[email protected]>
| </span> | ||
| </span> | ||
| </button> | ||
| <button |
There was a problem hiding this comment.
Looks like this element is missing an accessible name or label. That makes it hard for people using screen readers or voice control to use the control.
| </span> | ||
| </span> | ||
| </button> | ||
| <button |
There was a problem hiding this comment.
Looks like this element is missing an accessible name or label. That makes it hard for people using screen readers or voice control to use the control.
|
🎉 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 链接）。 
|
5 participants
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
💡 Background and Solution
📝 Change Log