jdf2e / nutui-react

京东风格的移动端 React 组件库 、支持多端小程序(A React UI Toolkit for Mobile Web)
https://nutui.jd.com/react/
919 stars 263 forks source link

refactor(steps): 拆分横向和纵向 #2734

Open irisSong opened 2 weeks ago

irisSong commented 2 weeks ago

🤔 这个变动的性质是?

🔗 相关 Issue

💡 需求背景和解决方案

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

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

Summary by CodeRabbit

发布说明

coderabbitai[bot] commented 2 weeks ago

Walkthrough

此次更改主要涉及对 VerticalSteps 组件的引入和相关文档的更新,以及对现有 Steps 组件的重构。app.config.ts 文件中的字符串格式化进行了调整,CSS 文件进行了样式更新以规范化颜色和布局。新增的 VerticalSteps 组件提供了垂直步骤指示的功能,相关文档详细描述了其属性和使用示例。此外,多个演示组件和测试用例也随之更新,以支持新的功能和结构。

Changes

文件路径 更改摘要
packages/nutui-taro-demo/src/app.config.ts 格式化 subPackages 配置,字符串值由双引号改为单引号,添加了尾随逗号,components 属性采用了箭头函数语法。
src/config.json 新增 VerticalSteps 组件,类型为 component,版本为 2.0.0,描述为“拆分展示某项流程的步骤,引导用户按流程完成任务或向用户展示当前状态”。
src/packages/step/step.harmony.css 修改了多个类的颜色值为小写十六进制,调整了 .nut-step-title 的字体粗细,并删除了部分布局相关的 CSS 规则。
src/packages/step/step.scss 删除了多个与布局相关的 CSS 属性和规则,简化了样式。
src/packages/step/step.taro.tsx 修改 DataContext 的导入路径。
src/packages/step/step.tsx 修改 DataContext 的导入路径。
src/packages/steps/demo.taro.tsx 删除了 Demo8Demo9 的导入及其对应的翻译条目,修改了 ScrollView 的类名。
src/packages/steps/demo.tsx 删除了 Demo8Demo9 的导入及其对应的翻译条目。
src/packages/steps/demos/h5/demo9.tsx 删除了 Demo9 组件文件。
src/packages/steps/demos/taro/demo9.tsx 删除了 Demo9 组件文件。
src/packages/steps/doc.en-US.md 删除了关于“Vertical step bar”和“Point step and vertical direction”的两个部分及其示例代码,更新了 Steps 组件的属性表,移除了 direction 属性。
src/packages/steps/doc.md 删除了关于“竖向步骤条”和“点状步骤和垂直方向”的两个部分及其示例代码,保留了 direction 属性但移除了相关示例。
src/packages/steps/doc.taro.md 完全重新格式化文档,移除了 direction 属性。
src/packages/steps/doc.zh-TW.md 删除了关于“豎向步驟條”和“點狀步驟和垂直方向”的部分,保留了其余内容。
src/packages/steps/steps.harmony.css 引入新的 CSS 类以增强步骤组件的视觉表现。
src/packages/steps/steps.scss 引入 .nut-steps-horizontal 类,删除了 .nut-steps-vertical 类,简化了样式。
src/packages/steps/steps.taro.tsx 修改 DataContext 的导入路径,移除 direction 属性。
src/packages/steps/steps.tsx 修改 DataContext 的导入路径,移除 direction 属性。
src/packages/verticalsteps/tests/steps.spec.tsx 引入了针对 VerticalSteps 组件的单元测试,涵盖渲染、动态更新、事件处理等功能。
src/packages/verticalsteps/demo.taro.tsx 新增 StepsDemo 组件,展示多个示例组件。
src/packages/verticalsteps/demo.tsx 新增 StepsDemo 组件,展示多个示例组件。
src/packages/verticalsteps/demos/h5/demo1.tsx 将组件名称从 Demo8 更改为 Demo1,更新了导入路径。
src/packages/verticalsteps/demos/h5/demo2.tsx 新增 Demo2 组件,展示垂直步骤指示。
src/packages/verticalsteps/demos/h5/demo3.tsx 新增 Demo3 组件,展示垂直步骤指示。
src/packages/verticalsteps/demos/taro/demo1.tsx 将组件名称从 Demo8 更改为 Demo1,更新了导入路径。
src/packages/verticalsteps/demos/taro/demo2.tsx 新增 Demo2 组件,展示垂直步骤指示。
src/packages/verticalsteps/demos/taro/demo3.tsx 新增 Demo3 组件,展示垂直步骤指示。
src/packages/verticalsteps/doc.en-US.md 新增 VerticalSteps 组件的文档,详细描述其属性和使用示例。
src/packages/verticalsteps/doc.md 新增 VerticalSteps 组件的文档,详细描述其属性和使用示例。
src/packages/verticalsteps/doc.taro.md 新增 VerticalSteps 组件的文档,详细描述其属性和使用示例。
src/packages/verticalsteps/doc.zh-TW.md 新增 VerticalSteps 组件的文档,详细描述其属性和使用示例。
src/packages/verticalsteps/index.taro.ts 新增 index.taro.ts 文件,导出 VerticalSteps 组件和其属性类型。
src/packages/verticalsteps/index.ts 新增 index.ts 文件,导出 VerticalSteps 组件和其属性类型。
src/packages/verticalsteps/verticalsteps.harmony.css 新增 CSS 文件,定义垂直步骤组件的样式。
src/packages/verticalsteps/verticalsteps.scss 新增样式文件,定义垂直步骤组件的样式。
src/packages/verticalsteps/verticalsteps.taro.tsx 新增 VerticalSteps 组件,定义其属性和渲染逻辑。
src/packages/verticalsteps/verticalsteps.tsx 新增 VerticalSteps 组件,定义其属性和渲染逻辑。
src/styles/variables.scss 新增 CSS 变量 $verticalsteps-dot-head-margin,并整理了其他变量。

Suggested labels

size/XL

Suggested reviewers

兔子在草地上欢跳,
新组件来报到!
步骤清晰如春风,
代码整齐真美妙。
让我们一起欢呼,
垂直步骤更好用! 🐰✨

[!WARNING] There were issues while running the following tools:

🔧 eslint
packages/nutui-taro-demo/src/app.config.ts Oops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the config "taro/react" to extend from. Please check that the name of the config is correct. The config "taro/react" was referenced from the config file in "/packages/nutui-taro-demo/.eslintrc". If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.98%. Comparing base (ce66f75) to head (f27164c).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## V3.0 #2734 +/- ## ======================================= Coverage 83.98% 83.98% ======================================= Files 221 221 Lines 17867 17867 Branches 2676 2676 ======================================= Hits 15005 15005 Misses 2857 2857 Partials 5 5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.