feat: add open to suggestion's children #1251
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 ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
Summary of ChangesHello @miownag, 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 Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a valuable feature by exposing the open state to the Suggestion component's children. This is particularly useful for uncontrolled components, as demonstrated in the new demo. The implementation is clean, and it's great to see it accompanied by documentation updates and tests. I have one minor suggestion to improve code clarity in the new demo file.
| import { Sender, Suggestion } from '@ant-design/x'; | ||
| import type { GetProp } from 'antd'; | ||
| import React from 'react'; | ||
|
|
||
| type SuggestionItems = Exclude<GetProp<typeof Suggestion, 'items'>, () => void>; | ||
|
|
||
| const suggestions: SuggestionItems = [ |
There was a problem hiding this comment.
The way SuggestionItems is typed is a bit complex and can be simplified. The SuggestionItem type is exported and can be imported directly. This avoids using GetProp and Exclude, making the code clearer and more maintainable.
import { Sender, Suggestion } from '@ant-design/x';
import React from 'react';
import type { SuggestionItem } from '..';
const suggestions: SuggestionItem[] = [
Bundle ReportChanges will increase total bundle size by 2.32kB (1.71%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: antdx-array-pushAssets Changed:
|
1 participant
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
--
💡 Background and Solution
In uncontrolled scenarios, the children of Suggestion cannot know whether Suggestion is open or closed.
Actual scenario:
The enter key functionality of Cascader within Suggestion and that of Sender may overlap in practical use. For example, when the submitType of Sender is set to "enter", selecting an item in Suggestion will also trigger message sending. In such cases, users may need to change "open" to a controlled property and then use the open state to determine whether to allow message sending. As shown in the demo, after adding the "open" parameter, the open state can also be obtained in uncontrolled scenarios.
API implementation:
When retrieving childNode by executing children, additionally pass in open as mergedOpen:
children?.({ onTrigger, onKeyDown, open: mergedOpen });Usage:
The children function parameter of Suggestion can be destructured to get the newly passed open, enabling certain controls as demonstrated in the demo.
📝 Change Log