Skip to content

feat(select): popup supports Semantic DOM and retire some api#53243

Merged
zombieJ merged 4 commits intoant-design:featurefrom
aojunhao123:dropdown-rename
Mar 21, 2025
Merged

feat(select): popup supports Semantic DOM and retire some api#53243
zombieJ merged 4 commits intoant-design:featurefrom
aojunhao123:dropdown-rename

Conversation

@aojunhao123
Copy link
Copy Markdown
Contributor

中文版模板 / Chinese template

🤔 This is a ...

  • 🆕 New feature
  • 🛠 Refactoring

🔗 Related Issues

💡 Background and Solution

  • The specific problem to be addressed.
  • List the final API implementation and usage if needed.
  • If there are UI/interaction changes, consider providing screenshots or GIFs.

📝 Change Log

Language Changelog
🇺🇸 English 🆕 Select component adds popup semantic node with support for customizing dropdown menu via classNames.popup, styles.popup, popupRender and onPopupVisibleChange, while deprecating legacy popupClassName, dropdownClassName, dropdownStyle, dropdownRender and onDropdownVisibleChange APIs.
🇨🇳 Chinese 🆕 Select 组件新增 popup 语义节点,支持通过 classNames.popup、styles.popup、popupRender 和 onPopupVisibleChange 自定义弹出菜单,并废弃旧的 popupClassName、dropdownClassName、dropdownStyle、dropdownRender 和 onDropdownVisibleChange API

@bolt-new-by-stackblitz
Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 21, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@accesslint accesslint Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are accessibility issues in these changes.

Comment thread components/select/__tests__/index.test.tsx
Comment thread components/select/demo/_semantic.tsx Outdated
height={200}
>
<div ref={divRef} style={{ marginBottom: 80 }}>
<Select
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

it('legacy dropdownStyle', () => {
resetWarned();
const errSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
const { container } = render(<Select dropdownStyle={{ background: 'red' }} open />);
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread components/select/__tests__/index.test.tsx
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 21, 2025

👁 Visual Regression Report for PR #53243 Failed ❌

🎯 Target branch: feature (d38aea0)
📖 View Full Report ↗︎
📖 Alternative Report ↗︎
📊 Summary: 🔄 68 changed

Expected (Branch feature) Actual (Current PR) Diff
float-button-badge-debug.compact.png float-button-badge-debug.compact.png float-button-badge-debug.compact.png float-button-badge-debug.compact.png
float-button-badge-debug.compact.png float-button-badge-debug.compact.png float-button-badge-debug.compact.css-var.png float-button-badge-debug.compact.css-var.png
float-button-badge-debug.dark.png float-button-badge-debug.dark.png float-button-badge-debug.dark.png float-button-badge-debug.dark.png
float-button-badge-debug.dark.png float-button-badge-debug.dark.png float-button-badge-debug.dark.css-var.png float-button-badge-debug.dark.css-var.png
float-button-badge-debug.default.png float-button-badge-debug.default.png float-button-badge-debug.default.png float-button-badge-debug.default.png
float-button-badge-debug.default.png float-button-badge-debug.default.png float-button-badge-debug.default.css-var.png float-button-badge-debug.default.css-var.png
float-button-badge.compact.png float-button-badge.compact.png float-button-badge.compact.png float-button-badge.compact.png
float-button-badge.compact.png float-button-badge.compact.png float-button-badge.compact.css-var.png float-button-badge.compact.css-var.png

Warning

There are more diffs not shown in the table. Please check the Full Report for details.


Important

There are 68 diffs found in this PR: 🔄 68 changed.
Please check all items:

  • Checked all diffs in the full report
  • Visual diff is acceptable

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 21, 2025

Preview is ready

@petercat-assistant
Copy link
Copy Markdown

Walkthrough

This pull request introduces a new feature to the Select component, adding support for a popup semantic node. It allows customization of the dropdown menu using classNames.popup, styles.popup, popupRender, and onPopupVisibleChange. Additionally, it retires several legacy APIs, including popupClassName, dropdownClassName, dropdownStyle, dropdownRender, and onDropdownVisibleChange.

Changes

Files Summary
components/config-provider/context.ts Updated SelectConfig type to include classNames and styles.
components/select/tests/index.test.tsx Added tests for deprecated properties with warnings for popupClassName, dropdownClassName, dropdownStyle, dropdownRender, and onDropdownVisibleChange.
components/select/demo/_semantic.tsx Added a new demo file showcasing the semantic popup feature.
components/select/demo/custom-dropdown-menu.tsx Updated to use popupRender instead of dropdownRender.
components/select/index.en-US.md, components/select/index.zh-CN.md Updated documentation to reflect the deprecation of old APIs and introduction of new ones.
components/select/index.tsx Refactored to support new popup customization options and deprecated old properties.

'popupMatchSelectWidth',
);
Object.entries(deprecatedProps).forEach(([oldProp, newProp]) => {
warning.deprecated(!(oldProp in props), oldProp, newProp);
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of Object.entries(deprecatedProps).forEach(([oldProp, newProp]) => { warning.deprecated(!(oldProp in props), oldProp, newProp); }); is a good approach to handle deprecation warnings. However, ensure that props is correctly defined and contains all necessary properties to avoid false warnings.

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 21, 2025

Bundle Report

Changes will increase total bundle size by 2.33kB (0.07%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
antd.min-array-push 3.38MB 2.33kB (0.07%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: antd.min-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
antd-with-locales.min.js 1.17kB 1.84MB 0.06%
antd.min.js 1.17kB 1.54MB 0.08%

Files in antd-with-locales.min.js:

  • ./components/config-provider/context.ts → Total Size: 1.51kB

Files in antd.min.js:

  • ./components/config-provider/context.ts → Total Size: 1.51kB

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Mar 21, 2025

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d38aea0) to head (842343f).
Report is 21 commits behind head on feature.

Additional details and impacted files
@@            Coverage Diff            @@
##           feature    #53243   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          770       771    +1     
  Lines        13880     13899   +19     
  Branches      3639      3647    +8     
=========================================
+ Hits         13880     13899   +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown

@accesslint accesslint Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are accessibility issues in these changes.

Comment thread components/select/demo/_semantic.tsx
zombieJ
zombieJ previously approved these changes Mar 21, 2025
Copy link
Copy Markdown

@accesslint accesslint Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are accessibility issues in these changes.

Comment thread components/select/demo/_semantic.tsx
Comment thread components/select/demo/_semantic.tsx
const mergedPopupClassName = classNames(
popupClassName || dropdownClassName,
const mergedPopupClassName = cls(
classNames?.popup || contextSelect?.classNames?.popup || popupClassName || dropdownClassName,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里好像有点问题,contextSelect?.classNames?.popup 的用法有点奇怪。参考 next 分支 的 hooks 优化一下吧,可以减少一点冲突。

image

Comment thread components/select/index.tsx
@zombieJ zombieJ merged commit 33fa456 into ant-design:feature Mar 21, 2025
42 checks passed
This was referenced May 6, 2025
const errSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
render(<Select onDropdownVisibleChange={() => {}} open />);
expect(errSpy).toHaveBeenCalledWith(
'Warning: [antd: Select] `onDropdownVisibleChange` is deprecated. Please use `onPopupVisibleChange` instead.',
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

onPopupVisibleChange => onPopupOpenChange 应该一步到位

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants