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

fix(DateTimeRange): should be reset Value after close pop-up #5413

Merged
merged 8 commits into from
Feb 21, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 21, 2025

should be reset Value after close pop-up

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5383

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Fixes an issue where the DateTimeRange component was not properly resetting its value after the popup was closed. This is achieved by adding a JavaScript callback function that is triggered when the popup is closed, and then resetting the component's value.

Bug Fixes:

  • Fixes an issue where the DateTimeRange component was not properly resetting its value after the popup was closed.

Enhancements:

  • Adds a JavaScript callback function to the DateTimePicker and DateTimeRange components that is triggered when the popup is closed.
  • The DateTimeRange component now resets its body value when the popup is closed.

Tests:

  • Adds a unit test for the TriggerHideCallback method in the DateTimePicker component.

Copy link

sourcery-ai bot commented Feb 21, 2025

Reviewer's Guide by Sourcery

This PR fixes issue #5383 by adding a callback to reset the DateTimeRange and DateTimePicker components when the pop-up is closed. This ensures that the component's value is properly reset after the pop-up is closed.

Sequence diagram for DateTimeRange pop-up close

sequenceDiagram
    participant JS
    participant DateTimeRange

    JS->>DateTimeRange: Pop-up closed
    activate DateTimeRange
    DateTimeRange->>DateTimeRange: TriggerHideCallback()
    DateTimeRange->>DateTimeRange: ResetBodyValue()
    DateTimeRange->>DateTimeRange: StateHasChanged()
    deactivate DateTimeRange
Loading

Sequence diagram for DateTimePicker pop-up close

sequenceDiagram
    participant JS
    participant DateTimePicker

    JS->>DateTimePicker: Pop-up closed
    activate DateTimePicker
    DateTimePicker->>DateTimePicker: TriggerHideCallback()
    DateTimePicker->>DateTimePicker: StateHasChanged()
    deactivate DateTimePicker
Loading

File-Level Changes

Change Details Files
Added a TriggerHideCallback method to DateTimeRange and DateTimePicker components to reset the component's value when the pop-up is closed.
  • Added TriggerHideCallback method decorated with JSInvokable attribute.
  • Added javascript call to TriggerHideCallback when the popover is closed.
src/BootstrapBlazor/Components/DateTimeRange/DateTimeRange.razor.cs
src/BootstrapBlazor/Components/DateTimePicker/DateTimePicker.razor.cs
src/BootstrapBlazor/wwwroot/modules/base-popover.js
src/BootstrapBlazor/Components/DateTimePicker/DateTimePicker.razor.js
Added a unit test for the TriggerHideCallback method in DateTimePicker.
  • Added TriggerHideCallback_Ok test method to verify the functionality of the TriggerHideCallback method.
test/UnitTest/Components/DateTimePickerTest.cs
Ensured that the javascript module is correctly loaded for DateTimeRange and DateTimePicker components.
  • Added JSObjectReference = true to the BootstrapModuleAutoLoader attribute.
src/BootstrapBlazor/Components/DateTimePicker/DateTimePicker.razor
src/BootstrapBlazor/Components/DateTimeRange/DateTimeRange.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5383 When the DateTimeRange component loses focus without clicking 'Ok', the selected range should revert to the Value property.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the bug Something isn't working label Feb 21, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 21, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 21, 2025
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider debouncing the StateHasChanged call in TriggerHideCallback to avoid excessive re-rendering.
  • The javascript file DateTimePicker/DateTimePicker.razor.js was copied instead of creating a new one for DateTimeRange.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

codecov bot commented Feb 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c45b44c) to head (a9fdc88).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5413   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29330     29350   +20     
  Branches      4129      4129           
=========================================
+ Hits         29330     29350   +20     

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

@ArgoZhang ArgoZhang enabled auto-merge (squash) February 21, 2025 02:48
@ArgoZhang
Copy link
Collaborator Author

@sourcecy-ai review

@ArgoZhang ArgoZhang disabled auto-merge February 21, 2025 02:54
@ArgoZhang ArgoZhang merged commit 1a219dc into main Feb 21, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-range branch February 21, 2025 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug(DateTimeRange): Visible selected range is kept after closing the component by losing focus
1 participant