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

fix: outline tree width not engout when tree is very deep #1092

Conversation

chilingling
Copy link
Member

@chilingling chilingling commented Feb 5, 2025

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

修复大纲树层级过深时,宽度不够,没有自动横向滚动的 bug。

【问题描述】
页面组件层级过深的时候,大纲树插件面板宽度不够,难以操作

image

【问题分析】
tiny-grid 树表的宽度默认即为父级的宽度,当层级过深时,需要手动声明宽度。

【修复方案】
计算最深层级,手动声明宽度。

What is the current behavior?

Issue Number: #1088

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • The tree panel now dynamically adjusts its width based on its depth, ensuring a more responsive layout. This enhancement improves the overall visual consistency and usability when interacting with complex tree structures.
    • Introduced a maximum depth tracking feature for the tree structure.
    • Updated the filtering method to track the current depth during tree traversal.

修复大纲树层级过深时,宽度不够,没有自动横向滚动的 bug
Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

This pull request introduces enhancements to the tree component by implementing a new reactive reference maxDepth and a computed property treeWidth, which adjusts the tree's width based on its maximum depth. The filterSchema function is modified to accept a depth parameter, which tracks the current depth of the tree, and now returns both the modified data and the maximum depth. Additionally, the tiny-grid component's style is bound to treeWidth for dynamic layout adjustments.

Changes

File Path Change Summary
packages/.../Main.vue - Added reactive reference maxDepth and computed property treeWidth.
- Modified filterSchema to accept a depth parameter and return an object with both data and maxDepth.
- Bound tiny-grid style to treeWidth.

Sequence Diagram(s)

sequenceDiagram
  participant C as Main.vue Component
  participant FS as filterSchema Function
  participant TG as tiny-grid Component

  C->>FS: Call filterSchema(data, depth=0)
  FS-->>C: Return { data, maxDepth }
  C->>C: Recompute treeWidth (maxDepth * 16 + 120)
  C->>TG: Bind computed treeWidth to style
Loading

Possibly related PRs

Suggested reviewers

  • yy-wow
  • hexqi

Poem

I'm a hopping rabbit, coding with delight,
Adjusting tree widths in the soft moonlight.
With each node and branch, I find my pace,
Dynamically sizing with elegance and grace.
In lines of code, I bounce and play –
Celebrating changes in a joyful display! 🐇
Hop on and join, let’s code away!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 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 19cd805 and 87d776b.

📒 Files selected for processing (1)
  • packages/plugins/tree/src/Main.vue (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/plugins/tree/src/Main.vue
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check

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.

@github-actions github-actions bot added bug Something isn't working refactor-main refactor/develop branch feature labels Feb 5, 2025
@chilingling chilingling linked an issue Feb 5, 2025 that may be closed by this pull request
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: 1

🔭 Outside diff range comments (1)
packages/plugins/tree/src/Main.vue (1)

336-338: Remove fixed width from tree-box CSS class.

The fixed width of 200px might conflict with the dynamic width calculation. Consider removing or adjusting this constraint.

     .tree-box {
       display: flex;
-      width: 200px;
       justify-content: space-between;
     }
🧹 Nitpick comments (1)
packages/plugins/tree/src/Main.vue (1)

84-86: Extract magic numbers into named constants.

While the comment explains the numbers, it would be more maintainable to extract them into named constants.

+    const INDENT_WIDTH = 16 // Default tiny-grid indentation width
+    const MIN_TREE_WIDTH = 120 // Minimum tree width
     const maxDepth = ref(1)
-    // 树宽度:最大深度 * 16 + 120,其中 16 为每层缩进的宽度(tiny-grid 默认的缩进宽度),120 为树的最小宽度
-    const treeWidth = computed(() => `${maxDepth.value * 16 + 120}px`)
+    const treeWidth = computed(() => `${maxDepth.value * INDENT_WIDTH + MIN_TREE_WIDTH}px`)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a2883f1 and 11dcd90.

📒 Files selected for processing (1)
  • packages/plugins/tree/src/Main.vue (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (2)
packages/plugins/tree/src/Main.vue (2)

21-21: LGTM! Dynamic width binding looks good.

The width is now dynamically calculated based on the tree's depth, which should fix the issue with deep hierarchies.


309-310: LGTM! Proper exposure of the new computed property.

The treeWidth computed property is correctly exposed to the template.

packages/plugins/tree/src/Main.vue Outdated Show resolved Hide resolved

const filterSchema = (data) => {
const translateChild = (data) => {
maxDepth.value = 0
Copy link
Collaborator

Choose a reason for hiding this comment

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

代码互相耦合比较严重, 并且在中间过程中反复修改maxDepth。连锁可能造成一直修改treewiidth
建议用闭包的形式 计算后同时返回 ,内部的最大值和过滤后的数据结果, 计算完毕后再复制给外部的maxDepth。

@chilingling
Copy link
Member Author

在 PR:#1050 一并修复,该PR关闭

@chilingling chilingling closed this Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 [Bug]: 大纲树组件层次多时无法操作
2 participants