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 Divider page #83

Merged
merged 2 commits into from
Oct 21, 2024
Merged

feat(docs): add the Divider page #83

merged 2 commits into from
Oct 21, 2024

Conversation

desmondinho
Copy link
Contributor

@desmondinho desmondinho commented Oct 21, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new Divider component page with detailed usage, orientation options, and customization through Tailwind CSS.
    • Added examples demonstrating the Divider's functionality, including custom styles and usage in different layouts.
  • Bug Fixes

    • Updated the navigation structure to make the LumexDivider component accessible without a locked status.
  • Documentation

    • Enhanced documentation with new examples and previews for the Divider component, showcasing its implementation and customization options.

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

coderabbitai bot commented Oct 21, 2024

Walkthrough

The changes involve modifications to the NavigationStore class to update the locking status of the LumexDivider component and the addition of new Razor components for the Divider in the Lumex UI documentation. A new page for the Divider component has been created, detailing its usage, orientation, and customization options. Several examples showcasing the Divider's functionality and styling have also been added, along with preview components to demonstrate these features interactively.

Changes

File Change Summary
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs Updated Add method for LumexDivider in ComponentsCategory to remove locked: true. No changes in ComponentsApiCategory and commented-out Add calls remain unchanged.
docs/LumexUI.Docs.Client/Pages/Components/Divider/Divider.razor New Razor component for the Divider at route "/docs/components/divider". Includes sections for usage, orientation, customization, and API information. Implements layout and initializes component metadata in OnInitialized.
docs/LumexUI.Docs.Client/Pages/Components/Divider/Examples/CustomStyles.razor Added example of LumexDivider with vertical orientation in a list. Includes customized styles and specific attributes for appearance.
docs/LumexUI.Docs.Client/Pages/Components/Divider/Examples/Usage.razor Introduced a new usage example for LumexDivider with a structured layout of message blocks separated by the Divider.
docs/LumexUI.Docs.Client/Pages/Components/Divider/Examples/_Orientation.razor Added new example demonstrating LumexDivider with vertical orientation, showcasing alignment options with icons.
docs/LumexUI.Docs.Client/Pages/Components/Divider/PreviewCodes/CustomStyles.razor New component for rendering a preview of custom styles for the Divider. Utilizes Interactive WebAssembly rendering mode and references the CustomStyles example.
docs/LumexUI.Docs.Client/Pages/Components/Divider/PreviewCodes/Orientation.razor New component for displaying a preview of the Divider's orientation. Includes Interactive WebAssembly mode and references the _Orientation example.
docs/LumexUI.Docs.Client/Pages/Components/Divider/PreviewCodes/Usage.razor New component for rendering a preview of the Divider's usage. Specifies Interactive WebAssembly mode and references the Usage example.

Poem

In the garden of code, where dividers play,
A new path unfolds, brightening the way.
With styles and examples, our docs now delight,
The LumexDivider shines, a beautiful sight!
So hop on this journey, explore and create,
For every new change, let’s celebrate! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between aa197f3 and 201a919.

📒 Files selected for processing (8)
  • docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Divider/Divider.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Divider/Examples/CustomStyles.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Divider/Examples/Usage.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Divider/Examples/_Orientation.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Divider/PreviewCodes/CustomStyles.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Divider/PreviewCodes/Orientation.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Divider/PreviewCodes/Usage.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.

Copy link

codecov bot commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.37%. Comparing base (19b89dc) to head (201a919).
Report is 27 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #83      +/-   ##
==========================================
- Coverage   96.95%   96.37%   -0.58%     
==========================================
  Files          70       70              
  Lines        1542     1543       +1     
  Branches      150      145       -5     
==========================================
- Hits         1495     1487       -8     
- Misses         28       37       +9     
  Partials       19       19              

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

@desmondinho desmondinho merged commit b561d5f into main Oct 21, 2024
6 checks passed
@desmondinho desmondinho deleted the docs/divider branch October 21, 2024 23:02
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