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

doc(OnlineSheet): add OnlineSheet sample code #5510

Merged
merged 5 commits into from
Mar 4, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 4, 2025

Link issues

fixes #5509

Summary By Copilot

This pull request includes several changes to the BootstrapBlazor.Server project, focusing on updating dependencies, improving the layout, and adding new features related to the OnlineSheet component. Below are the most important changes:

Dependency Updates:

  • Updated BootstrapBlazor.UniverSheet package version from 9.0.0-beta02 to 9.0.0-beta04 in BootstrapBlazor.Server.csproj.

Layout Improvements:

  • Added a LayoutSplitebar component to the TutorialsLayout.razor file to enhance the layout's flexibility.
  • Updated CSS variables and styles in TutorialsLayout.razor.css to improve the layout and ensure proper spacing and responsiveness [1] [2] [3] [4].

New Features:

  • Introduced a new OnlineSheet component, including its Razor, CSS, and C# files to display and manage an online sheet [1] [2] [3] [4] [5] [6].
  • Added a MockOnlineContributor service to simulate real-time updates to the OnlineSheet component.

Localization Updates:

  • Updated en-US.json and zh-CN.json localization files to include new strings for the OnlineSheet component [1] [2] [3] [4].

Navigation Updates:

  • Added a new entry for the OnlineSheet tutorial in the TutorialsNavMenu.razor.cs file.

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

Adds an OnlineSheet component to the application, including layout enhancements and a mock contributor service for simulating real-time updates.

New Features:

  • Introduces an OnlineSheet component for displaying and managing online sheets.
  • Adds a MockOnlineContributor service to simulate real-time updates to the OnlineSheet component.
  • Implements a LayoutSplitebar component to enhance the layout's flexibility in TutorialsLayout.razor file

Copy link

sourcery-ai bot commented Mar 4, 2025

Reviewer's Guide by Sourcery

This pull request introduces the OnlineSheet component, including layout adjustments, a mock contributor service for simulating real-time updates, localization updates, and navigation enhancements. The primary goal is to provide a functional demonstration of the UniverSheet component within the BootstrapBlazor framework.

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

File-Level Changes

Change Details Files
Introduced a new OnlineSheet component with supporting files.
  • Added Razor component for displaying the online sheet.
  • Added CSS styles for the online sheet demo.
  • Added C# code-behind for the OnlineSheet component, including data handling and dispatch service integration.
  • Added a razor component to display the online contributor.
  • Added a css file to style the online contributor component.
  • Added a C# code-behind for the OnlineContributor component.
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineSheet.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineContributor.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineContributor.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineContributor.razor.css
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineSheet.razor
src/BootstrapBlazor.Server/Components/Samples/Tutorials/OnlineSheet/OnlineSheet.razor.css
Implemented a mock online contributor service to simulate real-time updates.
  • Added a background service to dispatch contributor updates.
  • Created a Contributor class to hold contributor information and sheet data.
src/BootstrapBlazor.Server/Services/MockOnlineContributor.cs
Updated the layout to include a splitter and adjusted CSS variables.
  • Added a LayoutSplitebar component to the TutorialsLayout.
  • Updated CSS variables for sidebar width.
  • Adjusted CSS styles for layout and responsiveness.
src/BootstrapBlazor.Server/Components/Layout/TutorialsLayout.razor.css
src/BootstrapBlazor.Server/Components/Layout/TutorialsLayout.razor
Updated localization files with new strings for the OnlineSheet component.
  • Added new localization keys and values for the OnlineSheet component in English.
  • Added new localization keys and values for the OnlineSheet component in Chinese.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Added a new entry for the OnlineSheet tutorial in the navigation menu.
  • Added a new navigation item for the OnlineSheet tutorial.
src/BootstrapBlazor.Server/Components/Layout/TutorialsNavMenu.razor.cs
Registered the MockOnlineContributor service.
  • Added the MockOnlineContributor as a hosted service.
src/BootstrapBlazor.Server/Extensions/ServiceCollectionExtensions.cs
Updated the BootstrapBlazor.UniverSheet package version.
  • Updated the package version in the project file.
src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5509 Add sample code for the OnlineSheet component.

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 the documentation Improvements or additions to documentation label Mar 4, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 4, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) March 4, 2025 06:46
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 @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using a constant for the string "OnlineSheet" in MockOnlineContributor.cs to avoid potential typos.
  • The CSS files OnlineSheet.razor.css and Components/Samples/Tutorials/OnlineSheet/OnlineSheet.razor.css are similar - can they be merged?
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 2 issues 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 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5510   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29563     29563           
  Branches      4165      4165           
=========================================
  Hits         29563     29563           

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

@ArgoZhang ArgoZhang merged commit 27f8299 into main Mar 4, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the doc-online-sheet branch March 4, 2025 06:48
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(OnlineSheet): add OnlineSheet sample code
1 participant