Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 14, 2024

add composition support

Summary of the changes (Less than 80 chars)

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

Description

fixes #4826

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

Add composition event support to the Select component to fix issue #4826 and improve search input handling with debounce functionality.

Bug Fixes:

Enhancements:

  • Enhance the Select component by integrating debounce functionality for search input handling.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 14, 2024

Reviewer's Guide by Sourcery

This PR adds composition support to the Select component by implementing IME input handling and reorganizing the search functionality. The changes include debouncing search input, handling composition events, and restructuring the component's initialization and event handling.

Sequence diagram for Select component initialization

sequenceDiagram
    participant User
    participant SelectComponent
    participant JSInterop
    participant EventHandler

    User->>SelectComponent: Initialize Select
    SelectComponent->>JSInterop: Invoke init with options
    JSInterop->>EventHandler: Set up event listeners
    EventHandler->>SelectComponent: Handle input and composition events
Loading

Updated class diagram for Select component

classDiagram
    class SelectComponent {
        +Task InvokeInitAsync()
        +Task ConfirmSelectedItem(int index)
        +Task TriggerOnSearch(string searchText)
        -Task SearchTextChanged(string val)
        -ValueTask<ItemsProviderResult<SelectedItem>> LoadItems(ItemsProviderRequest request)
    }

    note for SelectComponent "Added TriggerOnSearch method for handling search input from JS"
    note for SelectComponent "Modified InvokeInitAsync to pass options object with callbacks"
Loading

File-Level Changes

Change Details Files
Implemented IME input handling for better international text input support
  • Added composition event handlers to track IME input state
  • Added debouncing to search input handling
  • Prevented search triggering during active composition
src/BootstrapBlazor/Components/Select/Select.razor.js
Restructured component initialization and event handling
  • Replaced single method parameter with options object for initialization
  • Added new JSInvokable method for search handling
  • Updated event cleanup in dispose method
src/BootstrapBlazor/Components/Select/Select.razor.js
src/BootstrapBlazor/Components/Select/Select.razor.cs
Simplified search input template structure
  • Moved search input outside of conditional blocks
  • Removed duplicate search input markup
  • Removed direct binding in favor of JS-based event handling
src/BootstrapBlazor/Components/Select/Select.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#4826 Add debounce handling for Chinese character input in the Select 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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 Dec 14, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 14, 2024
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 adding documentation explaining what composition support means and why it's needed for IME input in the PR description
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@ArgoZhang ArgoZhang merged commit 24fc677 into main Dec 14, 2024
2 of 3 checks passed
@ArgoZhang ArgoZhang deleted the fix-select branch December 14, 2024 10:00
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(Select): 选择器输入时,需增加防抖

2 participants