Skip to content

fix: auto check parent after node selected #5794

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

Merged
merged 1 commit into from
Mar 27, 2025

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Mar 27, 2025

Description

增加autoCheckParent属性,控制在非checkStrictly多选模式下,选择子项时,自动勾选祖先节点。

fix: #5703

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • New Features

    • Enhanced tree component functionality with improved parent auto-selection, default expansion control, and smoother transition effects.
    • Expanded configuration options for tree behavior, offering greater flexibility in how data is presented.
  • Style

    • Updated loading indicator styling in form views to use a full-width layout for better visual consistency.

Copy link

changeset-bot bot commented Mar 27, 2025

⚠️ No Changeset found

Latest commit: 448c63d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Mar 27, 2025

Walkthrough

This pull request updates the tree component to support automatic parent-child selection propagation. It introduces new properties and default values for managing node expansion and transition effects. The internal data types and function signatures are updated to handle new parameters related to parent tracking. Additionally, a new TreeProps interface is added for clearer property definitions, and a minor styling enhancement is applied to a loading component in a system role form.

Changes

File Change Summary
packages/@core/ui-kit/.../tree/tree.vue Added new props autoCheckParent (default true) and defaultExpandedLevel (default 0); modified transition default to true; updated InnerFlattenItem with a new generic parameter P and a parents property; adjusted the flatten and onSelect function signatures to handle an extra parameter; integrated TransitionGroup for animated rendering; added scoped styles for transitions.
packages/@core/ui-kit/.../tree/types.ts Introduced new TreeProps interface defining tree-related properties including selection handling, expansion options, and visibility controls.
playground/.../role/modules/form.vue Enhanced the <Spin> component by adding the wrapper-class-name="w-full" attribute to enforce full-width styling during loading states.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant C as Checkbox (handleSelect)
    participant T as Tree Component (onSelect)
    participant M as Model (modelValue)
    
    U->>C: Click on checkbox
    C->>T: Invoke handleSelect()
    T->>T: Evaluate autoCheckParent flag
    alt autoCheckParent enabled
        T->>M: Update modelValue to include parent nodes
    else
        T->>M: Update modelValue with only child node
    end
    T->>C: Render updated state via TransitionGroup
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure tree component updates parent selection state (#5703)

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • anncwb
  • vince292007

Poem

I'm a bunny in the code forest, hopping free,
Cheering new props and flows with glee.
Parents now join the selection dance,
As tree nodes update at every chance.
With every bug fixed and style refined,
I celebrate in code, joyfully aligned! 🐰

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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.

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 (3)
packages/@core/ui-kit/shadcn-ui/src/ui/tree/tree.vue (3)

158-186: Implemented autoCheckParent functionality.

The onSelect function now includes logic to automatically select parent nodes when a child is selected, but it should also handle the reverse case - when a parent is deselected, the children should be deselected too.

Consider enhancing the logic to handle parent deselection by adding:

 function onSelect(item: FlattenedItem<Recordable<any>>, isSelected: boolean) {
   if (
     !props.checkStrictly &&
     props.multiple &&
     props.autoCheckParent &&
     isSelected
   ) {
     flattenData.value
       .find((i) => {
         return (
           get(i.value, props.valueField) === get(item.value, props.valueField)
         );
       })
       ?.parents?.forEach((p) => {
         if (Array.isArray(modelValue.value) && !modelValue.value.includes(p)) {
           modelValue.value.push(p);
         }
       });
+  } else if (
+    !props.checkStrictly &&
+    props.multiple &&
+    props.autoCheckParent &&
+    !isSelected
+  ) {
+    // If parent is deselected, deselect all its children
+    const itemValue = get(item.value, props.valueField);
+    // Find all items that have this item as a parent
+    const childrenToDeselect = flattenData.value
+      .filter(i => i.parents.includes(itemValue))
+      .map(i => get(i.value, props.valueField));
+    
+    // Remove children from selection
+    if (Array.isArray(modelValue.value)) {
+      modelValue.value = modelValue.value.filter(
+        val => !childrenToDeselect.includes(val)
+      );
+    }
   } else {
     if (Array.isArray(modelValue.value)) {
       const index = modelValue.value.indexOf(get(item.value, props.valueField));
       if (index !== -1) {
         modelValue.value.splice(index, 1);
       }
     }
   }
   updateTreeValue();
   emits('select', item);
 }

274-275: Remove commented-out code.

There is commented-out code for displaying icons. Either implement it or remove it completely to avoid confusion.

 <div v-else class="h-4 w-4">
-  <!-- <IconifyIcon v-if="item.value.icon" :icon="item.value.icon" /> -->
 </div>

282-284: Cleanup commented-out code in event handlers.

There are several commented-out lines in the event handlers that should be removed to improve code clarity.

Clean up the commented code in both handlers:

 @click="
   () => {
     handleSelect();
-    // onSelect(item, !isSelected);
   }
 "
 @click="
   (_event) => {
-    // $event.stopPropagation();
-    // $event.preventDefault();
     handleSelect();
-    // onSelect(item, !isSelected);
   }
 "

Also applies to: 290-295

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0b65036 and 448c63d.

📒 Files selected for processing (3)
  • packages/@core/ui-kit/shadcn-ui/src/ui/tree/tree.vue (5 hunks)
  • packages/@core/ui-kit/shadcn-ui/src/ui/tree/types.ts (1 hunks)
  • playground/src/views/system/role/modules/form.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Lint (windows-latest)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (7)
playground/src/views/system/role/modules/form.vue (1)

101-101: Added wrapper class to improve layout.

The addition of wrapper-class-name="w-full" ensures the Spin component uses the full available width, which improves the layout and alignment of the tree component within the form.

packages/@core/ui-kit/shadcn-ui/src/ui/tree/types.ts (1)

6-42: New TreeProps interface provides well-structured type definitions.

The new interface enhances code maintainability by providing clear type definitions and documentation for all tree component properties. The autoCheckParent property (line 10) directly implements the functionality mentioned in the PR objectives for automatic parent selection.

packages/@core/ui-kit/shadcn-ui/src/ui/tree/tree.vue (5)

7-7: Added TreeProps import and enabled autoCheckParent by default.

Good implementation of the autoCheckParent property with a default value of true, which matches the PR objectives for automatically selecting parent nodes when a child is selected.

Also applies to: 21-21


25-26: Updated default behavior for tree expansion and transitions.

The addition of defaultExpandedLevel: 0 and changing transition default to true improves the user experience by providing better control over initial tree state and enabling smooth animations by default.

Also applies to: 33-34


44-48: Enhanced data structure to track parent-child relationships.

The updated InnerFlattenItem interface and flatten function now track parent nodes, which is essential for implementing the autoCheckParent functionality. This change maintains tree hierarchy information during the flattening process.

Also applies to: 51-56, 63-73


222-226: Added TransitionGroup for smooth animations.

Using TransitionGroup for animating tree node changes is a good improvement for user experience. The conditional transition name based on the transition prop provides flexibility.


314-348: Added transition styles for smooth animations.

The added styles provide smooth animation effects for tree node transitions. The CSS follows best practices with clear comments explaining each part of the transition effect.

@mynetfan mynetfan merged commit 870cd86 into vbenjs:main Mar 27, 2025
14 checks passed
@mynetfan mynetfan deleted the fix/tree-auto-parent branch March 27, 2025 06:22
@github-actions github-actions bot locked and limited conversation to collaborators Apr 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Tree组件层级联动问题
1 participant