feat(image): Support better customization with semantic classNames/styles as function#54980
feat(image): Support better customization with semantic classNames/styles as function#54980zombieJ merged 21 commits intoant-design:nextfrom meet-student:image
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 #54980 Failed ❌
Important There are 7 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 Image component by introducing support for function-based classNames and styles props. This enhancement allows developers to apply dynamic styling and class assignments to various parts of the image component, including its preview popup, based on the component's current properties.
Highlights
- Enhanced Customization: The
Imagecomponent now supportsclassNamesandstylesprops as functions, allowing for dynamic styling and class assignment based on component properties. - Dynamic Styling Capabilities: This enhancement provides greater flexibility for developers to apply conditional styling to various parts of the image component, including its preview popup.
- New Demo and Tests: A new demo (
style-class.tsx) and comprehensive test cases have been added to showcase and validate this new functionality, ensuring proper implementation and 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 introduces a valuable enhancement to the Image component by allowing classNames and styles props to be functions. This provides greater flexibility for dynamic styling based on the component's props. The implementation is solid, with new types, updated logic in the Image component, and comprehensive tests and demos.
My review includes a few suggestions to improve code quality:
- A performance consideration regarding an ineffective
useMemohook. - A suggestion to refactor duplicated code in the new demo file for better maintainability.
- A couple of minor typo fixes in the documentation.
Overall, this is a great feature addition. Addressing these points will help polish the implementation.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #54980 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 798 798
Lines 14727 14727
Branches 3896 3896
=========================================
Hits 14727 14727 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
More templates
commit: |
Bundle ReportChanges will increase total bundle size by 44 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: antd.min-array-pushAssets Changed:
|
|
![accesslint[bot]](https://avatars.githubusercontent.com/in/1502?s=60&v=4){kind=small}
| }; | ||
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| }; | ||
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| }; | ||
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| }; | ||
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| <div | ||
| class="ant-image css-var-root ant-image-css-var" | ||
| > | ||
| <img |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| </div> | ||
| `; | ||
|
|
||
| exports[`Image.Semantic should render with classNames and styles when passed as functions to PreviewGroup 1`] = `"<div class="ant-image css-var-root ant-image-css-var" style="width: 100px;"><img class="ant-image-img" width="100" src="https://example.com/image.png"><div class="ant-image-cover ant-image-cover-center"></div></div>"`; |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
|
|
||
| exports[`Image.Semantic should render with classNames and styles when passed as functions to PreviewGroup 1`] = `"<div class="ant-image css-var-root ant-image-css-var" style="width: 100px;"><img class="ant-image-img" width="100" src="https://example.com/image.png"><div class="ant-image-cover ant-image-cover-center"></div></div>"`; | ||
|
|
||
| exports[`Image.Semantic should render with custom classNames and styles when passed to PreviewGroup 1`] = `"<div class="ant-image css-var-root ant-image-css-var"><img class="ant-image-img" src="https://example.com/image.png"><div class="ant-image-cover ant-image-cover-center"></div></div>"`; |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| }; | ||
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| classNames={classNamesObject} | ||
| styles={stylesObject} | ||
| > | ||
| <Image src="https://example.com/image.png" /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
|
|
||
| const { container } = render( | ||
| <Image.PreviewGroup preview={{ open: false }} classNames={classNamesFn} styles={stylesFn}> | ||
| <Image width={100} src="https://example.com/image.png" /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
|
|
||
| // const { container } = render( | ||
| // <Image.PreviewGroup preview={{ open: false }} classNames={classNamesFn} styles={stylesFn}> | ||
| // <Image src="https://example.com/image.png" /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
| return ( | ||
| <Flex gap="middle"> | ||
| <Image {...sharedProps} styles={styles} /> | ||
| <Image {...sharedProps} preview={{ open: false }} styles={stylesFn} /> |
There was a problem hiding this comment.
This image is missing a text alternative. This is a problem for people using screen readers.
3 participants
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
💡 Background and Solution
📝 Change Log