Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 26, 2024

update skeleton documentation

Summary of the changes (Less than 80 chars)

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

Description

fixes #4959

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 TreeView sample to use the new ignore attribute for skeleton loading.

New Features:

  • Added support for the ignore attribute in the TreeView component to control skeleton loading behavior.

Documentation:

  • Updated documentation for the TreeView component to reflect the changes in the skeleton loading feature.

ArgoZhang and others added 4 commits December 26, 2024 19:38
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 26, 2024

Reviewer's Guide by Sourcery

This PR updates the documentation for the TreeView component to include information about the skeleton functionality. It also modifies the sample code to demonstrate the skeleton feature.

Sequence diagram for TreeView skeleton loading process

sequenceDiagram
    participant User
    participant Button
    participant TreeView
    participant Server

    User->>Button: Click load button
    Button->>TreeView: Trigger async load
    activate TreeView
    Note over TreeView: Show skeleton loading state
    TreeView->>Server: OnLoadAsyncItems()
    Server-->>TreeView: Return async items
    TreeView->>TreeView: Update with real data
    deactivate TreeView
Loading

File-Level Changes

Change Details Files
Updated sample code to demonstrate skeleton functionality.
  • Wrapped the button element within a
    tag. This change ensures that the button is excluded from automated UI testing, preventing potential interference with the skeleton demonstration.
src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor
Updated locale files.
  • Modified locale files to include updated translations for the new skeleton documentation. The specific changes within the locale files are not detailed here as they are assumed to be minor updates related to the skeleton feature.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Updated project file.
  • Updated the project file to reflect the changes made to the sample code and locale files. The specific changes within the project file are not detailed here as they are assumed to be minor updates related to the skeleton feature.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#4959 Add sample code demonstrating TreeView skeleton functionality

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 the documentation Improvements or additions to documentation label Dec 26, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 26, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 26, 2024
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 and they look great!

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 Dec 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9bf6c46) to head (8c66a4b).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4960   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          629       629           
  Lines        28096     28096           
  Branches      4035      4035           
=========================================
  Hits         28096     28096           

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

@ArgoZhang ArgoZhang merged commit ee332f1 into main Dec 26, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-treeview branch December 26, 2024 11:52
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(TreeView): update skeleton documentation

2 participants