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: tabbar supports React.ReactNode for description #4386

Merged
merged 1 commit into from
Feb 19, 2025
Merged

Conversation

wangxiaojuan
Copy link
Contributor

@wangxiaojuan wangxiaojuan commented Feb 19, 2025

Types

  • 🎉 New Features
  • 🐛 Bug Fixes
  • 📚 Documentation Changes
  • 💄 Code Style Changes
  • 💄 Style Changes
  • 🪚 Refactors
  • 🚀 Performance Improvements
  • 🏗️ Build System
  • ⏱ Tests
  • 🧹 Chores
  • Other Changes

Background or solution

image

#4322

Changelog

feat: tabbar的描述支持传入React.ReactNode

Summary by CodeRabbit

  • 新增功能
    • 多个界面组件的描述属性现支持文本以及动态组件,提供更灵活丰富的内容呈现体验。
    • 更新后的展示逻辑确保在适配不同描述类型时,内容能够直观、有效地展示。

@opensumi opensumi bot added the 🎨 feature feature required label Feb 19, 2025
@wangxiaojuan wangxiaojuan requested a review from Ricbet February 19, 2025 03:43
Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

该 PR 更新了多个模块中关于 description 属性的类型定义,将原本只允许字符串传入的属性扩展为同时支持字符串和 React 组件类型。此外,相关的接口、方法和组件渲染逻辑也作出相应调整,以便根据传入描述的实际类型进行处理。这些修改涉及核心布局、手风琴组件以及选项卡处理器等,但并未引入新的业务逻辑或改变现有的控制流程。

Changes

文件 变更概述
packages/core-browser/.../layout.interface.ts 更新 View 接口中 description 属性类型,从 string 改为 `string
packages/main-layout/.../accordion.service.ts 更新 AccordionViewChangeEvent 接口和 AccordionService.updateViewDesciption 方法中 description/desc 参数类型,从 string 改为支持 React 组件类型
packages/main-layout/.../accordion/section.view.tsx 更新 CollapsePanelProps 接口中 description 类型,从 string 改为 `string
packages/main-layout/.../tabbar-handler.ts 更新 TabBarHandler.updateViewDescription 方法中 desciption 参数类型,从 string 改为 `string

Sequence Diagram(s)

sequenceDiagram
    participant AS as AccordionSection
    participant T as transformLabelWithCodicon
    participant RC as ReactComponent

    AS->>AS: 接收 metadata.description
    alt 描述为字符串
        AS->>T: 调用 transformLabelWithCodicon 转换描述
        T-->>AS: 返回转换后的描述内容
        AS->>AS: 渲染转换后的描述内容
    else 描述为 React 组件
        AS->>RC: 直接渲染 React 组件
    end
Loading

Possibly related PRs

  • fix: layout state restore not work #3941:该 PR 与本次 PR 都涉及将 description 属性的类型由 string 扩展为支持 string | React.ComponentType<any>,在代码级别上存在较强的关联性。

Suggested reviewers

  • Ricbet

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

yarn install v1.22.22
[1/4] Resolving packages...
warning [email protected]: This version is no longer supported. Please see https://eslint.org/version-support for other options.
warning eslint > @humanwhocodes/[email protected]: Use @eslint/config-array instead
warning eslint > @humanwhocodes/config-array > @humanwhocodes/[email protected]: Use @eslint/object-schema instead
warning eslint > file-entry-cache > flat-cache > [email protected]: Rimraf versions prior to v4 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > [email protected]: Glob versions prior to v9 are no longer supported
warning eslint > file-entry-cache > flat-cache > rimraf > glob > [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
warning eslint-import-resolver-typescript > [email protected]: Glob versions prior to v9 are no longer supported
error Couldn't find any versions for "@opensumi/ide-dev-tool" that matches "workspace:*"
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

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

@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)
packages/main-layout/src/browser/tabbar-handler.ts (1)

159-159: 修正参数名称中的拼写错误

参数名 desciption 存在拼写错误,应该为 description

建议修改为:

-  updateViewDescription(viewId: string, desciption: string | React.ComponentType<any>) {
+  updateViewDescription(viewId: string, description: string | React.ComponentType<any>) {
packages/main-layout/src/browser/accordion/accordion.service.ts (1)

60-60: 修正方法名称中的拼写错误

  1. 接口中的类型更新正确
  2. 方法名 updateViewDesciption 存在拼写错误,应该为 updateViewDescription

建议修改为:

-  updateViewDesciption(viewId: string, desc: string | React.ComponentType<any>) {
+  updateViewDescription(viewId: string, desc: string | React.ComponentType<any>) {

同时需要更新所有调用此方法的地方。

Also applies to: 201-201

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ff995f5 and e491fa4.

📒 Files selected for processing (4)
  • packages/core-browser/src/layout/layout.interface.ts (1 hunks)
  • packages/main-layout/src/browser/accordion/accordion.service.ts (2 hunks)
  • packages/main-layout/src/browser/accordion/section.view.tsx (2 hunks)
  • packages/main-layout/src/browser/tabbar-handler.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: unittest (ubuntu-latest, 18.x, jsdom)
  • GitHub Check: unittest (ubuntu-latest, 18.x, node)
  • GitHub Check: build (ubuntu-latest, 20.x)
  • GitHub Check: unittest (macos-latest, 18.x, jsdom)
  • GitHub Check: build-windows
  • GitHub Check: ubuntu-latest, Node.js 20.x
  • GitHub Check: unittest (macos-latest, 18.x, node)
  • GitHub Check: build (macos-latest, 20.x)
🔇 Additional comments (2)
packages/core-browser/src/layout/layout.interface.ts (1)

35-35: 类型定义更新正确!

description 的类型从 string 扩展为 string | React.ComponentType<any> 是一个合理的改动,这样可以支持更丰富的描述内容展示。

packages/main-layout/src/browser/accordion/section.view.tsx (1)

29-29: 实现正确且完整!

  • 接口定义中正确更新了 description 的类型
  • 渲染逻辑正确处理了字符串和组件两种类型的情况:
    • 字符串类型使用 transformLabelWithCodicon 处理
    • 组件类型直接渲染组件

代码实现完整且符合预期。

Also applies to: 188-192

@wangxiaojuan wangxiaojuan requested a review from hacke2 February 19, 2025 03:47
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 53.83%. Comparing base (ff995f5) to head (e491fa4).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...-layout/src/browser/accordion/accordion.service.ts 0.00% 1 Missing ⚠️
packages/main-layout/src/browser/tabbar-handler.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4386   +/-   ##
=======================================
  Coverage   53.83%   53.83%           
=======================================
  Files        1650     1650           
  Lines      101511   101511           
  Branches    21968    21960    -8     
=======================================
  Hits        54646    54646           
  Misses      38967    38967           
  Partials     7898     7898           
Flag Coverage Δ
jsdom 49.32% <0.00%> (ø)
node 12.18% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@hacke2 hacke2 left a comment

Choose a reason for hiding this comment

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

LGTM

@hacke2 hacke2 merged commit 840ef8c into main Feb 19, 2025
15 checks passed
@hacke2 hacke2 deleted the feat/tabbar_desc branch February 19, 2025 06:02
@wangxiaojuan
Copy link
Contributor Author

/next

@opensumi
Copy link
Contributor

opensumi bot commented Feb 19, 2025

🎉 PR Next publish successful!

3.7.2-next-1739945875.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎨 feature feature required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants