feat(calendar): Support better customization with semantic classNames/styles as function#54978
feat(calendar): Support better customization with semantic classNames/styles as function#54978zombieJ merged 2 commits intoant-design:nextfrom meet-student:calendar
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 #54978 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 Calendar component's styling capabilities. It allows developers to define classNames and styles as functions, which receive the component's current props as an argument. This enables highly dynamic and conditional styling, providing greater flexibility for integrating the Calendar component seamlessly into diverse UI designs. The change also includes updated type definitions, comprehensive documentation, and a new demo to showcase its usage.
Highlights
- Enhanced Calendar Customization: The
Calendarcomponent now supportsclassNamesandstylesprops as functions, allowing dynamic styling based on component properties likefullscreenormode. - Semantic DOM Targeting: Customization can be applied to specific semantic DOM elements within the calendar, including
root,header,body,content, anditem. - New Demo and Documentation: A new demo (
style-class.tsx) and corresponding documentation (style-class.md) have been added to illustrate the usage of these new customization capabilities. - Type Definitions: New TypeScript types,
CalendarClassNamesTypeandCalendarStylesType, were introduced to properly define the function-basedclassNamesandstylesprops. - Test Coverage: A new test case has been added to
index.test.tsxto ensure the correct application of dynamic class names and styles.
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 great feature for customizing the Calendar component by allowing classNames and styles to be provided as functions. This enables dynamic styling based on the component's props. The implementation is mostly solid, with good test coverage and documentation.
I've identified one correctness bug and a related performance issue in generateCalendar.tsx where the props for dynamic styling are memoized. The mergedProps object for styling functions doesn't correctly use the updated mergedMode state, and the memoization is ineffective due to a dependency on the props object. I've provided a comment with a suggested fix for the correctness bug.
More templates
commit: |
Bundle ReportChanges will increase total bundle size by 7.92MB (211.13%) ⬆️
Affected Assets, Files, and Routes:view changes for bundle: antd.min-array-pushAssets Changed:
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #54978 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 793 793
Lines 14661 14662 +1
Branches 3893 3893
=========================================
+ Hits 14661 14662 +1 ☔ 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 adds support for better customization of the Calendar component by allowing classNames and styles props to accept functions in addition to objects. This enables dynamic styling based on component props like fullscreen, mode, and showWeek.
- Enhanced
classNamesandstylesprops to support function signatures that receive component props - Added comprehensive type definitions for semantic styling
- Included a new demo showcasing both object and function usage patterns
Reviewed Changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| components/calendar/generateCalendar.tsx | Updated type definitions and semantic merging logic to support function-based styling |
| components/calendar/demo/style-class.tsx | New demo demonstrating object and function usage for dynamic styling |
| components/calendar/demo/style-class.md | Documentation for the new demo |
| components/calendar/index.zh-CN.md | Added Chinese documentation for the new styling props |
| components/calendar/index.en-US.md | Added English documentation for the new styling props |
| components/calendar/tests/index.test.tsx | Added comprehensive test coverage for function-based styling |
| components/calendar/tests/snapshots/demo.test.ts.snap | Updated test snapshots |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
2 participants
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
💡 Background and Solution
📝 Change Log