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 Textbox page #94

Merged
merged 7 commits into from
Oct 31, 2024
Merged

feat(docs): add the Textbox page #94

merged 7 commits into from
Oct 31, 2024

Conversation

desmondinho
Copy link
Contributor

@desmondinho desmondinho commented Oct 31, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a variety of new textbox components, including clearable, read-only, required, and customizable styles.
    • Added examples for textbox variants, sizes, and label placements to enhance user experience.
    • Implemented a debounce delay feature for optimized input handling.
    • Enhanced the Textbox documentation with comprehensive sections covering various functionalities and interactive previews.
  • Bug Fixes

    • Adjusted styling of the clear button icon for better visual representation.
  • Documentation

    • Comprehensive updates to the textbox documentation, including detailed usage examples and advanced functionalities.
    • Added interactive previews for various textbox configurations to facilitate user understanding.

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

coderabbitai bot commented Oct 31, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request encompass modifications to various components and documentation within the Lumex UI framework. Key updates include the removal of the locked parameter from the LumexTextbox component, the addition of the FluentValidation package, and the introduction of multiple new Razor components for showcasing different functionalities of textboxes. These components include features like clearable textboxes, color variants, and error messages. Additionally, updates were made to existing components for improved parameter handling and visual styling.

Changes

File Change Summary
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs Removed locked: true from LumexTextbox in navigation categories.
docs/LumexUI.Docs.Client/LumexUI.Docs.Client.csproj Added package reference for FluentValidation version 11.10.0.
docs/LumexUI.Docs.Client/Pages/Components/Switch/Switch.razor Updated documentation terminology from "checked state" to "toggled state".
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/ClearButton.razor Introduced a clearable textbox component with email input and feedback on clearing.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/Colors.razor Added a component to display textboxes with different color themes.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/CustomStyles.razor Created a customizable textbox component with integrated styling and search icon.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/DebounceDelay.razor Introduced a textbox with debounce functionality for optimized input handling.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/Description.razor Added a textbox component for email input with privacy description.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/Disabled.razor Created a disabled textbox component for email input.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/ErrorMessage.razor Introduced a component for email validation using FluentValidation.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/LabelPlacements.razor Added a component to demonstrate label placements for textboxes.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/ReadOnly.razor Created a read-only textbox component for email input.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/Required.razor Added a required textbox component for email input.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/Sizes.razor Introduced a component for displaying textbox sizes.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/StartEndContent.razor Created a component for displaying textboxes with start and end content.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/TwoWayDataBinding.razor Added a component for demonstrating two-way data binding with textboxes.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/Usage.razor Introduced a usage example for the LumexTextbox component.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/Variants.razor Added a component for displaying variants of textboxes.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/Examples/_Radius.razor Created a component for displaying textboxes with varying radius styles.
docs/LumexUI.Docs.Client/Pages/Components/Textbox/PreviewCodes/*.razor Introduced multiple preview code components for various textbox examples, enhancing interactivity in documentation.
src/LumexUI/Components/Bases/LumexInputFieldBase.razor Changed LumexIcon color property in clear button from @ThemeColor.Default to @ThemeColor.None.
src/LumexUI/Components/Bases/LumexInputFieldBase.razor.cs Added SetParametersAsync method for improved parameter handling and implemented IAsyncDisposable.
src/LumexUI/Styles/InputField.cs Added a new shadow style for the InputVariant.Underlined case in the GetVariantUnderlinedByColorStyles method.

Possibly related PRs

  • feat(docs): add the Colors page #74: The changes in the main PR involve the LumexTextbox component, which is related to the overall UI components, including color customization and usage in the documentation. However, the specific changes in the main PR do not directly connect to the modifications made in the Colors page, as they focus on different components and functionalities.

Poem

In the garden of code, we hop and play,
New textboxes bloom, brightening the day.
Clear buttons and colors, oh what a sight,
With validation magic, everything feels right!
So let’s celebrate changes, both big and small,
In the world of Lumex, we’re having a ball! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.39%. Comparing base (19b89dc) to head (ede409c).
Report is 53 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #94      +/-   ##
==========================================
- Coverage   96.95%   95.39%   -1.56%     
==========================================
  Files          70       70              
  Lines        1542     1562      +20     
  Branches      150      151       +1     
==========================================
- Hits         1495     1490       -5     
- Misses         28       48      +20     
- Partials       19       24       +5     

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

@desmondinho desmondinho merged commit 7f23867 into main Oct 31, 2024
6 checks passed
@desmondinho desmondinho deleted the docs/textbox branch October 31, 2024 22:36
@desmondinho desmondinho added the documentation Improvements or additions to documentation label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant