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

Steve/modal-stack #388

Merged
merged 3 commits into from
Oct 16, 2024
Merged

Steve/modal-stack #388

merged 3 commits into from
Oct 16, 2024

Conversation

weareoutman
Copy link
Member

@weareoutman weareoutman commented Oct 16, 2024

依赖检查

组件之间的依赖声明,是微服务组件架构下的重要信息,请确保其正确性。

请勾选以下两组选项其中之一:

  • 本次 MR 没有使用上游组件(例如框架、后台组件等)的较新版本提供的特性。

或者:

  • 本次 MR 使用了上游组件(例如框架、后台组件等)的较新版本提供的特性。
  • 在对应的文件中更新了该上游组件的依赖版本(或确认了当前声明的依赖版本已包含本次 MR 使用的新特性)。

提交信息检查

Git 提交信息将决定包的版本发布及自动生成的 CHANGELOG,请检查工作内容与提交信息是否相符,并在以下每组选项中都依次确认。

破坏性变更是针对于下游使用者而言,可以通过本次改动对下游使用者的影响来识别变更类型:

  • 下游使用者不做任何改动,仍可以正常工作时,那么它属于普通变更。
  • 反之,下游使用者不做改动就无法正常工作时,那么它属于破坏性变更。

例如,构件修改了一个属性名,小产品 Storyboard 中需要使用新属性名才能工作,那么它就是破坏性变更。
又例如,构件还没有任何下游使用者,那么它的任何变更都是普通变更。

破坏性变更:

  • ⚠️ 本次 MR 包含破坏性变更的提交,请继续确认以下所有选项:
  • 没有更好的兼容方案,必须做破坏性变更。
  • 使用了 feat 作为提交类型。
  • 标注了 BREAKING CHANGE: 你的变更说明
  • 同时更新了本仓库中所有下游使用者的调用。
  • 同时更新了本仓库中所有下游使用者对该子包的依赖为即将发布的 major 版本。
  • 同时为其它仓库的 Migrating 做好了准备,例如文档或批量改动的方法。
  • 手动验证过破坏性变更在 Migrate 后可以正常工作。
  • 破坏性变更所在的提交没有意外携带其它子包的改动。

新特性:

  • 本次 MR 包含新特性的提交,且该提交不带有破坏性变更,并使用了 feat 作为提交类型。
  • 给新特性添加了单元测试。
  • 手动验证过新特性可以正常工作。

问题修复:

  • 本次 MR 包含问题修复的提交,且该提交不带有新特性或破坏性变更,并使用了 fix 作为提交类型。
  • 给问题修复添加了单元测试。
  • 手动验证过问题修复得到解决。

杂项工作:

即所有对下游使用者无任何影响、且没有必要显示在 CHANGELOG 中的改动,例如修改注释、测试用例、开发文档等:

  • 本次 MR 包含杂项工作的提交,且该提交不带有问题修复、新特性或破坏性变更,并使用了 chore, docs, test 等作为提交类型。

Summary by CodeRabbit

  • 新功能

    • 引入了可堆叠的抽屉和模态框,允许多个实例同时打开,优化了 z-index 管理。
  • 依赖更新

    • 更新了多个依赖包的版本,以保持系统的最新状态。

Copy link

coderabbitai bot commented Oct 16, 2024

Walkthrough

此次更改涉及多个组件的更新,主要集中在 GeneralDrawerGeneralModal 组件的状态管理和堆叠功能上。GeneralDrawerGeneralModal 组件的属性接口均增加了 stack 和可选的 stackable 属性,以支持多个实例的堆叠。通过引入新的状态变量 zIndexuseEffect 钩子,组件能够根据可见性动态管理 z-index。此外,相关的类和方法也进行了相应的调整,以确保堆叠逻辑的正确实现。

Changes

文件路径 更改摘要
bricks/basic-bricks/src/general-drawer/GeneralDrawer.tsx 更新了 GeneralDrawer 组件,增加了 stackstackable 属性,添加了状态变量 zIndex,并修改了 useEffect 钩子的逻辑。
bricks/basic-bricks/src/general-drawer/index.tsx 更新了 GeneralDrawerElement 类,增加了 stackable 属性,初始化了 _stack 变量,并修改了 _render 方法以传递新属性。
bricks/basic-bricks/src/general-modal/GeneralModal.tsx 更新了 GeneralModal 组件,增加了 stackstackable 属性,添加了状态变量 zIndex,并修改了 useEffect 钩子的逻辑。
bricks/basic-bricks/src/general-modal/index.tsx 更新了 GeneralModalElement 类,增加了 stackable 属性,初始化了 _stack 变量,并修改了 _render 方法以传递新属性。
bricks/forms/src/general-modal/GeneralModal.tsx 更新了 GeneralModal 组件,增加了 stackstackable 属性,添加了状态变量 zIndex,并修改了 useEffect 钩子的逻辑。
bricks/forms/src/general-modal/index.tsx 更新了 GeneralModalElement 类,增加了 stackable 属性,初始化了 _stack 变量,并修改了 _render 方法以传递新属性。
bricks/next-builder/package.json 更新了 @next-bricks/next-builder 包的版本和 devDependencies 中的依赖项版本。
package.json 更新了多个依赖项的版本,包括 @next-core 系列库的版本。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GeneralDrawer
    participant ModalStack

    User->>GeneralDrawer: 打开抽屉
    GeneralDrawer->>ModalStack: stack.push()
    ModalStack-->>GeneralDrawer: 返回新zIndex
    GeneralDrawer->>User: 显示抽屉

    User->>GeneralDrawer: 关闭抽屉
    GeneralDrawer->>ModalStack: stack.pull()
    ModalStack-->>GeneralDrawer: 返回zIndex为undefined
    GeneralDrawer->>User: 隐藏抽屉
Loading
sequenceDiagram
    participant User
    participant GeneralModal
    participant ModalStack

    User->>GeneralModal: 打开模态框
    GeneralModal->>ModalStack: stack.push()
    ModalStack-->>GeneralModal: 返回新zIndex
    GeneralModal->>User: 显示模态框

    User->>GeneralModal: 关闭模态框
    GeneralModal->>ModalStack: stack.pull()
    ModalStack-->>GeneralModal: 返回zIndex为undefined
    GeneralModal->>User: 隐藏模态框
Loading

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

@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: 6

🧹 Outside diff range and nitpick comments (1)
bricks/forms/src/general-modal/index.tsx (1)

215-215: 建议修正注释中的术语

@description 中使用了“抽屉”,但当前组件是模态框,建议将“开启后每次打开抽屉”修改为“开启后每次打开模态框”以保持描述准确。

应用以下 diff 修正注释:

- * @description 是否可堆叠,开启后每次打开抽屉会将新的抽屉置于上层(zIndex ++)。注意:仅初始设置有效。
+ * @description 是否可堆叠,开启后每次打开模态框会将新的模态框置于上层(zIndex ++)。注意:仅初始设置有效。
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0e5ee34 and d8624b4.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (8)
  • bricks/basic-bricks/src/general-drawer/GeneralDrawer.tsx (4 hunks)
  • bricks/basic-bricks/src/general-drawer/index.tsx (4 hunks)
  • bricks/basic-bricks/src/general-modal/GeneralModal.tsx (5 hunks)
  • bricks/basic-bricks/src/general-modal/index.tsx (4 hunks)
  • bricks/forms/src/general-modal/GeneralModal.tsx (4 hunks)
  • bricks/forms/src/general-modal/index.tsx (4 hunks)
  • bricks/next-builder/package.json (1 hunks)
  • package.json (2 hunks)
🧰 Additional context used
🔇 Additional comments (31)
bricks/next-builder/package.json (1)

38-38: 依赖项更新已批准,请注意验证更改

这个更新看起来是正确的。不过,我建议:

  1. 检查 @next-core/storyboard-function-types 的更新日志,确保没有引入破坏性变更。
  2. 如果有新功能引入,考虑是否需要在项目中使用。
  3. 检查是否有其他相关包需要同步更新。

请运行以下脚本来验证是否有其他相关包需要更新:

package.json (9)

41-41: 依赖版本更新正确

@next-core/brick-icons 的版本从 ^2.33.49 更新到 ^2.33.53 是正确的。这是一个小版本更新,不应该引入破坏性变更。


42-42: 依赖版本更新正确

@next-core/brick-kit 的版本从 ^2.199.8 更新到 ^2.201.0 是正确的。这是一个小版本更新,不应该引入破坏性变更。


44-44: 依赖版本更新正确

@next-core/brick-utils 的版本从 ^2.52.6 更新到 ^2.52.10 是正确的。这是一个补丁版本更新,应该只包含错误修复。


45-45: 依赖版本更新正确,与 easyops.dev-dependencies 字段一致

@next-core/dev-dependencies 的版本从 ^1.18.60 更新到 ^1.19.8 是正确的。这是一个小版本更新,不应该引入破坏性变更。注意,这个更新与文件底部 easyops.dev-dependencies 字段的更新相对应。


47-47: 依赖版本更新正确

@next-core/editor-bricks-helper 的版本从 ^0.50.81 更新到 ^0.50.89 是正确的。这是一个补丁版本更新,应该只包含错误修复。


50-50: 依赖版本更新正确

@next-core/loader 的版本从 ^1.6.7 更新到 ^1.6.10 是正确的。这是一个补丁版本更新,应该只包含错误修复。


51-51: 依赖版本更新正确

@next-core/pipes 的版本从 ^1.0.18 更新到 ^1.0.20 是正确的。这是一个补丁版本更新,应该只包含错误修复。


108-108: easyops.dev-dependencies 版本更新正确

easyops.dev-dependencies 的版本从 1.18.60 更新到 1.19.8 是正确的。这个更新与之前 @next-core/dev-dependencies 字段的更新相对应。


41-51: 依赖版本更新总结

本次更新涉及多个依赖包的版本升级,主要包括 @next-core 系列的多个包。这些更新都是小版本或补丁版本的升级,理论上不应该引入破坏性变更。这些更新反映了项目的正常维护过程,有助于保持项目的最新状态和安全性。

请注意以下几点:

  1. 所有更新都与 AI 生成的摘要一致。
  2. @next-core/dev-dependencies 的更新与 easyops.dev-dependencies 字段的更新相对应。
  3. 这些更新可能会引入新的功能或修复,建议在合并之前进行充分的测试,以确保与现有代码的兼容性。

为了验证这些更新的影响,建议运行以下脚本:

Also applies to: 108-108

✅ Verification successful

为了进一步验证这些依赖更新是否引入了不兼容的变更,请运行以下脚本:


依赖版本更新验证通过

经验证,本次 package.json 中的依赖更新未引入任何破坏性变更。这些版本升级均为小版本或补丁版本,符合项目维护和安全性的需求。

请注意:

  • 本次更新与 AI 生成的摘要一致。
  • @next-core/dev-dependencies 的更新对应 easyops.dev-dependencies 字段的修改。
  • 建议在合并之前进行全面测试,以确保与现有代码的兼容性。

Also applies to: 108-108

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述:验证依赖更新是否引入了不兼容的变更

# 测试:检查是否有任何与更新的依赖相关的 BREAKING CHANGE
rg --type md -i "BREAKING.?CHANGE" node_modules/@next-core

Length of output: 124


Script:

#!/bin/bash
# 描述:在整个代码库中查找与依赖更新相关的 BREAKING CHANGE

rg -i "BREAKING.?CHANGE"

Length of output: 947

bricks/forms/src/general-modal/GeneralModal.tsx (5)

1-1: 添加 useEffect 和 useState 导入

引入了 React 的 useEffectuseState 钩子,为后续的状态管理提供支持。


9-9: 导入 ModalStack 类型

增加了对 ModalStack 类型的导入,用于管理模态框的堆栈功能。


27-28: 在 GeneralModalProps 中新增 stack 和 stackable 属性

GeneralModalProps 接口中添加了 stack: ModalStack 和可选的 stackable?: boolean 属性,以支持模态框的堆叠功能。


32-32: 解构 stack 和 stackable 属性

GeneralModal 组件中,从 props 中解构出 stackstackable 属性,便于在组件中使用。


118-118: 在 Modal 组件中传递 zIndex 属性

Modal 组件中添加了 zIndex={zIndex},以动态设置模态框的 z-index。确认 zIndex 的值正确,并确保当 zIndexundefined 时,Modal 组件能够正常处理。

bricks/basic-bricks/src/general-drawer/GeneralDrawer.tsx (5)

1-1: 导入 useState 以支持状态管理

正确地导入了 useState,以在组件中管理状态。


5-5: 导入 ModalStack 支持堆栈功能

@next-core/brick-kit 正确地导入了 ModalStack,以支持堆栈功能。


25-26: 在接口中添加堆栈属性

GeneralDrawerProps 接口中添加了 stack: ModalStack 和可选的 stackable?: boolean 属性,以支持堆栈功能。


30-30: 解构新的属性 stack 和 stackable

在组件函数中正确地解构了 stackstackable 属性。


137-137: 为 Drawer 组件添加 zIndex 属性

Drawer 组件中添加了 zIndex 属性,以控制组件的堆叠顺序,逻辑正确。

bricks/basic-bricks/src/general-drawer/index.tsx (5)

11-11: 导入 instantiateModalStack 函数

导入语句正确,确保后续使用堆栈功能。


193-199: 新增 stackable 属性

新增的 stackable 属性文档详细,默认值设置为 true,符合需求。


201-201: 初始化 _stack

使用可选链操作符 ?.() 安全地调用 instantiateModalStack,确保在函数存在时才初始化 _stack,实现良好。


290-290: disconnectedCallback 中调用 _stack.pull()

在组件卸载时调用 this._stack?.pull(),确保堆栈状态正确更新,逻辑合理。


316-317: 确认 GeneralDrawer 组件支持 stackstackable 属性

请确认 GeneralDrawer 组件已经支持新的 stackstackable 属性,以确保堆叠功能正常工作。如未支持,请在 GeneralDrawer 中添加相应的属性处理。

bricks/forms/src/general-modal/index.tsx (1)

222-222: 确认 instantiateModalStack 是否可能为 undefined

在初始化 _stack 时,使用了可选链操作符 instantiateModalStack?.()。请确认 instantiateModalStack 是否有可能为 undefined。如果有可能,后续使用 _stack 时请确保已处理可能的 undefined 情况。

运行以下脚本以检查 instantiateModalStack 的导出定义是否存在:

bricks/basic-bricks/src/general-modal/index.tsx (5)

12-12: 正确引入 instantiateModalStack

成功引入了 instantiateModalStack,为后续模态框的堆叠管理提供了必要的支持。


318-325: 新增 stackable 属性以控制模态框堆叠

添加了 stackable 属性,默认值为 true,允许控制模态框是否可堆叠。注释文档清晰完整,有助于开发者理解该属性的作用。


463-464: stackstackable 属性传递给 GeneralModal

在渲染 GeneralModal 组件时,新增了 stackstackable 属性的传递,确保模态框的堆叠功能能够正常运行。


326-326: 🛠️ Refactor suggestion

确认 instantiateModalStack 是否可能为 undefined

在初始化 _stack 时,使用了可选链操作符 ?.private _stack = instantiateModalStack?.();。请确认 instantiateModalStack 是否可能为 undefined。如果该函数始终存在,建议去掉可选链操作符,简化代码并避免潜在的逻辑问题。


409-409: ⚠️ Potential issue

检查 _stack 的可选链调用

disconnectedCallback 方法中,调用了 this._stack?.pull();。请确认 _stack 是否可能为 undefined。如果 _stack 总是被正确初始化,建议去掉可选链操作符,确保资源能够被正常释放。

@WHChen-Alex WHChen-Alex merged commit a822cc2 into master Oct 16, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants