Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: ✨ MessageBox 增加 showConfirmButton 配置 #837

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

undefcc
Copy link

@undefcc undefcc commented Jan 13, 2025

🤔 这个 PR 的性质是?(至少选择一个)

  • 日常 bug 修复
  • 新特性提交
  • 站点、文档改进
  • 演示代码改进
  • 组件样式/交互改进
  • TypeScript 定义更新
  • CI/CD 改进
  • 包体积优化
  • 性能优化
  • 功能增强
  • 国际化改进
  • 代码重构
  • 代码风格优化
  • 测试用例
  • 分支合并
  • 其他改动(是关于什么的改动?)

🔗 相关 Issue

参考其它UI库,应允许不展示确定按钮,同时完善了showConfirmButton和showCancelButton两个配置项的文档说明。

💡 需求背景和解决方案

☑️ 请求合并前的自查清单

⚠️ 请自检并全部勾选全部选项⚠️

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充

Summary by CodeRabbit

  • 新功能
    • 为消息框组件添加了控制确认和取消按钮显示的选项
    • 开发者现在可以精细控制消息框中按钮的可见性
    • 新增 showConfirmButtonshowCancelButton 配置属性,默认为 true

Copy link

vercel bot commented Jan 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
wot-design-uni ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 13, 2025 5:21pm

Copy link

coderabbitai bot commented Jan 13, 2025

概述

遍历

此拉取请求为 MessageBox 组件引入了两个新的选项属性:showConfirmButtonshowCancelButton。这些新属性允许开发者更灵活地控制确认和取消按钮的可见性。showConfirmButton 默认为 true,而 showCancelButton 的默认行为取决于消息框的类型。

变更

文件 变更摘要
docs/component/message-box.md 文档更新,描述新的按钮可见性选项
src/uni_modules/wot-design-uni/components/wd-message-box/types.ts 添加 showConfirmButton 可选属性到 MessageOptions 类型
src/uni_modules/wot-design-uni/components/wd-message-box/wd-message-box.vue 添加 showConfirmButton 属性到 messageState,并更新确认按钮的条件渲染

可能相关的 PRs

建议的审阅者

  • Moonofweisheng

诗歌

🐰 消息盒子,按钮随心显
确认取消,自由掌控间
开发者的魔法,灵活无限
点击与否,由你来牵绊
代码之美,兔子在欢颜!

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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

netlify bot commented Jan 13, 2025

Deploy Preview for wot-design-uni ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit bd19dbb
🔍 Latest deploy log https://app.netlify.com/sites/wot-design-uni/deploys/67854b4528604600089b8c7b
😎 Deploy Preview https://deploy-preview-837--wot-design-uni.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/uni_modules/wot-design-uni/components/wd-message-box/wd-message-box.vue (1)

38-40: 建议优化模板可读性

当前的 v-if 条件直接嵌入在模板中,建议将复杂的条件判断抽取为计算属性以提高可读性。

-          <wd-button v-bind="customConfirmProps" v-if="messageState.showConfirmButton" @click="toggleModal('confirm')">
+          <wd-button v-bind="customConfirmProps" v-if="showConfirmButtonVisible" @click="toggleModal('confirm')">
             {{ messageState.confirmButtonText || translate('confirm') }}
           </wd-button>

添加计算属性:

const showConfirmButtonVisible = computed(() => messageState.showConfirmButton)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e6096a and bd19dbb.

📒 Files selected for processing (3)
  • docs/component/message-box.md (1 hunks)
  • src/uni_modules/wot-design-uni/components/wd-message-box/types.ts (1 hunks)
  • src/uni_modules/wot-design-uni/components/wd-message-box/wd-message-box.vue (3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
docs/component/message-box.md

265-265: Expected: 6; Actual: 5; Too few cells, row will be missing data
Table column count

(MD056, table-column-count)


266-266: Expected: 6; Actual: 5; Too few cells, row will be missing data
Table column count

(MD056, table-column-count)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - wot-design-uni
  • GitHub Check: Header rules - wot-design-uni
  • GitHub Check: Pages changed - wot-design-uni
🔇 Additional comments (2)
src/uni_modules/wot-design-uni/components/wd-message-box/types.ts (1)

25-28: 类型定义清晰且文档完整!

类型定义添加合理,并且包含了清晰的注释说明。

src/uni_modules/wot-design-uni/components/wd-message-box/wd-message-box.vue (1)

87-87: 状态管理实现完整且合理!

  • 正确初始化了 showConfirmButton 的默认值
  • 在 reset 函数中正确处理了选项值的更新

Also applies to: 263-263

docs/component/message-box.md Show resolved Hide resolved
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.

1 participant