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 Icon page #90

Merged
merged 5 commits into from
Oct 28, 2024
Merged

feat(docs): add the Icon page #90

merged 5 commits into from
Oct 28, 2024

Conversation

desmondinho
Copy link
Contributor

@desmondinho desmondinho commented Oct 28, 2024

Summary by CodeRabbit

  • New Features

    • Introduced new examples showcasing the LumexIcon component with various colors and dimensions.
    • Added a dedicated documentation page for the LumexIcon component, detailing usage, customization, and API references.
  • Improvements

    • Enhanced visual representation of icons with custom styles and dimensions in documentation.
    • Simplified the rendering logic for the LumexIcon component to improve clarity and maintainability.
  • Bug Fixes

    • Corrected casing for the viewBox attribute in multiple components to align with standard HTML conventions.

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

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes in this pull request involve modifications to various components and documentation related to the LumexIcon within the LumexUI framework. Key updates include the removal of the locked parameter for the LumexIcon in the navigation structure, adjustments to the viewBox attribute casing in several components, new examples showcasing the LumexIcon in different colors and styles, and the introduction of a Dimensions struct to manage icon sizes. Additionally, new Razor components for documentation and previews have been created to enhance user understanding and interaction.

Changes

File Path Change Summary
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs Removed locked: true parameter from LumexIcon entry in navigation categories.
docs/LumexUI.Docs.Client/Components/ComponentLinks.razor Changed ViewBox attribute to lowercase viewBox for BlazorIcon and GithubIcon.
docs/LumexUI.Docs.Client/Components/Header.razor Changed ViewBox attribute to lowercase viewBox for LumexIcon.
docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/Colors.razor Added multiple LumexIcon instances with different colors from ThemeColor enumeration.
docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/CustomStyles.razor Introduced a LumexIcon component with Icons.Rounded.Bed, size 40, and class text-indigo-500.
docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/DimensionsFont.razor Added multiple LumexIcon instances with varying sizes for the "accessibility" icon.
docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/DimensionsSvg.razor Introduced multiple LumexIcon instances with varying sizes for Icons.Rounded.Home.
docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/Usage.razor Added several LumexIcon instances with different properties from the Icons.Rounded enumeration.
docs/LumexUI.Docs.Client/Pages/Components/Icon/Icon.razor Created a structured documentation layout detailing the usage, colors, dimensions, custom styles, and API for the LumexIcon component.
docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/Colors.razor Introduced a new component for rendering color icons with a PreviewCode element.
docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/CustomStyles.razor Introduced a new component for rendering custom styles related to icons with a PreviewCode element.
docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/DimensionsFont.razor Introduced a new component for rendering font dimensions associated with icons with a PreviewCode element.
docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/DimensionsSvg.razor Created a new component for rendering SVG icon dimensions with a PreviewCode element.
docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/Usage.razor Introduced a new component for rendering interactive code snippets with a PreviewCode element.
src/LumexUI/Common/Models/Dimensions.cs Introduced a new Dimensions struct with properties W and H, and constructors for width and height.
src/LumexUI/Components/Icon/LumexIcon.razor Changed viewBox attribute from dynamic to a static value.
src/LumexUI/Components/Icon/LumexIcon.razor.cs Removed ViewBox property, updated FontIconStyle to nullable, and moved dimension enforcement logic to OnParametersSet method.

Poem

In the garden of code, where icons play,
A rabbit hops by, brightening the day.
With colors and sizes, they dance and they twirl,
Each LumexIcon shines, a gem in the swirl.
From navigation to styles, oh what a delight,
Hooray for the changes, let’s hop with delight! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6619be4 and f46b550.

📒 Files selected for processing (17)
  • docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1 hunks)
  • docs/LumexUI.Docs.Client/Components/ComponentLinks.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Components/Header.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/Colors.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/CustomStyles.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/DimensionsFont.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/DimensionsSvg.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/Examples/Usage.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/Icon.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/Colors.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/CustomStyles.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/DimensionsFont.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/DimensionsSvg.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Icon/PreviewCodes/Usage.razor (1 hunks)
  • src/LumexUI/Common/Models/Dimensions.cs (1 hunks)
  • src/LumexUI/Components/Icon/LumexIcon.razor (1 hunks)
  • src/LumexUI/Components/Icon/LumexIcon.razor.cs (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 28, 2024

Codecov Report

Attention: Patch coverage is 55.55556% with 4 lines in your changes missing coverage. Please review.

Project coverage is 95.92%. Comparing base (19b89dc) to head (f46b550).
Report is 41 commits behind head on main.

Files with missing lines Patch % Lines
src/LumexUI/Components/Icon/LumexIcon.razor.cs 33.33% 3 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #90      +/-   ##
==========================================
- Coverage   96.95%   95.92%   -1.03%     
==========================================
  Files          70       69       -1     
  Lines        1542     1546       +4     
  Branches      150      146       -4     
==========================================
- Hits         1495     1483      -12     
- Misses         28       42      +14     
- Partials       19       21       +2     

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

@desmondinho
Copy link
Contributor Author

Ignoring codecov patch failure for the time being.

@desmondinho desmondinho merged commit 47f2e1c into main Oct 28, 2024
5 of 6 checks passed
@desmondinho desmondinho deleted the docs/icon branch October 28, 2024 20:07
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