Skip to content

feat(Modal): config global okButtonProps & cancelButtonProps#53684

Merged
afc163 merged 1 commit intoant-design:nextfrom
guoyunhe:next-modal-config
May 6, 2025
Merged

feat(Modal): config global okButtonProps & cancelButtonProps#53684
afc163 merged 1 commit intoant-design:nextfrom
guoyunhe:next-modal-config

Conversation

@guoyunhe
Copy link
Contributor

@guoyunhe guoyunhe commented Apr 28, 2025

…uttonProps

中文版模板 / Chinese template

🤔 This is a ...

  • 🆕 New feature
  • 🐞 Bug fix
  • 📝 Site / documentation improvement
  • 📽️ Demo improvement
  • 💄 Component style improvement
  • 🤖 TypeScript definition improvement
  • 📦 Bundle size optimization
  • ⚡️ Performance optimization
  • ⭐️ Feature enhancement
  • 🌐 Internationalization
  • 🛠 Refactoring
  • 🎨 Code style optimization
  • ✅ Test Case
  • 🔀 Branch merge
  • ⏩ Workflow
  • ⌨️ Accessibility improvement
  • ❓ Other (about what?)

🔗 Related Issues

  • Describe the source of related requirements, such as links to relevant issue discussions.
  • For example: close #xxxx, fix #xxxx

💡 Background and Solution

支持全局配置 OK 和 Cancel 按钮的文字及属性。

📝 Change Log

Language Changelog
🇺🇸 English feat(Modal): config global okButtonProps & cancelButtonProps
🇨🇳 Chinese feat(Modal): 配置全局 okButtonProps 和 cancelButtonProps

@bolt-new-by-stackblitz
Copy link

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 28, 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 28, 2025

👁 Visual Regression Report for PR #53684 Passed ✅

🎯 Target branch: next (91c2b99)
📖 View Full Report ↗︎
📖 Alternative Report ↗︎

🎊 Congrats! No visual-regression diff found.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 28, 2025

Preview is ready

@petercat-assistant
Copy link

Walkthrough

This pull request enhances the Modal component by allowing global configuration of the OK and Cancel buttons' text and properties. This feature enhancement aims to provide more flexibility and customization options for developers using the Modal component.

Changes

Files Summary
components/config-provider/context.ts Updated ModalConfig type to include okButtonProps, okText, cancelButtonProps, and cancelText for global configuration.
components/modal/ConfirmDialog.tsx, components/modal/Modal.tsx Integrated global configuration for okButtonProps, okText, cancelButtonProps, and cancelText into the Modal component, allowing these properties to be overridden by context values.

<ConfirmContent
{...props}
confirmPrefixCls={confirmPrefixCls}
okButtonProps={{ ...contextOkButtonProps, ...okButtonProps }}

Choose a reason for hiding this comment

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

Ensure that merging of okButtonProps and contextOkButtonProps does not lead to unintended overrides or conflicts. Consider validating the merged result to prevent potential issues.

confirmPrefixCls={confirmPrefixCls}
okButtonProps={{ ...contextOkButtonProps, ...okButtonProps }}
okText={okText || contextOkText}
cancelButtonProps={{ ...contextCancelButtonProps, ...cancelButtonProps }}

Choose a reason for hiding this comment

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

Ensure that merging of cancelButtonProps and contextCancelButtonProps does not lead to unintended overrides or conflicts. Consider validating the merged result to prevent potential issues.

<Footer {...props} onOk={handleOk} onCancel={handleCancel} />
<Footer
{...props}
okButtonProps={{ ...contextOkButtonProps, ...okButtonProps }}

Choose a reason for hiding this comment

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

Ensure that merging of okButtonProps and contextOkButtonProps does not lead to unintended overrides or conflicts. Consider validating the merged result to prevent potential issues.

okButtonProps={{ ...contextOkButtonProps, ...okButtonProps }}
okText={okText || contextOkText}
onOk={handleOk}
cancelButtonProps={{ ...contextCancelButtonProps, ...cancelButtonProps }}

Choose a reason for hiding this comment

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

Ensure that merging of cancelButtonProps and contextCancelButtonProps does not lead to unintended overrides or conflicts. Consider validating the merged result to prevent potential issues.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Apr 28, 2025

@codecov
Copy link

codecov bot commented Apr 28, 2025

Bundle Report

Changes will increase total bundle size by 552 bytes (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
antd.min-array-push 3.75MB 552 bytes (0.01%) ⬆️

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 276 bytes 2.06MB 0.01%
antd.min.js 276 bytes 1.69MB 0.02%

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

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

Files in antd.min.js:

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

@codecov
Copy link

codecov bot commented Apr 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (91c2b99) to head (d701b68).
Report is 17 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff            @@
##              next    #53684   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          783       783           
  Lines        14215     14216    +1     
  Branches      3737      3737           
=========================================
+ Hits         14215     14216    +1     

☔ 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.

@guoyunhe guoyunhe force-pushed the next-modal-config branch 3 times, most recently from 9b75f5f to f803fc9 Compare April 29, 2025 06:10
@guoyunhe guoyunhe changed the title feat(Modal): config global okText, okButtonProps, cancelText, cancelB… feat(Modal): config global okButtonProps & cancelButtonProps Apr 29, 2025
@guoyunhe guoyunhe force-pushed the next-modal-config branch from f803fc9 to 7969c05 Compare April 29, 2025 06:19
@guoyunhe guoyunhe force-pushed the next-modal-config branch from 7969c05 to d701b68 Compare April 29, 2025 14:30
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 6, 2025
@afc163 afc163 merged commit 76cf993 into ant-design:next May 6, 2025
38 of 40 checks passed
@guoyunhe guoyunhe deleted the next-modal-config branch May 12, 2025 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants