Correct render order of the common components in Boilerplate (#10011)

[msynk]

closes #10011

Summary by CodeRabbit

• Refactor
  • Renamed several UI components (diagnostic modal, JavaScript bridge, and snack bar) for improved consistency.
  • Updated the layout to integrate the revised components within the established user interface structure.
• Chores
  • Revised style compilation settings and configuration mappings to support the updated component naming.
• Documentation
  • Adjusted internal documentation references to reflect the changes in component names.

[coderabbitai]

Walkthrough

This update renames several UI component classes and updates their references throughout the codebase. The changes affect the public interface of three components—DiagnosticModal, JsBridge, and SnackBar—by renaming them to AppDiagnosticModal, AppJsBridge, and AppSnackBar, respectively. The MainLayout has been updated to use the new App-prefixed components, and corresponding documentation and CSS compilation configurations have been adjusted accordingly.

Changes

File(s)	Change Summary
src/.../Components/Layout/AppDiagnosticModal.razor.cs, src/.../Components/Layout/AppJsBridge.razor.cs, src/.../Components/Layout/AppSnackBar.razor.cs	Renamed classes from DiagnosticModal, JsBridge, and SnackBar to AppDiagnosticModal, AppJsBridge, and AppSnackBar respectively; updated associated variable types in AppJsBridge.razor.cs.
src/.../Components/Layout/MainLayout.razor	Replaced old component tags (<SnackBar />, <DiagnosticModal />, <JsBridge />) with the new <AppSnackBar />, <AppDiagnosticModal />, and <AppJsBridge /> within the cascading context.
src/.../Services/DiagnosticLog/DiagnosticLoggerProvider.cs	Updated XML documentation reference from <see cref="DiagnosticModal"/> to <see cref="AppDiagnosticModal"/>.
src/.../compilerconfig.json	Added a new CSS compilation configuration for AppDiagnosticModal; updated existing configurations by remapping entries for AuthorizedHeader and AppSnackBar.

Poem

I'm a rabbit hopping through the code,
Skipping old names on a brand new road.
With App-prefixed components in a joyful parade,
My layout now sparkles with a fresh upgrade.
I twirl in delight at each renamed byte,
Celebrating changes from morning to night.
Hop, hop, hooray! 🐇💻

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 471909b and 0294721.

📒 Files selected for processing (6)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/AppDiagnosticModal.razor.cs (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/AppJsBridge.razor.cs (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/AppSnackBar.razor.cs (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/MainLayout.razor (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/DiagnosticLog/DiagnosticLoggerProvider.cs (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/compilerconfig.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/DiagnosticLog/DiagnosticLoggerProvider.cs

🔇 Additional comments (7)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/AppSnackBar.razor.cs (1)

3-3: LGTM! Class renamed for consistency.

The renaming from SnackBar to AppSnackBar aligns with the new naming convention while preserving all functionality.

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/AppJsBridge.razor.cs (1)

3-5: LGTM! Class and type reference updated consistently.

The renaming from JsBridge to AppJsBridge and the corresponding update to DotNetObjectReference<AppJsBridge> maintains type safety while following the new naming convention.

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/MainLayout.razor (1)

49-54:

Details

❓ Verification inconclusive

Verify the rendering order of components.

The components have been reordered and renamed with the App prefix. Please ensure this order (AppSnackBar → AppDiagnosticModal → BitModalContainer → AppJsBridge) is intentional and doesn't affect component initialization or event handling.

---

🏁 Script executed:

#!/bin/bash
# Search for any component ordering dependencies
rg -A 5 "BitModalContainer|AppSnackBar|AppDiagnosticModal|AppJsBridge" --type razor

Length of output: 115

---

---

Double-check the rendering order of components in MainLayout.razor.
The components have been reordered and renamed with the App prefix. Please ensure that the sequence—AppSnackBar, AppDiagnosticModal, BitModalContainer, followed by AppJsBridge—is intentional and does not disrupt component initialization or event handling. Manual verification is recommended to confirm that this order does not affect component dependencies or application behavior.

---

🏁 Script executed:

#!/bin/bash
# Re-run the search over .razor files by explicitly using a glob pattern to bypass the unrecognized file type error.
rg -g "*.razor" -A 5 "BitModalContainer|AppSnackBar|AppDiagnosticModal|AppJsBridge"

Length of output: 2029

---

Confirm the New Component Rendering Order

The MainLayout.razor file now renders the components in this order:

• <AppSnackBar />
• <AppDiagnosticModal />
• <BitModalContainer ModalParameters="modalParameters" />
• <AppJsBridge />

Please ensure that this sequence is intentional and does not disrupt component initialization or event handling. Although our searches did not reveal any explicit dependencies tied to the ordering, manual verification is advised to confirm that this configuration aligns with the overall application behavior.

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/AppDiagnosticModal.razor.cs (1)

15-15: LGTM! Class renamed while preserving diagnostic functionality.

The renaming from DiagnosticModal to AppDiagnosticModal follows the new naming convention while maintaining all diagnostic and debugging capabilities.

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/compilerconfig.json (3)

9-14: New AppDiagnosticModal Configuration Entry

A new configuration entry has been added for the AppDiagnosticModal component with the correct output and input file paths. This aligns with the renaming changes outlined in the PR objectives.

---

21-26: Updated AppSnackBar Configuration Mapping

The configuration for AppSnackBar now points to its new CSS and SCSS files as expected. Ensure that these file names and paths are consistent with the renamed component in the codebase.

---

27-32: Reassigned AuthorizedHeader Configuration

The configuration for AuthorizedHeader has been updated to reflect its new role in the component mapping (swapping with DiagnosticModal as per the renaming strategy). Verify that all component references (in both code and documentation) are accordingly updated.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.