feat(Utility): add custom changed.bb.theme event

[ArgoZhang]

Link issues

fixes #5708

Summary By Copilot

This pull request includes changes to the src/BootstrapBlazor.Server/Components/Components/Pre.razor.cs and src/BootstrapBlazor.Server/Components/Components/Pre.razor.js files to remove the theme handling logic from the C# code and move it to the JavaScript code. Additionally, minor updates were made to other JavaScript files to improve code consistency.

Theme handling changes:

• src/BootstrapBlazor.Server/Components/Components/Pre.razor.cs: Removed the ThemeProviderService property and the OnThemeChanged method. [1] [2] [3]
• src/BootstrapBlazor.Server/Components/Components/Pre.razor.js: Added the registerBootstrapBlazorModule function call to handle theme changes and updated the dispose method to unregister the theme change event. [1] [2] [3]

Code consistency improvements:

• src/BootstrapBlazor/wwwroot/modules/base-popover.js: Replaced the nullish coalescing operator with the logical OR operator for better compatibility.
• src/BootstrapBlazor/wwwroot/modules/utility.js: Imported EventHandler and added an event trigger for theme changes in the setTheme function. [1] [2]

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

Refactors theme handling for the Pre component by moving the logic from C# to JavaScript, and triggers a custom 'changed.bb.theme' event when the theme is changed. This allows JavaScript modules to react to theme changes.

New Features:

• Adds a custom 'changed.bb.theme' event that is triggered when the theme is changed.

Enhancements:

• Moves theme handling logic from C# to JavaScript for the Pre component.
• Improves code consistency by replacing the nullish coalescing operator with the logical OR operator in base-popover.js.
• Adds an event trigger for theme changes in the setTheme function in utility.js.
• Registers and unregisters the theme change event handler in the Pre component's JavaScript module to avoid memory leaks.
• Removes the ThemeProviderService property and OnThemeChanged method from the Pre.razor.cs file, simplifying the C# code and reducing its dependency on the theme service.
• Updates the dispose method in Pre.razor.js to unregister the theme change event, ensuring proper cleanup when the component is disposed of.
• Adds a registerBootstrapBlazorModule function call to handle theme changes in Pre.razor.js, centralizing the theme change logic in the JavaScript module.
• Creates an updateTheme function in Pre.razor.js to handle theme changes and call the switchTheme function, improving code organization and maintainability.
• Modifies the setTheme function in utility.js to trigger a custom 'changed.bb.theme' event when the theme is changed, allowing other modules to react to theme changes.
• Imports EventHandler in utility.js to enable triggering custom events.
• Adds a theme parameter to the 'changed.bb.theme' event, providing the new theme value to event listeners.
• Updates the dispose method in Pre.razor.js to properly unregister the theme change event handler, preventing memory leaks and ensuring proper cleanup.
• Removes unnecessary nullish coalescing operator in base-popover.js

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request refactors the Pre component to handle theme changes in JavaScript instead of C#. It also includes minor code consistency improvements in other JavaScript files. The theme handling logic was removed from the C# code and moved to the JavaScript code. An event trigger was added for theme changes in the setTheme function.

Sequence diagram for theme change event

sequenceDiagram
    participant User
    participant utility.js
    participant Pre.razor.js

    User->>utility.js: setTheme(theme)
    activate utility.js
    utility.js->>utility.js: saveTheme(theme)
    utility.js->>utility.js: localStorage.setItem("theme", theme)
    utility.js->>document: EventHandler.trigger(document, 'changed.bb.theme', { theme: theme })
    deactivate utility.js
    document-->>Pre.razor.js: changed.bb.theme event
    activate Pre.razor.js
    Pre.razor.js->>Pre.razor.js: updateTheme(e)
    Pre.razor.js->>Pre.razor.js: switchTheme(theme)
    deactivate Pre.razor.js

Loading

File-Level Changes

Change	Details	Files
Moved theme handling logic from C# to JavaScript for the Pre component.	Removed the ThemeProviderService property. Removed the OnThemeChanged method. Added registerBootstrapBlazorModule to handle theme changes. Updated the dispose method to unregister the theme change event. Added an event trigger for theme changes in the setTheme function in utility.js.	src/BootstrapBlazor.Server/Components/Components/Pre.razor.cs src/BootstrapBlazor.Server/Components/Components/Pre.razor.js src/BootstrapBlazor/wwwroot/modules/utility.js
Improved code consistency in JavaScript files.	Replaced the nullish coalescing operator with the logical OR operator for better compatibility.	src/BootstrapBlazor/wwwroot/modules/base-popover.js

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5708	Add a custom changed.bb.theme event.	✅

Possibly linked issues

• feat(Utility): add custom changed.bb.theme event #5708: The PR fixes the issue by moving theme handling logic from C# code to JavaScript code and adding a custom event trigger for theme changes. This addresses the ThemeProvider issue in Photino.Blazor mode.

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider debouncing the changed.bb.theme event to avoid excessive updates.

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5709   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          657       657           
  Lines        29824     29824           
  Branches      4226      4226           
=========================================
  Hits         29824     29824           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.