Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 1, 2025

update documentation for callback extensions

Summary of the changes (Less than 80 chars)

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

Description

fixes #5011

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

Update the MindMap component to support custom callbacks and add sample code demonstrating their usage.

New Features:

  • Add support for custom callbacks in the MindMap component.

Enhancements:

  • Refactor sample data and simplify the structure of the MindMaps component.

Documentation:

  • Document the new callback extensions for the MindMap component.

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jan 1, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 1, 2025

Reviewer's Guide by Sourcery

This PR updates the documentation for callback extensions in the MindMap component. It also simplifies sample data and adds new features such as scaling and custom callbacks.

Sequence diagram for MindMap custom callback interaction

sequenceDiagram
    participant C as Client
    participant M as MindMap Component
    participant J as JavaScript
    C->>M: Click custom button
    M->>J: Execute('clickCustom', 'args1')
    J->>J: window.BootstrapBlazor.MindMap.callbacks.clickCustom(args)
    Note over J: Log args to console
Loading

File-Level Changes

Change Details Files
Updated sample data and added rich text support
  • Simplified the sample JSON data and added rich text support to the root and second-level nodes
  • Added isActive, uid, generalization, template, config, transform, view and state properties to the sample JSON data
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor.Data.cs
Added layout and theme selection
  • Added layout and theme enum variables and select components to the Razor markup
  • Removed the MindMapOptions parameter from the MindMap component and replaced it with Layout and Theme parameters
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor.cs
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor
Added scaling functionality
  • Added a scaling method and buttons to control the scale of the mind map
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor.cs
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor
Added custom callback extensions
  • Added a custom callback method and a button to trigger it
  • Added a JavaScript file to define the custom callback function
  • Added documentation for custom callback extensions
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor.cs
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor
src/BootstrapBlazor.Server/Components/Samples/MindMaps.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5011 Add sample code for {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.
  • 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

@bb-auto bb-auto bot added this to the v9.0.0 milestone Jan 1, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 1, 2025 07:05
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:

  • Please add documentation explaining how to use the new JavaScript callback functionality, including examples of common use cases.
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.

@codecov
Copy link

codecov bot commented Jan 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (32cba13) to head (34f0e52).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5012   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27938     27938           
  Branches      3998      3998           
=========================================
  Hits         27938     27938           

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

@ArgoZhang ArgoZhang merged commit c9a3d03 into main Jan 1, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-mind branch January 1, 2025 07:06
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.

doc(MindMap): update documentation for callback extensions

2 participants