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: the function of adding and deleting nodes in the outline tree, support undo. #1136

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

1degrees
Copy link

@1degrees 1degrees commented Feb 21, 2025

the function of adding and deleting nodes in the outline tree, support undo.
(大纲树增加删除功能,支持撤销)

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?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Introduced the ability to delete nodes directly from the tree view with an intuitive delete action.
    • Enhanced the node visibility toggle by consolidating icon states for a smoother user experience.
  • Style

    • Updated hover styles ensure clear visibility and interaction with the new deletion icon.

Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Walkthrough

The changes add a delete node functionality to the tree component. A consolidated SVG icon now dynamically toggles between visibility states, and a new delete icon invokes the delNode method on mouse up. The delNode method calls the canvas API for deletion, clears current selections, and records the action via the history API. Additionally, relevant style and import updates have been applied.

Changes

File Change Summary
packages/.../Main.vue Consolidated visibility icons into one <svg-icon> with dynamic naming. Added a new delete icon triggering delNode(row.rawData) on mouseup. Introduced the delNode method using useCanvas for deletion, calling clearSelect(), and utilizing useHistory().addHistory(). Style updates for icon display and updated import for useHistory.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant T as Tree Component
    participant C as useCanvas API
    participant H as useHistory API
    U->>T: Clicks delete icon
    T->>T: Execute delNode(data)
    T->>C: Call deletion with node ID
    T->>T: Call clearSelect()
    T->>H: Record deletion in history
Loading

Possibly related PRs

Suggested labels

enhancement, ospp-2024

Suggested reviewers

  • hexqi
  • chilingling

Poem

I'm a bunny with a code tale so sweet,
Hoping to make our tree neat.
Deleting nodes with a flick and a hop,
Clear selections without a stop.
History logged, our work's complete,
My paws nudge changes smooth and fleet.
Happy updates from my rabbit beat!


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 the enhancement New feature or request label Feb 21, 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: 1

🧹 Nitpick comments (2)
packages/plugins/tree/src/Main.vue (2)

30-31: Add confirmation dialog before node deletion.

To prevent accidental deletions, consider adding a confirmation dialog before executing the delete operation.

-              <svg-icon name="delete" @mouseup="delNode(row.rawData)"></svg-icon>
+              <svg-icon name="delete" @mouseup="confirmDelete(row.rawData)"></svg-icon>

Add the confirmation method:

const confirmDelete = (data) => {
  // Use your UI framework's confirmation dialog
  if (confirm('Are you sure you want to delete this node?')) {
    delNode(data)
  }
}

259-270: Add visual distinction for destructive action.

Consider adding a distinct hover color for the delete icon to indicate its destructive nature.

   svg.icon-eye,
   svg.icon-delete,
   svg.icon-eye-invisible {
     visibility: hidden;
   }
   .tree-row:hover {
     svg.icon-eye,
-    svg.icon-delete,
     svg.icon-eye-invisible {
       visibility: unset;
     }
+    svg.icon-delete {
+      visibility: unset;
+      &:hover {
+        color: var(--te-color-error);
+      }
+    }
   }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8d51ad4 and 8adc9a1.

📒 Files selected for processing (1)
  • packages/plugins/tree/src/Main.vue (5 hunks)
🔇 Additional comments (1)
packages/plugins/tree/src/Main.vue (1)

30-31: LGTM! Well-structured implementation of node deletion with undo support.

The changes effectively implement the node deletion feature with proper integration of history management for undo support. The code maintains consistency with the existing patterns and provides a good user experience.

Also applies to: 141-149, 259-270

Comment on lines +141 to +149
const delNode = (data) => {
const { clearSelect } = useCanvas().canvasApi.value
useCanvas().operateNode({
type: 'delete',
id: data.id
})
clearSelect()
useHistory().addHistory()
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add error handling to delNode method.

The deletion operation should handle potential failures gracefully.

     const delNode = (data) => {
+      try {
         const { clearSelect } = useCanvas().canvasApi.value
         useCanvas().operateNode({
           type: 'delete',
           id: data.id
         })
         clearSelect()
         useHistory().addHistory()
+      } catch (error) {
+        console.error('Failed to delete node:', error)
+        // Use your UI framework's error notification
+        useMessage().error('Failed to delete node')
+      }
     }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const delNode = (data) => {
const { clearSelect } = useCanvas().canvasApi.value
useCanvas().operateNode({
type: 'delete',
id: data.id
})
clearSelect()
useHistory().addHistory()
}
const delNode = (data) => {
try {
const { clearSelect } = useCanvas().canvasApi.value
useCanvas().operateNode({
type: 'delete',
id: data.id
})
clearSelect()
useHistory().addHistory()
} catch (error) {
console.error('Failed to delete node:', error)
// Use your UI framework's error notification
useMessage().error('Failed to delete node')
}
}

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

Successfully merging this pull request may close these issues.

1 participant