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

docs(ContextMenu): add TreeView sample code #5118

Merged
merged 5 commits into from
Jan 16, 2025
Merged

Conversation

kimdiego2098
Copy link
Collaborator

@kimdiego2098 kimdiego2098 commented Jan 15, 2025

add TreeView sample code

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5123

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add conditional rendering to the context menu based on the selected item.

New Features:

  • Added a new "CopySub" context menu item.

Documentation:

  • Updated the context menu documentation.

Copy link

sourcery-ai bot commented Jan 15, 2025

Reviewer's Guide by Sourcery

This pull request adds documentation for the right-click context menu component. It also modifies the context menu logic to conditionally render menu items based on the selected tree node.

Sequence diagram for context menu interaction flow

sequenceDiagram
    actor User
    participant TreeView
    participant ContextMenu
    participant CallbackLogger

    User->>TreeView: Right clicks on tree node
    TreeView->>ContextMenu: Triggers OnBeforeShowCallback
    ContextMenu->>CallbackLogger: Logs selected node text
    Note over ContextMenu: Stores selected model
    alt SelectModel.Id == '1020'
        ContextMenu-->>User: Show Copy and Paste options
    else
        ContextMenu-->>User: Show CopySub option
    end
Loading

Class diagram for ContextMenu component structure

classDiagram
    class ContextMenuZone {
    }
    class ContextMenu {
        +OnBeforeShowCallback: Task
    }
    class ContextMenuItem {
        +Icon: string
        +Text: string
        +OnClick: Task
    }
    class TreeFoo {
        +Id: string
        +Text: string
    }
    ContextMenuZone --> ContextMenu
    ContextMenu --> ContextMenuItem
    note for ContextMenu "Modified to conditionally render
menuitems based on TreeFoo selection"
Loading

File-Level Changes

Change Details Files
Added conditional rendering of context menu items
  • Context menu items "Copy" and "Paste" are now only shown when the selected tree node has ID "1020"
  • A new context menu item "CopySub" is shown for other tree nodes
src/BootstrapBlazor.Server/Components/Samples/ContextMenus.razor
Added OnBeforeShowCallback logic
  • Added a SelectModel property to store the currently selected tree node
  • The OnBeforeShowCallback method now updates the SelectModel property based on the selected tree node
src/BootstrapBlazor.Server/Components/Samples/ContextMenus.razor.cs
Added new copy handler
  • Added an OnCopySub method to handle clicks on the new "CopySub" context menu item
src/BootstrapBlazor.Server/Components/Samples/ContextMenus.razor.cs
Updated localization files
  • Updated the localization files to include the new "CopySub" text
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

bb-auto bot commented Jan 15, 2025

Thanks for your PR, @kimdiego2098. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@bb-auto bb-auto bot requested a review from ArgoZhang January 15, 2025 13:24
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 15, 2025
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @kimdiego2098 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider making the menu item visibility logic more flexible instead of hardcoding ID '1020'. This could be done through configuration or by checking node properties/types.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d17ea0d) to head (134c695).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5118   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28174     28174           
  Branches      4041      4041           
=========================================
  Hits         28174     28174           

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

ArgoZhang
ArgoZhang previously approved these changes Jan 15, 2025
@ArgoZhang ArgoZhang dismissed stale reviews from sourcery-ai[bot] and themself via 17797a9 January 16, 2025 03:44
@ArgoZhang ArgoZhang changed the title docs(ContextMenus): 补充右键菜单文档 docs(ContextMenu): add TreeView sample code Jan 16, 2025
@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jan 16, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 16, 2025
Co-Authored-By: Diego2098 <[email protected]>

# Conflicts:
#	src/BootstrapBlazor/BootstrapBlazor.csproj
@ArgoZhang ArgoZhang merged commit 3d46f4e into main Jan 16, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the docs-contextMenus branch January 16, 2025 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs(ContextMenu): 补充右键菜单文档
2 participants