Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 6, 2025

support Debounce default value 200ms

Summary of the changes (Less than 80 chars)

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

Description

fixes #5307

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

New Features:

  • Set a default debounce time of 200ms for the AutoComplete and Search components if no debounce time is specified.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 6, 2025

Reviewer's Guide by Sourcery

This pull request introduces a default debounce time of 200ms to the Search component and AutoComplete component when no debounce value is explicitly provided.

Sequence diagram for Search component with debounced input handling

sequenceDiagram
    actor User
    participant UI as Search Component
    participant JS as JavaScript
    participant Server as Server

    User->>UI: Types in search box
    UI->>JS: Input event
    Note over JS: Wait for 200ms debounce
    JS->>Server: TriggerFilter(value)
    Server-->>UI: Return search results
    UI-->>User: Display results
Loading

Class diagram showing Search component modifications

classDiagram
    class Search {
        +string DisplayText
        +int Debounce
        +OnParametersSet()
        +OnSearch()
    }
    note for Search "Added default Debounce=200ms"
Loading

State diagram for Search input handling

stateDiagram-v2
    [*] --> Idle
    Idle --> Typing: User types
    Typing --> Debouncing: Input received
    Debouncing --> Searching: After 200ms
    Searching --> Idle: Results received
    note right of Debouncing: Default 200ms wait
    Typing --> Debouncing: More input
Loading

File-Level Changes

Change Details Files
Implemented a default debounce time of 200ms for the Search component when the Debounce parameter is not set.
  • Added a check in OnParametersSet to set Debounce to 200 if it is currently 0.
src/BootstrapBlazor/Components/Search/Search.razor.cs
Added a default debounce time of 200ms to the AutoComplete component when no debounce value is explicitly provided.
  • Modified the init function to use a default debounce of 200ms if duration is 0.
  • Created a filterCallback function to debounce the TriggerFilter method call.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js
Added Debounce parameter to the Search component in Searches.razor sample.
  • Added Debounce="200" to the Search component.
src/BootstrapBlazor.Server/Components/Samples/Searches.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5307 Support Debounce default value of 200ms for Search component

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 enhancement New feature or request label Feb 6, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 6, 2025
Copy link
Contributor

@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 extracting the default debounce value (200ms) into a shared constant or configuration rather than hard-coding it in both the C# and JS files. This minimizes duplication and simplifies future updates if the default ever needs to change.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 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.

@codecov
Copy link

codecov bot commented Feb 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d4adda1) to head (0e26d5e).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5308   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          643       643           
  Lines        28906     28910    +4     
  Branches      4109      4110    +1     
=========================================
+ Hits         28906     28910    +4     

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

@ArgoZhang ArgoZhang merged commit 61eefd1 into main Feb 6, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-search branch February 6, 2025 03:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Search): support Debounce default value 200ms

2 participants