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(menu): menu-item 组件增加标题icon自定义方式 #2488

Merged
merged 4 commits into from
Aug 2, 2024

Conversation

zhangminggeek
Copy link
Contributor

@zhangminggeek zhangminggeek commented Jul 28, 2024

🤔 这个变动的性质是?

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

🔗 相关 Issue

#2487

💡 需求背景和解决方案

  1. 解决 Menu 标题的 icon 自定义程度不足问题
  2. Menu.Item 增加 titleIcon 用于配置标题 icon

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

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

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充
  • fork仓库代码是否为最新避免文件冲突
  • Files changed 没有 package.json lock 等无关文件

Summary by CodeRabbit

  • 新功能

    • 在菜单组件中新增titleIcon属性,允许用户在菜单项旁边显示自定义图标,提升界面清晰度和交互体验。
    • 在Demo6组件中引入了新的Filter图标,进一步增强了菜单项的视觉表示。
  • 文档

    • 更新了菜单组件文档,增加了关于titleIcon属性的描述,帮助开发者更好地理解和使用该功能。

Copy link

coderabbitai bot commented Jul 28, 2024

Warning

Rate limit exceeded

@Alex-huxiyang has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 49 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between bbcd4f0 and 2731930.

Walkthrough

此次更改主要集中在 MenuMenuItem 组件中,新增了 titleIcon 属性,允许用户在菜单项中显示额外的图标,从而增强用户界面的可视化效果。同时,相关的文档也进行了更新,以反映这些新功能。这些修改提升了组件的可用性和灵活性,但并未改变其核心逻辑。

Changes

文件路径 修改摘要
src/packages/menu/demos/h5/demo6.tsx 增加 titleIcon 属性,导入 Filter 图标,改善 Menu.Item 的视觉表现。
src/packages/menu/demos/taro/demo6.tsx 增加 titleIcon 属性,更新图标导入,改善 Menu.Item 可视化效果,允许用户添加 Filter 图标。
src/packages/menu/doc.md 文档中新增 titleIcon 属性,介绍其类型为 React.ReactNode,默认值为 ArrowUp/ArrowDown
src/packages/menu/doc.taro.md 同样新增 titleIcon 属性到文档,描述其类型和默认值。
src/packages/menu/menu.taro.tsx Menu 组件中新增 titleIcon 属性,封装图标渲染逻辑到 finallyIcon 函数中,改善代码可读性。
src/packages/menu/menu.tsx Menu 组件中引入 titleIcon 属性,并更新图标渲染逻辑,允许自定义图标。
src/packages/menuitem/menuitem.taro.tsx 更新 MenuItemProps 接口,新增 titleIcon 属性,设置默认值为 null,增强组件的灵活性。
src/packages/menuitem/menuitem.tsx MenuItemProps 接口中新增 titleIcon 属性,类型为 React.ReactNode,设置默认值为 null,使组件支持更多自定义选项。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Menu
    participant MenuItem
    participant IconRenderer

    User->>Menu: 点击菜单项
    Menu->>MenuItem: 渲染菜单项
    MenuItem->>IconRenderer: 请求图标
    IconRenderer-->>MenuItem: 返回 titleIcon 或 默认图标
    MenuItem-->>Menu: 显示菜单项
Loading

Poem

🐰 兔子在草地上跳跃,
新图标使菜单更显耀。
菜单项里图标闪烁,
用户体验乐无穷。
让我们欢呼庆祝吧,
这些变化真精彩! 🎉


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

@oasis-cloud
Copy link
Collaborator

可以先解决一下冲突

Copy link

codecov bot commented Jul 29, 2024

Codecov Report

Attention: Patch coverage is 80.76923% with 5 lines in your changes missing coverage. Please review.

Project coverage is 83.06%. Comparing base (96eb279) to head (bbcd4f0).
Report is 1 commits behind head on next.

Files Patch % Lines
src/packages/menu/menu.tsx 80.00% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             next    #2488      +/-   ##
==========================================
+ Coverage   83.05%   83.06%   +0.01%     
==========================================
  Files         217      217              
  Lines       17744    17756      +12     
  Branches     2549     2552       +3     
==========================================
+ Hits        14737    14749      +12     
  Misses       3002     3002              
  Partials        5        5              

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

@Alex-huxiyang Alex-huxiyang merged commit 123595a into jdf2e:next Aug 2, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants