Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 28, 2025

add UniverSheet component

Summary of the changes (Less than 80 chars)

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

Description

fixes #5462

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

This pull request introduces the UniverSheet component to the BootstrapBlazor server project. It includes the core component, a sample implementation, and a plugin to demonstrate data integration capabilities.

New Features:

  • Adds a UniverSheet component to the BootstrapBlazor server project, allowing users to embed and interact with online spreadsheets.
  • Integrates a plugin for the UniverSheet component, providing additional functionalities such as data retrieval and display within the spreadsheet.

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 28, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 28, 2025

Reviewer's Guide by Sourcery

This pull request introduces the UniverSheet component to the BootstrapBlazor server application. It includes the core component, a plugin for extending functionality, a data service for handling data exchange, and a controller for managing plugin commands and UI elements. The component is integrated into the application with a new route, localization support, and documentation.

Sequence diagram for getting data from BootstrapBlazor

sequenceDiagram
    participant ReportController
    participant DataService
    participant UniverSheet
    participant univerAPI

    ReportController->>DataService: getDataAsync(messageName, commandName)
    activate DataService
    DataService-->>ReportController: data
    deactivate DataService
    ReportController->>UniverSheet: univerAPI = getUniverSheet()
    ReportController->>univerAPI: getActiveWorkbook()
    univerAPI->>univerAPI: getActiveSheet()
    univerAPI->>univerAPI: getRange(0, 0, 2, 1)
    univerAPI->>univerAPI: setValues(defaultData)
Loading

Class diagram for UniverSheets Component

classDiagram
  class UniverSheets {
    ToastService ToastService
    Localizer IStringLocalizer
    Plugins Dictionary<string, string>
    _sheetExcel UniverSheet
    _sheetPlugin UniverSheet
    +OnReadyAsync() Task
    +OnPostDataAsync(UniverSheetData data) Task<UniverSheetData>
    +OnPushExcelData() Task
    +OnPushPluginData() Task
  }
  class UniverSheetData {
    MessageName string
    CommandName string
    Data object
  }

  UniverSheets -- UniverSheetData : Uses
  note for UniverSheets "This class represents the UniverSheets component in Blazor."
Loading

Class diagram for ReportController

classDiagram
  class ReportController {
    _injector Injector
    _commandService ICommandService
    _menuManagerService IMenuManagerService
    _componentManager ComponentManager
    +ReportController(Injector _injector, ICommandService _commandService, IMenuManagerService _menuManagerService, ComponentManager _componentManager)
    -_initCommands()
    -_registerComponents()
    -_initMenus()
    -_registerReceiveDataCallback()
    +receiveData(data, sheet)
  }

  ReportController -- Injector : Uses
  ReportController -- ICommandService : Uses
  ReportController -- IMenuManagerService : Uses
  ReportController -- ComponentManager : Uses
  note for ReportController "This class manages the ReportPlugin's commands and UI elements."
Loading

Class diagram for ReportPlugin

classDiagram
  class ReportPlugin {
    static pluginName string
    _injector Injector
    +ReportPlugin(Injector _injector)
    +onStarting()
    +onReady()
    +onRendered()
  }

  ReportPlugin -- Injector : Uses
  note for ReportPlugin "This class represents the ReportPlugin for UniverSheet."
Loading

File-Level Changes

Change Details Files
Added a new UniverSheet component to the BootstrapBlazor server application.
  • Added a new route '/univer-sheet' for the UniverSheet component.
  • Created a new Razor component 'UniverSheets.razor' with associated code-behind and CSS files.
  • Implemented basic data pushing functionality to the UniverSheet component.
  • Added localization support for the new component.
  • Integrated a plugin to extend the UniverSheet functionality.
src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs
src/BootstrapBlazor.Server/Components/Samples/UniverSheets.razor.cs
src/BootstrapBlazor.Server/Components/Samples/UniverSheets.razor
src/BootstrapBlazor.Server/wwwroot/univer-sheet/controller.js
src/BootstrapBlazor.Server/wwwroot/univer-sheet/plugin.js
src/BootstrapBlazor.Server/Components/Samples/UniverSheets.razor.js
src/BootstrapBlazor.Server/Components/Samples/UniverSheets.razor.css
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
src/BootstrapBlazor.Server/docs.json
Implemented a data service for the UniverSheet component.
  • Created a DataService in JavaScript to handle communication with the UniverSheet component.
  • Implemented methods to send and receive data to/from the UniverSheet instance.
  • Registered a callback to process received data and update the sheet.
src/BootstrapBlazor.Server/wwwroot/univer-sheet/controller.js
src/BootstrapBlazor.Server/wwwroot/univer-sheet/plugin.js
Added a controller to manage UniverSheet plugin functionalities.
  • Created a ReportController in JavaScript to manage commands and menus.
  • Registered commands for data retrieval.
  • Registered components for custom icons.
  • Initialized menus to integrate custom actions into the UniverSheet UI.
src/BootstrapBlazor.Server/wwwroot/univer-sheet/controller.js
src/BootstrapBlazor.Server/wwwroot/univer-sheet/plugin.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5462 Add a UniverSheet component to the BootstrapBlazor Server project.

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.3.0 milestone Feb 28, 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 screenshot or GIF to the PR to visually demonstrate the new UniverSheet component.
  • The controller.js file has a lot of code - consider breaking it up into smaller files.
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 Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (82d4186) to head (537aea1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5463   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          646       646           
  Lines        29358     29358           
  Branches      4131      4131           
=========================================
  Hits         29358     29358           

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

@ArgoZhang ArgoZhang merged commit ac2ac31 into main Feb 28, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-sheet branch February 28, 2025 07:01
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(UniverSheet): add UniverSheet component

3 participants