Skip to content

Conversation

@xiaoyatong
Copy link
Collaborator

@xiaoyatong xiaoyatong commented Mar 5, 2025

🤔 这个变动的性质是?

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

🔗 相关 Issue

💡 需求背景和解决方案

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

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

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

Summary by CodeRabbit

  • 文档更新

    • 更新了侧边导航组件说明,现明确指出因不符合移动端规范而弃用,并推荐使用替代组件。
    • 新增音频组件说明,告知当前不支持 Taro 多端平台,建议改用 API 方案。
    • 移除了与已弃用的侧边导航组件相关的所有文档。
  • 内部调整

    • 调整了部分配置参数以确保版本一致性,并移除部分已弃用的导航组件定义。
    • 删除了与侧边导航及其子组件相关的所有代码和样式文件。

@github-actions github-actions bot added the 3.x Target branch 3.x label Mar 5, 2025
@coderabbitai
Copy link

coderabbitai bot commented Mar 5, 2025

Walkthrough

本次更新对文档说明和配置文件做了调整。文档 (migrate-from-v2.md) 中更新了 SideNavBar 的弃用说明,强调其不符合移动端规范,同时新增了关于 Audio 组件在 Taro 多端不支持的说明。配置文件 (src/config.json) 中对多个组件的 "v15" 属性进行了数值调整,并移除了 SideNavBar 及其相关子组件的配置定义。

Changes

文件 变更概要
migrate-from-v2.md 更新 SideNavBar 弃用说明(明确指出不符合移动端规范),新增 Audio 组件在 Taro 多端不支持的说明。
src/config.json 修改多个组件的 "v15" 数值(如 99→990、100→1000、1→990、false→-1),并移除 SideNavBar、SideNavBarItem、SubSideNavBar 的配置。
src/packages/sidenavbar/__test__/sidenavbar.spec.tsx 删除 sidenavbar 组件的单元测试文件。
src/packages/sidenavbar/context.ts 删除 OffsetContext 的定义。
src/packages/sidenavbar/demo.taro.tsx 删除 SideNavBarDemo 组件的演示文件。
src/packages/sidenavbar/demo.tsx 删除 SideNavBarDemo 组件的演示文件。
src/packages/sidenavbar/demos/h5/demo1.tsx 删除 Demo1 组件的演示文件。
src/packages/sidenavbar/demos/h5/demo2.tsx 删除 Demo2 组件的演示文件。
src/packages/sidenavbar/demos/taro/demo1.tsx 删除 Demo1 组件的演示文件。
src/packages/sidenavbar/demos/taro/demo2.tsx 删除 Demo2 组件的演示文件。
src/packages/sidenavbar/doc.en-US.md 删除 SideNavBar 组件的英文文档。
src/packages/sidenavbar/doc.md 删除 SideNavBar 组件的文档。
src/packages/sidenavbar/doc.taro.md 删除 SideNavBar 组件的 Taro 文档。
src/packages/sidenavbar/doc.zh-TW.md 删除 SideNavBar 组件的繁体中文文档。
src/packages/sidenavbar/index.taro.ts 删除 SideNavBar 的导出文件。
src/packages/sidenavbar/index.ts 删除 SideNavBar 的导出文件。
src/packages/sidenavbar/sidenavbar.scss 删除 sidenavbar 的样式文件。
src/packages/sidenavbar/sidenavbar.taro.tsx 删除 SideNavBar 组件的实现文件。
src/packages/sidenavbar/sidenavbar.tsx 删除 SideNavBar 组件的实现文件。
src/packages/sidenavbar/utils.ts 删除 handleClick 函数。
src/packages/sidenavbaritem/__test__/sidenavbaritem.spec.tsx 删除 SideNavBarItem 组件的单元测试文件。
src/packages/sidenavbaritem/index.taro.ts 删除 SideNavBarItem 的导出文件。
src/packages/sidenavbaritem/index.ts 删除 SideNavBarItem 的导出文件。
src/packages/sidenavbaritem/sidenavbaritem.scss 删除 sidenavbaritem 的样式文件。
src/packages/sidenavbaritem/sidenavbaritem.taro.tsx 删除 SideNavBarItem 组件的实现文件。
src/packages/sidenavbaritem/sidenavbaritem.tsx 删除 SideNavBarItem 组件的实现文件。
src/packages/subsidenavbar/__test__/subsidenavbar.spec.tsx 删除 SubSideNavBar 组件的单元测试文件。
src/packages/subsidenavbar/index.taro.ts 删除 SubSideNavBar 的导出文件。
src/packages/subsidenavbar/index.ts 删除 SubSideNavBar 的导出文件。
src/packages/subsidenavbar/subsidenavbar.scss 删除 subsidenavbar 的样式文件。
src/packages/subsidenavbar/subsidenavbar.taro.tsx 删除 SubSideNavBar 组件的实现文件。
src/packages/subsidenavbar/subsidenavbar.tsx 删除 SubSideNavBar 组件的实现文件。
src/styles/variables-jmapp.scss 删除与 sidenavbar 相关的多个样式变量。
src/styles/variables-jrkf.scss 删除与 sidenavbar 相关的多个样式变量。
src/styles/variables.scss 删除与 sidenavbar 相关的多个样式变量。

Possibly related PRs

Suggested reviewers

  • Alex-huxiyang

Poem

我是一只小兔子,轻跳代码林中行,
文档清晰似晨曦,配置更新映星星。
SideNavBar已成旧梦,Audio告诫别迷茫,
数字轻跃舞乾坤,未来代码更辉煌!
🐇✨ Happy coding!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 56fa69b and 0b2cf08.

⛔ Files ignored due to path filters (2)
  • src/packages/sidenavbaritem/__test__/__snapshots__/sidenavbaritem.spec.tsx.snap is excluded by !**/*.snap
  • src/packages/subsidenavbar/__test__/__snapshots__/subsidenavbar.spec.tsx.snap is excluded by !**/*.snap
📒 Files selected for processing (33)
  • src/packages/sidenavbar/__test__/sidenavbar.spec.tsx (0 hunks)
  • src/packages/sidenavbar/context.ts (0 hunks)
  • src/packages/sidenavbar/demo.taro.tsx (0 hunks)
  • src/packages/sidenavbar/demo.tsx (0 hunks)
  • src/packages/sidenavbar/demos/h5/demo1.tsx (0 hunks)
  • src/packages/sidenavbar/demos/h5/demo2.tsx (0 hunks)
  • src/packages/sidenavbar/demos/taro/demo1.tsx (0 hunks)
  • src/packages/sidenavbar/demos/taro/demo2.tsx (0 hunks)
  • src/packages/sidenavbar/doc.en-US.md (0 hunks)
  • src/packages/sidenavbar/doc.md (0 hunks)
  • src/packages/sidenavbar/doc.taro.md (0 hunks)
  • src/packages/sidenavbar/doc.zh-TW.md (0 hunks)
  • src/packages/sidenavbar/index.taro.ts (0 hunks)
  • src/packages/sidenavbar/index.ts (0 hunks)
  • src/packages/sidenavbar/sidenavbar.scss (0 hunks)
  • src/packages/sidenavbar/sidenavbar.taro.tsx (0 hunks)
  • src/packages/sidenavbar/sidenavbar.tsx (0 hunks)
  • src/packages/sidenavbar/utils.ts (0 hunks)
  • src/packages/sidenavbaritem/__test__/sidenavbaritem.spec.tsx (0 hunks)
  • src/packages/sidenavbaritem/index.taro.ts (0 hunks)
  • src/packages/sidenavbaritem/index.ts (0 hunks)
  • src/packages/sidenavbaritem/sidenavbaritem.scss (0 hunks)
  • src/packages/sidenavbaritem/sidenavbaritem.taro.tsx (0 hunks)
  • src/packages/sidenavbaritem/sidenavbaritem.tsx (0 hunks)
  • src/packages/subsidenavbar/__test__/subsidenavbar.spec.tsx (0 hunks)
  • src/packages/subsidenavbar/index.taro.ts (0 hunks)
  • src/packages/subsidenavbar/index.ts (0 hunks)
  • src/packages/subsidenavbar/subsidenavbar.scss (0 hunks)
  • src/packages/subsidenavbar/subsidenavbar.taro.tsx (0 hunks)
  • src/packages/subsidenavbar/subsidenavbar.tsx (0 hunks)
  • src/styles/variables-jmapp.scss (0 hunks)
  • src/styles/variables-jrkf.scss (0 hunks)
  • src/styles/variables.scss (0 hunks)
💤 Files with no reviewable changes (33)
  • src/packages/sidenavbaritem/test/sidenavbaritem.spec.tsx
  • src/packages/sidenavbar/doc.en-US.md
  • src/packages/sidenavbar/context.ts
  • src/packages/sidenavbar/test/sidenavbar.spec.tsx
  • src/packages/sidenavbaritem/sidenavbaritem.scss
  • src/packages/sidenavbaritem/sidenavbaritem.tsx
  • src/packages/sidenavbar/doc.taro.md
  • src/packages/sidenavbaritem/index.ts
  • src/packages/sidenavbar/sidenavbar.scss
  • src/packages/sidenavbar/doc.zh-TW.md
  • src/packages/sidenavbaritem/sidenavbaritem.taro.tsx
  • src/packages/sidenavbar/demo.tsx
  • src/packages/sidenavbar/utils.ts
  • src/packages/sidenavbaritem/index.taro.ts
  • src/packages/sidenavbar/sidenavbar.taro.tsx
  • src/packages/sidenavbar/sidenavbar.tsx
  • src/packages/subsidenavbar/test/subsidenavbar.spec.tsx
  • src/packages/subsidenavbar/subsidenavbar.scss
  • src/packages/subsidenavbar/index.ts
  • src/packages/sidenavbar/index.ts
  • src/packages/subsidenavbar/subsidenavbar.taro.tsx
  • src/packages/sidenavbar/demos/h5/demo1.tsx
  • src/packages/subsidenavbar/index.taro.ts
  • src/packages/sidenavbar/doc.md
  • src/packages/sidenavbar/demo.taro.tsx
  • src/styles/variables-jrkf.scss
  • src/styles/variables.scss
  • src/packages/subsidenavbar/subsidenavbar.tsx
  • src/packages/sidenavbar/demos/taro/demo2.tsx
  • src/packages/sidenavbar/index.taro.ts
  • src/packages/sidenavbar/demos/taro/demo1.tsx
  • src/styles/variables-jmapp.scss
  • src/packages/sidenavbar/demos/h5/demo2.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test

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.

@github-actions github-actions bot added the action:review This PR needs more reviews (less than 2 approvals) label Mar 5, 2025
@codecov
Copy link

codecov bot commented Mar 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.06%. Comparing base (f50de3c) to head (0b2cf08).
Report is 1 commits behind head on feat_v3.x.

Additional details and impacted files
@@              Coverage Diff              @@
##           feat_v3.x    #3052      +/-   ##
=============================================
- Coverage      86.11%   86.06%   -0.05%     
=============================================
  Files            283      275       -8     
  Lines          18399    18234     -165     
  Branches        2768     2751      -17     
=============================================
- Hits           15845    15694     -151     
+ Misses          2549     2535      -14     
  Partials           5        5              

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

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: 0

🧹 Nitpick comments (2)
migrate-from-v2.md (2)

136-138: 【SideNavBar弃用说明】文档说明清晰
文档中对于 SideNavBar 的更新提示已经明确指出该组件因不符合移动端规范而被废弃,并建议使用 SideBar 进行替换。建议检查强调符号周围的空格,确保符合 markdownlint 规范。

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

138-138: Spaces inside emphasis markers
null

(MD037, no-space-in-emphasis)


138-138: Spaces inside emphasis markers
null

(MD037, no-space-in-emphasis)


224-226: 【Audio组件说明更新】传达 Taro 多端支持状态
对于 Audio 组件的说明已更新,明确指出该组件在 Taro 多端上没有计划支持,建议用户使用相关 API 替代。请注意检查文档中的格式细节,避免因空格问题触发 markdownlint 警告。

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f50de3c and 56fa69b.

📒 Files selected for processing (2)
  • migrate-from-v2.md (2 hunks)
  • src/config.json (12 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
migrate-from-v2.md

138-138: Spaces inside emphasis markers
null

(MD037, no-space-in-emphasis)


138-138: Spaces inside emphasis markers
null

(MD037, no-space-in-emphasis)


227-227: Spaces inside emphasis markers
null

(MD037, no-space-in-emphasis)


227-227: Spaces inside emphasis markers
null

(MD037, no-space-in-emphasis)

🔇 Additional comments (11)
src/config.json (11)

283-286: 【Sticky组件配置】确认属性更新
Sticky 组件的 "v15" 参数已更新为 990,同时 "dd" 属性修改为 false。请确认这一改动与前端设计要求保持一致,确保该组件在新版中正确展示。


777-782: 【签名组件配置】检查 Signature 组件更新
Signature 组件的 "v15" 属性已调整为 990,同时 "dd" 属性设置为 false。请确认这一改动与最新设计文档一致,不会影响组件的预期交互。


819-823: 【上传组件配置】更新 Uploader 组件参数
Uploader 组件的 "v15" 属性已修改为 1000,并将 "dd" 置为 false。请检查此更新是否正确反映了后续版本对该组件状态的管理要求。


1053-1056: 【动画组件配置】调整 Animate 组件参数
Animate 组件中的 "v15" 属性现调整为 990,同时 "dd" 改为 false。建议确认该配置与其它动画/动效组件标准保持一致。


1066-1069: 【数字动画配置】检查 AnimatingNumbers 参数更新
AnimatingNumbers 组件的 "v15" 参数更新为 990。请确认此更新不会对组件的动画效果产生不良影响,并与整体视觉风格相符合。


1079-1082: 【音频播放器配置】明确 Taro 多端支持状态
Audio 组件的 "v15" 设置为 -1,表明该组件在 Taro 多端上暂无支持,同时 "dd"false。请确保文档中对此说明得足够清晰,以便用户了解当前的使用限制。


1168-1171: 【文本省略组件配置】更新 Ellipsis 参数
Ellipsis 组件的 "v15" 已调整为 990,并将 "dd" 修改为 false。请核对这一调整是否符合整体配置更新的意图和视觉规范。


1373-1376: 【虚拟列表配置】验证 VirtualList 属性调整
VirtualList 组件的 "v15" 属性现更新为 1000,同时 "dd" 属性设置为 false。建议确认该改动与组件更新方案及预期展示效果相符。


1456-1459: 【趋势箭头配置】检查 TrendArrow 参数更新
TrendArrow 组件的 "v15" 参数已调整为 1000,而 "dd" 依旧为 true。请核实这一改动是否能满足新设计对趋势展示的需求。


1469-1472: 【水印组件配置】确认 WaterMark 属性更新
WaterMark 组件的 "v15" 已修改为 990,并将 "dd" 改为 false。请确认这一更新符合整体视觉风格及配置规范要求。


290-300: 【废弃组件配置移除】核实已清除废弃配置
配置中已移除不再支持的 SideNavBar、SideNavBarItem 与 SubSideNavBar 组件的相关定义。请确认这些废弃组件已在所有文档和代码中被正确剔除,并提醒用户使用推荐的替代组件(如 SideBar)。

Copy link
Collaborator

@Miles-hxy Miles-hxy left a comment

Choose a reason for hiding this comment

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

sidenavbar相关的得去干净,可以参考下未通过的ci

@oasis-cloud oasis-cloud merged commit f560400 into jdf2e:feat_v3.x Mar 5, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3.x Target branch 3.x action:review This PR needs more reviews (less than 2 approvals) size/XXL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants