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 Popover page #92

Merged
merged 6 commits into from
Oct 29, 2024
Merged

feat(docs): add the Popover page #92

merged 6 commits into from
Oct 29, 2024

Conversation

desmondinho
Copy link
Contributor

@desmondinho desmondinho commented Oct 29, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced multiple examples for the LumexPopover component, showcasing various functionalities such as arrow display, color themes, custom styles, offsets, placements, shadows, sizes, and radius options.
    • Added a comprehensive documentation page for the LumexPopover component, detailing usage, customization, and API.
  • Bug Fixes

    • Improved state management for popover visibility, ensuring better handling when hiding popovers.
  • Documentation

    • Enhanced clarity of documentation for the LumexPopover component and its related features.
  • Tests

    • Commented out a specific test case in the popover test suite to simplify the test coverage.

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

coderabbitai bot commented Oct 29, 2024

Walkthrough

The changes involve modifications to the LumexPopover component and its related examples and tests within the Lumex UI documentation. Key updates include the removal of the locked parameter for the LumexPopover entry in the NavigationStore, the introduction of various new examples showcasing the LumexPopover component with different properties, and updates to existing components to enhance functionality and documentation clarity. Additionally, some test cases have been commented out, simplifying the test suite.

Changes

File Change Summary
docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs Removed locked: true from LumexPopover entry in ComponentsCategory.
docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/*.razor Added multiple new examples for LumexPopover showcasing various features like arrow, colors, custom styles, offsets, placements, shadows, sizes, and usage.
docs/LumexUI.Docs.Client/Pages/Components/Popover/Popover.razor Created documentation page for LumexPopover with sections for colors, sizes, shadows, etc.
src/LumexUI/Components/Button/LumexButton.razor.cs Changed OnClickAsync method access from private to private protected.
src/LumexUI/Components/Popover/LumexPopover.razor.cs Updated XML documentation, added line to clear last shown popover in Hide() method.
src/LumexUI/Components/Popover/LumexPopoverContent.razor Removed z-index style, adjusted rendering logic for nested <div>.
src/LumexUI/Components/Popover/LumexPopoverTrigger.razor Changed inheritance from LumexComponentBase to LumexButton, altering rendering logic.
src/LumexUI/Components/Popover/LumexPopoverTrigger.razor.cs Updated class to inherit from LumexButton, simplified parameters, and added new methods for event handling.
src/LumexUI/Styles/Popover.cs Modified style application logic for size and shadow, updated method signatures.
tests/LumexUI.Tests/Components/Popover/PopoverTests.razor Commented out ShouldNotShowOnTriggeringShownOne test method.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Popover as LumexPopover
    participant Trigger as LumexPopoverTrigger
    participant Content as LumexPopoverContent

    User->>Trigger: Click to open
    Trigger->>Popover: Show()
    Popover->>Content: Render content
    Content-->>User: Display popover
    User->>Trigger: Click to close
    Trigger->>Popover: Hide()
    Popover->>Content: Clear content
Loading

🐰 "In the garden of code, we hop with delight,
New popovers bloom, oh what a sight!
With colors and arrows, they dance in the air,
Each click brings joy, a whimsical flair!
So let’s celebrate changes, both big and small,
In the world of Lumex, we’re having a ball!" 🌼✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 47f2e1c and 04a0e3f.

📒 Files selected for processing (28)
  • docs/LumexUI.Docs.Client/Common/Navigation/NavigationStore.cs (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/Arrow.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/Colors.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/CustomStyles.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/Offset.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/Placements.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/Shadows.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/Sizes.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/Usage.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Examples/_Radius.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/Popover.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Arrow.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Colors.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/CustomStyles.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Offset.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Placements.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Radius.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Shadows.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Sizes.razor (1 hunks)
  • docs/LumexUI.Docs.Client/Pages/Components/Popover/PreviewCodes/Usage.razor (1 hunks)
  • src/LumexUI/Components/Button/LumexButton.razor.cs (1 hunks)
  • src/LumexUI/Components/Popover/LumexPopover.razor.cs (2 hunks)
  • src/LumexUI/Components/Popover/LumexPopoverContent.razor (2 hunks)
  • src/LumexUI/Components/Popover/LumexPopoverContent.razor.cs (2 hunks)
  • src/LumexUI/Components/Popover/LumexPopoverTrigger.razor (1 hunks)
  • src/LumexUI/Components/Popover/LumexPopoverTrigger.razor.cs (2 hunks)
  • src/LumexUI/Styles/Popover.cs (3 hunks)
  • tests/LumexUI.Tests/Components/Popover/PopoverTests.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 29, 2024

Codecov Report

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

Project coverage is 95.37%. Comparing base (19b89dc) to head (04a0e3f).
Report is 42 commits behind head on main.

Files with missing lines Patch % Lines
...UI/Components/Popover/LumexPopoverTrigger.razor.cs 66.67% 3 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #92      +/-   ##
==========================================
- Coverage   96.95%   95.37%   -1.58%     
==========================================
  Files          70       70              
  Lines        1542     1555      +13     
  Branches      150      148       -2     
==========================================
- Hits         1495     1483      -12     
- 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 8b46063 into main Oct 29, 2024
5 of 6 checks passed
@desmondinho desmondinho deleted the docs/popover branch October 29, 2024 20:28
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