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

feat(FullScreen): remove FullScreen component #4537

Merged
merged 6 commits into from
Oct 25, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Oct 25, 2024

remove FullScreen component

Summary of the changes (Less than 80 chars)

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

Description

fixes #4536

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

Enhancements:

  • Refactor fullscreen functionality by removing the FullScreen component and simplifying the JavaScript module.

Copy link

sourcery-ai bot commented Oct 25, 2024

Reviewer's Guide by Sourcery

This PR removes the FullScreen component and refactors the fullscreen functionality into a service-based approach. The implementation simplifies the JavaScript module by removing the data management layer and converts the component-based implementation into a more streamlined service implementation.

Sequence diagram for toggling fullscreen mode

sequenceDiagram
    participant User
    participant FullScreenService
    participant JSModule
    User->>FullScreenService: Toggle(option, token)
    FullScreenService->>JSModule: LoadModule("./_content/BootstrapBlazor/modules/fullscreen.js")
    JSModule-->>FullScreenService: _module
    FullScreenService->>JSModule: InvokeAsync("toggle", token, option)
    JSModule-->>FullScreenService: Result
    FullScreenService-->>User: Task Result
Loading

Updated class diagram for FullScreenService

classDiagram
    class FullScreenService {
        +JSModule _module
        +Task Toggle(FullScreenOption? option, CancellationToken token)
    }
Loading

File-Level Changes

Change Details Files
Refactored fullscreen JavaScript module to remove data management and simplify implementation
  • Removed Data dependency and simplified state management
  • Converted multiple exported functions into a single toggle function
  • Simplified fullscreen element selection logic
  • Maintained existing fullscreen enter/exit functionality and CSS class handling
src/BootstrapBlazor/wwwroot/modules/fullscreen.js
Converted FullScreen component to a service-based implementation
  • Removed FullScreen component class
  • Created FullScreenService with dependency injection for JSRuntime
  • Implemented Toggle method using JS module loading
  • Removed inheritance from BootstrapServiceBase
src/BootstrapBlazor/Components/FullScreen/FullScreen.cs
src/BootstrapBlazor/Services/FullScreenService.cs
Removed FullScreen component from root layout
  • Removed FullScreen component reference from BootstrapBlazorRoot.razor
src/BootstrapBlazor/Components/BaseComponents/BootstrapBlazorRoot.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#4536 Remove the FullScreen 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 the enhancement New feature or request label Oct 25, 2024
@bb-auto bb-auto bot added this to the v8.10.0 milestone Oct 25, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) October 25, 2024 01:43
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 and found some issues that need to be addressed.

Blocking issues:

  • The browser compatibility fallback chain is not working correctly (link)

Overall Comments:

  • The browser prefix handling in enterFullscreen() needs to be fixed. The current OR (||) operator won't actually call the prefixed methods. Consider using: if (el.requestFullscreen) el.requestFullscreen(); else if (el.webkitRequestFullscreen) el.webkitRequestFullscreen(); etc.
Here's what I looked at during the review
  • 🔴 General issues: 1 blocking issue
  • 🟢 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.

src/BootstrapBlazor/wwwroot/modules/fullscreen.js Outdated Show resolved Hide resolved
src/BootstrapBlazor/wwwroot/modules/fullscreen.js Outdated Show resolved Hide resolved
src/BootstrapBlazor/wwwroot/modules/fullscreen.js Outdated Show resolved Hide resolved
Copy link

codecov bot commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0cae075) to head (4c24dda).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4537   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          630       629    -1     
  Lines        27052     27044    -8     
  Branches      3927      3926    -1     
=========================================
- Hits         27052     27044    -8     

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

@ArgoZhang ArgoZhang disabled auto-merge October 25, 2024 03:45
@ArgoZhang ArgoZhang merged commit b9a5bbd into main Oct 25, 2024
6 checks passed
@ArgoZhang ArgoZhang deleted the refactor-fullscreen branch October 25, 2024 03:45
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(FullScreen): remove FullScreen component
1 participant