Add ReverseNavPanel parameter to BitLayout (#9755)

[msynk]

closes #9755

Summary by CodeRabbit

• New Features

  • Added a ReverseNavPanel option to the layout component
  • Allows reversing the position of the navigation panel within the main container

• Documentation

  • Updated component documentation to explain the new layout configuration option

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces a new feature for the BitLayout component that allows reversing the position of the navigation panel within the main container. This is achieved by adding a ReverseNavPanel boolean property to the BitLayout class and modifying the Razor template to conditionally apply a CSS flex direction style. The change provides more flexibility in layout configuration, enabling developers to position the navigation panel on either the left or right side of the main content area.

Changes

File	Change Summary
src/BlazorUI/Bit.BlazorUI/Components/Layouts/Layout/BitLayout.razor	Added conditional style to support reversing navigation panel position
src/BlazorUI/Bit.BlazorUI/Components/Layouts/Layout/BitLayout.razor.cs	Added ReverseNavPanel property and restored RegisterCssStyles method
src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Layouts/Layout/BitLayoutDemo.razor.cs	Added ReverseNavPanel parameter to component parameters

Assessment against linked issues

Objective	Addressed	Explanation
Support NavPanel on right side	✅
Provide flexibility in NavPanel positioning	✅
Mobile/tablet layout considerations	❓	Additional mobile-specific layout logic not implemented

Poem

🐰 A layout that dances left and right,
Flex direction changing with delight!
Nav panel pirouettes with grace,
Spinning 'round its container's space.
Code rabbit's layout magic takes flight! 🌈

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Layout/BitLayout.razor (1)

21-21: Consider using a more robust style concatenation approach.

While the current implementation works, consider using a style builder or helper method to handle style concatenation more robustly. This would help prevent potential issues with missing spaces or semicolons.

-        <main style="@(ReverseNavPanel ? "flex-direction:row-reverse;" : "")@Styles?.Main" class="bit-lyt-man @Classes?.Main">
+        <main style="@GetMainStyles()" class="bit-lyt-man @Classes?.Main">

Add this method to the code-behind file:

private string GetMainStyles()
{
    var styles = new List<string>();
    
    if (ReverseNavPanel)
    {
        styles.Add("flex-direction:row-reverse");
    }
    
    if (!string.IsNullOrEmpty(Styles?.Main))
    {
        styles.Add(Styles.Main);
    }
    
    return string.Join(";", styles);
}

src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Layouts/Layout/BitLayoutDemo.razor.cs (1)

59-65: Consider adding an example demonstrating ReverseNavPanel usage.

While the parameter is well-documented, consider adding an example to demonstrate its usage in one of the example code snippets (example1RazorCode, example2RazorCode, or example3RazorCode).

For example, you could modify example3RazorCode to include:

 <BitLayout Styles="@(new() { Main = "height: 19rem;" })" 
+           ReverseNavPanel="true"
            Classes="@(new() { Header = "header2",

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 991ab57 and aad65f4.

📒 Files selected for processing (3)

• src/BlazorUI/Bit.BlazorUI/Components/Layouts/Layout/BitLayout.razor (1 hunks)
• src/BlazorUI/Bit.BlazorUI/Components/Layouts/Layout/BitLayout.razor.cs (2 hunks)
• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Core/Pages/Components/Layouts/Layout/BitLayoutDemo.razor.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test

🔇 Additional comments (2)

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Layout/BitLayout.razor.cs (2)

43-46: LGTM! Well-documented parameter.

The parameter is well-documented and follows the established pattern in the codebase.

---

69-72: LGTM! Clean implementation.

The RegisterCssStyles method is simple and correctly registers the root styles.