Skip to content

feat(TreeView): add ShowToolbar parameter #5628

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 36 commits into from
Mar 14, 2025
Merged

feat(TreeView): add ShowToolbar parameter #5628

merged 36 commits into from
Mar 14, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 14, 2025

Link issues

fixes #5627

Summary By Copilot

This pull request introduces several new features and improvements to the TreeView component in the BootstrapBlazor project. The changes include adding a toolbar to the TreeView, updating localization files, and refactoring the rendering logic for tree nodes.

New Features:

  • Added a toolbar to the TreeView component, which can be enabled by setting the ShowToolbar parameter to true. The toolbar functionality can be customized, and data updates can be handled using the OnUpdateCallbackAsync callback method. (src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor [1] [2] src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor.cs [3] [4]

Localization Updates:

  • Updated the English (en-US.json) and Chinese (zh-CN.json) localization files to include new entries for the toolbar feature in the TreeView component. (src/BootstrapBlazor.Server/Locales/en-US.json [1] src/BootstrapBlazor.Server/Locales/zh-CN.json [2]

Code Refactoring:

  • Refactored the rendering logic for tree nodes by replacing the RenderTreeRow method with the RenderRow method, which uses the new TreeViewRow component. This change simplifies the code and improves readability. (src/BootstrapBlazor/Components/TreeView/TreeView.razor [1] [2]
  • Removed obsolete and redundant code from the TreeView component's code-behind file, and updated the documentation comments to be more consistent and clear. (src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs [1] [2] [3] [4]

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Adds a toolbar to the TreeView component, allowing for customization and data updates via the OnUpdateCallbackAsync callback method.

New Features:

  • Adds a toolbar to the TreeView component, which can be enabled by setting the ShowToolbar parameter to true. The toolbar functionality can be customized, and data updates can be handled using the OnUpdateCallbackAsync callback method.
  • Adds ToolbarTemplate parameter to customize the toolbar content.
  • Adds ToolbarEditTitle and ToolbarEditLabelText parameters to customize the edit toolbar button's popup window title and label text respectively.

@bb-auto bb-auto bot added the enhancement New feature or request label Mar 14, 2025
Copy link
Contributor

sourcery-ai bot commented Mar 14, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new ShowToolbar parameter to the TreeView component, allowing users to display a toolbar for each tree node. It also refactors the rendering logic of the TreeView component to improve readability and maintainability, and updates localization files to include new entries for the toolbar feature.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new ShowToolbar parameter to the TreeView component, allowing users to display a toolbar for each tree node.
  • Added ShowToolbar parameter to control toolbar visibility.
  • Added ShowToolbarCallback parameter to conditionally display the toolbar.
  • Added ToolbarTemplate parameter to customize the toolbar content.
  • Added ToolbarEditTitle and ToolbarEditLabelText parameters for localization.
  • Added OnUpdateCallbackAsync parameter to handle data updates.
  • Created a new TreeViewRow component to encapsulate the rendering logic for each row.
  • Created a new TreeViewToolbarEditButton component to handle the edit button in the toolbar.
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
src/BootstrapBlazor/Components/TreeView/TreeView.razor
src/BootstrapBlazor/Components/TreeView/TreeView.razor.scss
src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor
src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor.cs
src/BootstrapBlazor/Components/TreeView/TreeViewItem.cs
src/BootstrapBlazor/Extensions/TreeViewExtensions.cs
src/BootstrapBlazor/Components/TreeView/TreeViewRow.razor.cs
src/BootstrapBlazor/Components/TreeView/TreeViewToolbarEditButton.razor.cs
src/BootstrapBlazor/Components/TreeView/TreeViewRow.razor
src/BootstrapBlazor/Components/TreeView/TreeViewToolbarEditButton.razor
Refactored the rendering logic of the TreeView component to improve readability and maintainability.
  • Replaced the RenderTreeRow method with the RenderRow method.
  • Introduced the TreeViewRow component to handle the rendering of individual tree nodes.
  • Moved node rendering logic to the TreeViewRow component.
  • Removed obsolete IsReset property.
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
src/BootstrapBlazor/Components/TreeView/TreeView.razor
Updated localization files to include new entries for the toolbar feature in the TreeView component.
  • Added new localization keys for the toolbar feature.
  • Updated English localization file.
  • Updated Chinese localization file.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
src/BootstrapBlazor/Locales/en.json
src/BootstrapBlazor/Locales/zh.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5627 Implement a toolbar function for the TreeView component.

Possibly linked issues


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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 14, 2025
Copy link
Contributor

@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 @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a sample demonstrating the ShowToolbarCallback functionality to showcase its dynamic behavior.
  • The new TreeViewRow component introduces a lot of new parameters; consider grouping related parameters together for better readability.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟡 Complexity: 1 issue found
  • 🟢 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 Mar 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ce8eecd) to head (1368209).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##              main     #5628    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          650       653     +3     
  Lines        29626     29344   -282     
  Branches      4166      4176    +10     
==========================================
- Hits         29626     29344   -282     

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 79fce04 into main Mar 14, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-tree branch March 14, 2025 09:16
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.

feat(TreeView): support toolbar function
1 participant