feat(breadcrumb): Support better customization with semantic classNames/styles as function#54950
feat(breadcrumb): Support better customization with semantic classNames/styles as function#54950zombieJ merged 2 commits intoant-design:nextfrom meet-student:breadcrumb
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 #54950 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 significantly improves the customization capabilities of the Breadcrumb component. By allowing classNames and styles props to accept functions, it provides developers with greater flexibility to apply dynamic styling based on the component's current state or properties. This enhancement streamlines the process of creating highly adaptable and visually consistent user interfaces.
Highlights
- Enhanced Breadcrumb Customization: The
classNamesandstylesprops for the Breadcrumb component now accept functions, enabling dynamic styling based on component props and state. - New
useMergeSemanticHook: A new utility hook,useMergeSemantic, has been introduced to centralize and standardize the merging logic for semantic classNames and styles across components, promoting consistency and reusability. - Improved Accessibility: A default
aria-label="Breadcrumb"is now applied to the main navigation element of the Breadcrumb component, enhancing usability for screen readers. - Expanded Test Coverage and Documentation: New test cases and a dedicated demo (
style-class.tsx) have been added to showcase and validate the new function-based styling capabilities, along with updated API documentation.
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 a valuable enhancement to the Breadcrumb component by allowing classNames and styles props to be functions, providing more flexible and dynamic customization. The implementation using the useMergeSemantic hook is well-executed. Additionally, the PR includes a nice accessibility improvement by adding a default aria-label to the nav element. The new feature is also well-documented and tested.
I've provided a few suggestions to improve code clarity in the Breadcrumb component and to ensure consistency in the documentation's markdown formatting. Overall, this is a solid contribution.
Bundle ReportChanges will increase total bundle size by 7.93MB (211.19%) ⬆️
Affected Assets, Files, and Routes:view changes for bundle: antd.min-array-pushAssets Changed:
|
More templates
commit: |
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for better customization of breadcrumb components by enabling semantic classNames and styles to be passed as functions. This enhancement allows developers to dynamically apply custom styling based on component props.
- Adds
classNamesandstylesprops that accept either objects or functions for semantic structure customization - Implements the
useMergeSemantichook to handle merging of semantic props - Updates type definitions to support function-based semantic customization
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| components/breadcrumb/Breadcrumb.tsx | Implements semantic customization with function support using useMergeSemantic hook |
| components/breadcrumb/index.*.md | Documents new classNames and styles props with function support |
| components/breadcrumb/demo/style-class.tsx | Demonstrates usage of object and function-based semantic customization |
| components/breadcrumb/tests/style-class.test.tsx | Tests function-based classNames and styles functionality |
| Multiple snapshot files | Updates test snapshots to reflect removal of empty class attributes |
| components/button/index.*.md | Fixes markdown formatting for semantic DOM type references |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…es/styles as function
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #54950 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 793 793
Lines 14621 14620 -1
Branches 3889 3889
=========================================
- Hits 14621 14620 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 participants
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
💡 Background and Solution
📝 Change Log