feat(docs): add the Layout page

desmondinho commented 4 weeks ago

Summary by CodeRabbit

New Features
- Introduced a new Preview component for customizable preview interfaces.
- Added layout configuration options including font sizes, line heights, and shadows.
- Launched a new documentation page for customizing component layouts.
Bug Fixes
- Updated attribute names for consistency across components.
Documentation
- Enhanced examples and snippets for layout configurations.
- Streamlined documentation on theme customization.
Chores
- Added new using directives for improved namespace management in Razor components.
- Removed unnecessary import statements in Tailwind configuration.

coderabbitai[bot] commented 4 weeks ago

Walkthrough

This pull request modifies the PreviewCode.razor component by replacing its nested <div> structure with a new <Preview> component, which simplifies the rendering of child content and class management. The PreviewCode.razor.cs file introduces a new parameter, PreviewClasses, and removes the previous Slots class. Multiple layout configuration files are updated to include a new constructor for initializing layout properties. Additionally, several _Imports.razor files are updated with new using directives, and various classes and methods throughout the LumexUI framework are enhanced for improved functionality and customization.

Changes

File	Change Summary
`docs/LumexUI.Docs/LumexUI.Docs.Client/Components/PreviewCode.razor`	Replaced nested `<div>` structure with a single `<Preview>` component; `@ChildContent` remains unchanged.
`docs/LumexUI.Docs/LumexUI.Docs.Client/Components/PreviewCode.razor.cs`	Removed `Slots` class; added `PreviewClasses` parameter; simplified CSS class management.
`docs/LumexUI.Docs/LumexUI.Docs.Client/Pages/Components/Accordion/PreviewCodes/*.razor`	Updated attribute name from `Classes` to `PreviewClasses` in `PreviewCode` component.
`docs/LumexUI.Docs/LumexUI.Docs.Client/Samples/Layout/*.html`	Introduced `LayoutConfig()` constructor; added new HTML snippets for layout examples.
`docs/LumexUI.Docs/LumexUI.Docs.Client/_Imports.razor`	Added new using directives for `TailwindMerge` and `LumexUI.Docs.Theme`.
`src/LumexUI/Theme/Layout/LayoutConfig.cs`	Added properties and methods to improve layout configuration.
`src/LumexUI/Theme/Colors/Models/ColorScale.cs`	Updated constructor signature and properties in `ColorScale`.
`src/LumexUI/Scripts/Plugin/plugin.js`	Enhanced `lumexui` plugin configuration with new properties.

Possibly related PRs

#72: The changes in this PR involve the addition of a new documentation page for theming, which is related to the modifications made in the PreviewCode.razor file regarding the handling of CSS classes and the introduction of a new parameter for managing styles.
#73: This PR includes updates to the Theme documentation and introduces new types related to theming, which connects to the changes in the PreviewCode component that also focus on CSS class management and theming aspects.

🐇 In the meadow, new styles bloom,
A Preview component makes room.
With ChildContent and classes to share,
Custom layouts dance in the air.
From Slots to PreviewClasses, we cheer,
In the world of LumexUI, creativity's near! 🌼

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

codecov[bot] commented 4 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.37%. Comparing base (19b89dc) to head (4fbc5a8). Report is 22 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #78 +/- ## ========================================== - 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

LumexUI / lumexui