Skip to content

feat(DockView): support auto switch theme#388

Merged
ArgoZhang merged 6 commits intomasterfrom
refactor-dockview
Mar 25, 2025
Merged

feat(DockView): support auto switch theme#388
ArgoZhang merged 6 commits intomasterfrom
refactor-dockview

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Mar 25, 2025

Link issues

fixes #387

Summary By Copilot

This pull request includes several changes to the BootstrapBlazor.DockView component to add theme switching functionality and improve the codebase. The most important changes include updating the project version, modifying the DockViewV2 component to implement IDisposable, and adding theme-related methods and event handlers.

Project Version Update:

Component Enhancements:

JavaScript Integration:

Utility Functions:

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Introduce theme switching capability in the DockViewV2 component, enabling automatic theme updates. Enhance the component by implementing IDisposable for better resource management and update project dependencies to the latest versions.

New Features:

  • Add theme switching functionality to the DockViewV2 component, allowing dynamic updates between light and dark themes.

Enhancements:

  • Implement IDisposable in DockViewV2 to manage theme change event handlers and resource cleanup.

Build:

  • Update project version to 9.1.8 and BootstrapBlazor package version to 9.4.12.

@bb-auto bb-auto Bot added the enhancement New feature or request label Mar 25, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Mar 25, 2025

Reviewer's Guide by Sourcery

This pull request introduces theme switching functionality to the BootstrapBlazor.DockView component. Key changes include updating the project and package versions, enhancing the DockViewV2 component to implement IDisposable and handle theme changes, integrating JavaScript for theme management, and adding utility functions for dynamic theme switching.

Sequence diagram for theme change handling

sequenceDiagram
    participant User
    participant DockViewV2
    participant ThemeProviderService
    participant JavaScript
    User->>DockViewV2: Change theme
    DockViewV2->>ThemeProviderService: Subscribe to ThemeChangedAsync
    ThemeProviderService-->>DockViewV2: ThemeChangedAsync event
    DockViewV2->>JavaScript: Update theme via switchTheme
    JavaScript-->>DockViewV2: Theme updated
Loading

File-Level Changes

Change Details Files
Updated project version and BootstrapBlazor package version.
  • Updated the project version to 9.1.8.
  • Updated the BootstrapBlazor package version to 9.4.12.
src/components/BootstrapBlazor.DockView/BootstrapBlazor.DockView.csproj
Enhanced DockViewV2 component to support theme switching.
  • Implemented IDisposable interface in DockViewV2.
  • Injected IThemeProvider service.
  • Added OnThemeChangedAsync method to handle theme changes.
  • Registered theme change event handler.
  • Updated Dispose method to unregister theme change event handler.
src/components/BootstrapBlazor.DockView/Components/DockViewV2.razor.cs
Integrated JavaScript for theme handling in DockViewV2.
  • Added theme handling in the init function.
  • Registered an event handler for theme changes.
  • Updated dispose function to remove theme change event handler.
src/components/BootstrapBlazor.DockView/Components/DockViewV2.razor.js
Added utility function for dynamic theme switching.
  • Added switchTheme method to update the theme dynamically.
src/components/BootstrapBlazor.DockView/wwwroot/js/dockview-utils.js

Assessment against linked issues

Issue Objective Addressed Explanation
#387 Implement auto switch theme functionality in the DockView 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. 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.2.0 milestone Mar 25, 2025
@ArgoZhang ArgoZhang merged commit 44aa89f into master Mar 25, 2025
1 check passed
@ArgoZhang ArgoZhang deleted the refactor-dockview branch March 25, 2025 05:09
Copy link
Copy Markdown

@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: 1 issue found
  • 🟢 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.

@@ -6,12 +6,13 @@ import { getConfig, reloadFromConfig, loadPanelsFromLocalstorage, saveConfig } f
import './dockview-extensions.js'

const cerateDockview = (el, options) => {
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (typo): Check function naming for consistency.

Consider renaming 'cerateDockview' to 'createDockview' if this was not an intentional naming choice, to improve readability and avoid potential confusion.

Suggested implementation:

const createDockview = (el, options) => {

If there are any references to "cerateDockview" elsewhere in the file or across your codebase, be sure to update them to "createDockview".

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(DockView): support auto switch theme

1 participant