Skip to content

Correct OnDismiss event calling in BitModal component (#10016)#10017

Merged
msynk merged 3 commits intobitfoundation:developfrom
msynk:10016-blazorui-modal-ondismiss
Feb 22, 2025
Merged

Correct OnDismiss event calling in BitModal component (#10016)#10017
msynk merged 3 commits intobitfoundation:developfrom
msynk:10016-blazorui-modal-ondismiss

Conversation

@msynk
Copy link
Member

@msynk msynk commented Feb 22, 2025

closes #10016

Summary by CodeRabbit

  • Bug Fixes
    • Improved modal dismissal behavior to ensure modals close consistently by triggering the dismiss callback in a unified manner. This change provides a smoother and more predictable experience when dismissing modals.

@msynk msynk requested a review from yasmoradi February 22, 2025 14:16
@coderabbitai
Copy link

coderabbitai bot commented Feb 22, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes update the modal component by introducing a new private method OnSetIsOpen that centralizes the dismissal logic. A [CallOnSet] attribute is added to the IsOpen property so that whenever the property is set to false, OnSetIsOpen is invoked, triggering the OnDismiss callback from the modal parameters. Additionally, the overlay click handler has been adjusted to remove redundant dismissal invocation, ensuring a single, unified control flow for closing the modal.

Changes

File Summary
src/BlazorUI/…/BitModal.razor.cs Added OnSetIsOpen method, updated IsOpen property with [CallOnSet(nameof(OnSetIsOpen))], and modified the overlay click handler to remove direct dismissal calls.

Sequence Diagram(s)

sequenceDiagram
    participant UI as UI Interaction
    participant Modal as BitModal Component
    participant Callback as ModalParameters.OnDismiss

    UI->>Modal: Set IsOpen = false
    Modal-->>Modal: Invoke OnSetIsOpen()
    Modal->>Callback: Execute OnDismiss() if IsOpen is false
Loading

Poem

In code fields under the moon’s light,
I hopped to greet a change so bright.
When IsOpen dims, a call reveals,
The dismissal action that simply feels.
A rabbit cheers with nimble delight! 🐇✨


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10799cf and 41be528.

📒 Files selected for processing (1)
  • src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Modal/BitModal.razor.cs (2 hunks)
🔇 Additional comments (2)
src/BlazorUI/Bit.BlazorUI/Components/Surfaces/Modal/BitModal.razor.cs (2)

83-85: LGTM! Good use of [CallOnSet] to centralize dismissal logic.

The addition of [CallOnSet] ensures consistent behavior by automatically triggering OnDismiss whenever the modal is closed, regardless of how IsOpen is set to false.


211-220:

Details

✅ Verification successful

Verify the removal of OnDismiss from HandleOnOverlayClick.

The changes correctly remove the direct OnDismiss invocation from HandleOnOverlayClick, as it's now handled through OnSetIsOpen when IsOpen is set to false. This eliminates potential duplicate calls to OnDismiss.

Run the following script to ensure there are no remaining direct calls to OnDismiss:


🏁 Script executed:

#!/bin/bash
# Description: Search for direct invocations of OnDismiss
# Expect: Only OnSetIsOpen should invoke OnDismiss

rg "OnDismiss.InvokeAsync" -A 2 -B 2

Length of output: 4700


Direct OnDismiss Call Removed from HandleOnOverlayClick

The update successfully eliminates the direct invocation of OnDismiss.InvokeAsync from the HandleOnOverlayClick method in BitModal.razor.cs, ensuring that dismissal is now uniformly handled through the centralized OnSetIsOpen logic. Our search confirms that while other components continue to use OnDismiss.InvokeAsync as part of their dismissal flow, the modal component under review no longer misfires this event via the overlay click.

  • BitModal.razor.cs: The HandleOnOverlayClick method has been updated to remove the direct call to OnDismiss.InvokeAsync.
  • Remaining calls to OnDismiss.InvokeAsync in the central dismissal logic (and in other components) appear intentional and consistent with the design improvements.

Overall, the changes align with the PR objectives by eliminating duplicate invocation and centralizing the dismissal behavior.

@msynk msynk merged commit b158b46 into bitfoundation:develop Feb 22, 2025
2 checks passed
@msynk msynk deleted the 10016-blazorui-modal-ondismiss branch February 22, 2025 15:48
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.

The OnDismiss event in the BitModal component is not getting called correctly

2 participants