Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add the Navbar page #87

Merged
merged 6 commits into from
Oct 27, 2024
Merged

feat(docs): add the Navbar page #87

merged 6 commits into from
Oct 27, 2024

Conversation

desmondinho
Copy link
Contributor

@desmondinho desmondinho commented Oct 27, 2024

Summary by CodeRabbit

  • New Features

    • Introduced new components for various navbar styles including Blurred, Bordered, Brand, Custom Styles, Height, Max Width, Menu, Sticky, and Usage.
    • Added a new PreviewCode component to display code snippets for navbar examples.
    • Enhanced navigation accessibility by unlocking the LumexNavbar in the navigation structure.
  • Bug Fixes

    • Minor formatting adjustments in the rendering of slot names for improved visual presentation.
  • Documentation

    • Updated documentation for the Navbar component, including usage examples and styling options.
  • Style

    • Added new CSS rules to enhance styling capabilities for the navbar and related components.
    • Introduced a new CSS rule for the .token.block class to improve styling behavior.

@desmondinho desmondinho self-assigned this Oct 27, 2024
Copy link

codecov bot commented Oct 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.17%. Comparing base (19b89dc) to head (d0e6271).
Report is 35 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #87      +/-   ##
==========================================
- Coverage   96.95%   96.17%   -0.78%     
==========================================
  Files          70       68       -2     
  Lines        1542     1542              
  Branches      150      145       -5     
==========================================
- Hits         1495     1483      -12     
- Misses         28       39      +11     
- Partials       19       20       +1     

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

Copy link

coderabbitai bot commented Oct 27, 2024

Walkthrough

The changes in this pull request encompass modifications and additions across various components and documentation files within the Lumex UI framework. Key updates include the unlocking of the LumexNavbar in the NavigationStore, adjustments in component rendering and styling, and the introduction of new Razor components for navigation bars with various styles. Additionally, several new pages have been created to showcase examples of these components, enhancing the overall documentation and usability of the framework.

Changes

File Change Summary
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs Modified NavigationStore to unlock the LumexNavbar in ComponentsCategory.
docs/LumexUI.Docs.Client/Components/DocsSlotsSection.razor Adjusted formatting of slot names by moving the colon inside the <strong> tag.
docs/LumexUI.Docs.Client/Components/Header.razor Removed nested <LumexNavbarContent> wrapping <LumexNavbarBrand>, simplifying the structure.
docs/LumexUI.Docs.Client/Components/PreviewCode.razor Changed outer <div> class to use dynamic binding with @BaseClass.
docs/LumexUI.Docs.Client/Components/PreviewCode.razor.cs Added new public parameter Class to PreviewCode component for custom CSS class.
docs/LumexUI.Docs.Client/Pages/Components/CheckboxGroup/CheckboxGroup.razor Updated isServer property in OnInitialized method from true to false.
docs/LumexUI.Docs.Client/Pages/Components/Divider/Examples/Usage.razor Changed <div> class from shadow-lg to shadow-md.
docs/LumexUI.Docs.Client/Pages/Components/Link/Link.razor Updated documentation to clarify "link component" instead of "divider component".
docs/LumexUI.Docs.Client/Pages/Components/Navbar/Examples/*.razor Introduced multiple new Razor components for different navbar styles (e.g., Blurred, Bordered, Brand, etc.) with corresponding structures and functionalities.
docs/LumexUI.Docs.Client/Pages/Components/Navbar/Navbar.razor Added documentation for the Navbar component, detailing its usage, features, and slots.
docs/LumexUI.Docs/Styles/prism.css Added new CSS rule for .token.block class.
src/LumexUI/Components/Navbar/NavbarSlots.cs Removed and re-added properties Menu and MenuItem as nullable strings.
src/LumexUI/Styles/Navbar.cs Updated _base and _wrapper static strings to include "w-full" for full-width layout.

Poem

In the garden of code, where rabbits play,
The Navbar's now free, come join the fray!
With styles so bright and examples galore,
Hop in, dear friends, there's so much to explore!
From blurred to bordered, each path is a treat,
Let's celebrate changes, oh what a feat! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between efe2ecd and d0e6271.

📒 Files selected for processing (1)
  • docs/LumexUI.Docs.Client/Pages/Components/Navbar/Navbar.razor (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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 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.

@desmondinho desmondinho merged commit 91345fc into main Oct 27, 2024
4 checks passed
@desmondinho desmondinho deleted the docs/navbar branch October 27, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant