search

LumexUI / lumexui

🚀 A versatile Blazor UI library built using Tailwind CSS.
https://lumexui.org
MIT License
48 stars 2 forks source link

feat(docs): add the Collapse page #89

Closed desmondinho closed 2 weeks ago

desmondinho commented 2 weeks ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes in this pull request involve modifications to the NavigationStore class to remove the locked parameter from navigation categories, allowing unrestricted access to certain components. Additionally, new Razor components for the Collapse feature documentation have been introduced, including usage examples and preview codes. These components enhance the documentation structure and provide interactive examples for users.

Changes

File Path Change Summary
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs Removed locked parameter from ComponentsCategory and ComponentsApiCategory for LumexCollapse and LumexIcon.
docs/LumexUI.Docs.Client/Pages/Components/Collapse/Collapse.razor Added new Razor component for Collapse documentation with sections for usage, custom styles, and API documentation.
docs/LumexUI.Docs.Client/Pages/Components/Collapse/Examples/Usage.razor Introduced a collapsible list structure using LumexCollapse, with state management for expansion.
docs/LumexUI.Docs.Client/Pages/Components/Collapse/PreviewCodes/Usage.razor Added a new interactive Razor component for previewing usage examples of the Collapse component.

Poem

In the garden where we play,
Changes bloom in bright array.
Collapse and expand, oh what fun,
With new docs, our work is done!
Hopping through code, we cheer and sing,
For every change, a joyful spring! 🐇✨

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between 7d46db807ba6116aa590ef9b6b1bbfb017e71e8f and 13a82a757b05939ebd7458e3265cfeed1a386a69.
📒 Files selected for processing (4) * docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1 hunks) * docs/LumexUI.Docs.Client/Pages/Components/Collapse/Collapse.razor (1 hunks) * docs/LumexUI.Docs.Client/Pages/Components/Collapse/Examples/Usage.razor (1 hunks) * docs/LumexUI.Docs.Client/Pages/Components/Collapse/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 . > >
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.