feat(Memorial): add Memorial Mode #5584
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis pull request introduces a new "Memorial Mode" feature, which adds a grayscale filter and adjusts colors to give the website a memorial theme. The implementation involves changes to the CSS, JavaScript, and Blazor components to toggle the mode on and off. Additionally, the pull request includes localization improvements and code documentation updates. Sequence diagram for toggling Memorial ModesequenceDiagram
participant User
participant Memorial.razor
participant JSModuleExtensions
participant utility.js
User->>Memorial.razor: Clicks Toggle Button
Memorial.razor->>JSModuleExtensions: LoadUtility()
activate JSModuleExtensions
JSModuleExtensions->>utility.js: Load module
activate utility.js
utility.js-->>JSModuleExtensions: Returns JSModule
deactivate utility.js
JSModuleExtensions-->>Memorial.razor: Returns JSModule
deactivate JSModuleExtensions
Memorial.razor->>JSModuleExtensions: SetMemorialModeAsync(isMemorial)
activate JSModuleExtensions
JSModuleExtensions->>utility.js: setMemorialMode(isMemorial)
activate utility.js
utility.js-->>JSModuleExtensions: void
deactivate utility.js
JSModuleExtensions-->>Memorial.razor: void
deactivate JSModuleExtensions
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider adding a configuration option to enable/disable memorial mode by default.
- The JS function
setMemorialModecould be improved by checking if thedata-bs-original-themeattribute already exists before setting it.
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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5584 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 649 649
Lines 29623 29625 +2
Branches 4170 4170
=========================================
+ Hits 29623 29625 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #5583
Summary By Copilot
This pull request introduces a new "Memorial Mode" feature and includes several localization improvements and code documentation updates. The most important changes are summarized below:
New Feature: Memorial Mode
src/BootstrapBlazor.Server/Components/Samples/Tutorials/Memorial.razor: Added a new page for the Memorial Mode tutorial.src/BootstrapBlazor.Server/Components/Samples/Tutorials/Memorial.razor.cs: Implemented the Memorial Mode functionality with a toggle button to switch the mode on and off.src/BootstrapBlazor/Extensions/JSModuleExtensions.cs: Added a new methodSetMemorialModeAsyncto theJSModuleExtensionsclass to handle the Memorial Mode setting in JavaScript.src/BootstrapBlazor/wwwroot/modules/utility.js: Added a new functionsetMemorialModeto manage the Memorial Mode in the frontend.src/BootstrapBlazor/wwwroot/scss/root.scss: Added CSS rules for the Memorial Mode, including grayscale filter and color adjustments.Localization Improvements
src/BootstrapBlazor.Server/Locales/en-US.json: Added the translation for "MemorialMode".src/BootstrapBlazor.Server/Locales/zh-CN.json: Added the translation for "MemorialMode".Code Documentation Updates
src/BootstrapBlazor/Extensions/JSModuleExtensions.cs: Updated method comments to improve clarity and consistency in English. [1] [2] [3]src/BootstrapBlazor/Options/BootstrapBlazorOptions.cs: Updated property comments to improve clarity and consistency in English.Other Changes
src/BootstrapBlazor.Server/Components/Components/Header.razor: Commented out the code for the Chinese-specific theme link.src/BootstrapBlazor.Server/Components/Layout/TutorialsNavMenu.razor.cs: Added a new navigation item for the Memorial Mode tutorial.Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge