Skip to content

fix: panel drag canvas adaptive#1268

Merged
hexqi merged 2 commits intoopentiny:release/v2.4.0from
SonyLeo:fix/canvas-adaptive
Apr 2, 2025
Merged

fix: panel drag canvas adaptive#1268
hexqi merged 2 commits intoopentiny:release/v2.4.0from
SonyLeo:fix/canvas-adaptive

Conversation

@SonyLeo
Copy link
Contributor

@SonyLeo SonyLeo commented Mar 31, 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

What is the current behavior?

大纲树插件面板拖动后,画布区域未进行自适应缩放

Issue Number: N/A

What is the new behavior?

以下插件面板拖动后,画布区域自适应缩放

  1. 大纲树
    大纲树 - 拖拽自适应

  2. 页面 JS
    页面 JS - 拖拽自适应

  3. 页面 Schema
    页面 Schema - 拖拽自适应

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Enhanced the interactive panel resizing behavior, providing dynamic scaling adjustments in response to width changes.
    • Improved responsiveness by ensuring that panels update appropriately when they can be resized.
    • Added a resize event listener for better handling of window size changes.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 31, 2025

Walkthrough

The changes introduce a new reactive reference, draggablePanel, initialized to null in the CanvasResize.vue component. A watcher is added to observe the width of the plugin, invoking the setScale function whenever the width changes, with the flush option set to 'post'. Additionally, the existing watcher checks if the panel is resizable using useLayout().isPanelWidthResizable(value), updating draggablePanel if true. Lifecycle hooks for onMounted and onUnmounted manage a resize event listener that calls a new handleResize function, enhancing the component's responsiveness.

Changes

File Summary
packages/.../CanvasResize.vue Added draggablePanel reactive reference. Introduced a new watcher for width changes that calls setScale (flush: 'post') and enhanced an existing watcher to check and update panel resizability via useLayout().isPanelWidthResizable. Added lifecycle hooks for managing resize event listeners.

Suggested labels

refactor-main

Suggested reviewers

  • hexqi
  • chilingling

Poem

In the realm of code where pixels glide,
I hopped along with watchers by my side.
A reactive twist, a scale set just right,
Panels resizing in the soft moonlight.
Hooray for changes made in a clever spree,
Signed, your coding bunny full of glee! 🐇


📜 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 1762787 and 8cd1dfc.

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

13-13: Appropriate import additions for lifecycle hooks

The addition of onMounted and onUnmounted imports is necessary for implementing window resize event handling.


93-94: Well-structured implementation of panel width tracking

The draggablePanel ref and watcher effectively track panels that can be dragged and trigger canvas scaling when their width changes. Using flush: 'post' ensures the DOM is updated before measurements are taken.


104-108: Good panel resizability detection logic

This code correctly identifies resizable panels and updates the draggablePanel reference, which enables the canvas to adapt when these specific panels are resized.


140-150: Window resize handling implementation addresses previous feedback

The addition of resize event handling ensures the canvas adapts when the browser window is resized, which directly addresses the feedback from reviewer "hexqi" about adding window resize adaptation.


🪧 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 plan to trigger planning for file edits and PR creation.
  • @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 bug Something isn't working label Mar 31, 2025
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 (1)
packages/canvas/container/src/components/CanvasResize.vue (1)

140-145: Consider updating the returned object from setup()

While the component functions correctly with the current implementation, the draggablePanel reference is used internally but not included in the returned object from setup(). This is technically correct since it's only used within the component, but explicitly documenting it as a private variable (with a leading underscore) might improve code readability.

  return {
    onMouseDown,
    onMouseMove,
    sizeStyle,
    resizeDom
+   // _draggablePanel is used internally for tracking width-resizable panels
  }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 24a3bcc and 1762787.

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

93-94: Good addition of a reactive panel tracking mechanism.

The new draggablePanel reference and associated watcher effectively address the issue of canvas scaling when certain panels are dragged. The watcher monitors width changes of the draggable panel and triggers the setScale function with flush: 'post' to ensure DOM updates are complete before scaling calculations.


104-108: Well-implemented panel resizability check.

This check correctly identifies if a panel is width-resizable using isPanelWidthResizable() and updates the draggablePanel reference accordingly. This implementation addresses the PR's objective to fix adaptive scaling when dragging specific panel plugins (outline tree, page JS, and page schema).

The solution is elegantly generic, handling any panel that meets the resizability criteria rather than hardcoding specific panel types.

@hexqi hexqi merged commit f912d39 into opentiny:release/v2.4.0 Apr 2, 2025
2 checks passed
@SonyLeo SonyLeo deleted the fix/canvas-adaptive branch August 24, 2025 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants