Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 27, 2024

reuse input composing function

Summary of the changes (Less than 80 chars)

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

Description

fixes #4970

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

Enhancements:

  • Reuse the input composing function in the select component.

@bb-auto bb-auto bot added the enhancement New feature or request label Dec 27, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 27, 2024
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 27, 2024

Reviewer's Guide by Sourcery

This PR refactors the Select component to reuse the input composing function.

Sequence diagram for input composition handling in Select component

sequenceDiagram
    participant User
    participant Select
    participant Input
    participant EventHandler

    Note over User,EventHandler: New implementation using Input module
    User->>Select: Type Chinese character
    Select->>Input: composition(search, callback)
    Input->>EventHandler: Register composition events
    User->>EventHandler: compositionstart
    EventHandler->>Input: Set isComposing = true
    User->>EventHandler: input event
    EventHandler->>Input: Check isComposing
    Note over Input: Skip callback if composing
    User->>EventHandler: compositionend
    EventHandler->>Input: Set isComposing = false
    Input->>Select: Execute callback with value
Loading

Class diagram showing refactored input handling

classDiagram
    class Select {
        -id: string
        -invoke: object
        -options: object
        +init(id, invoke, options)
        +show(id)
        +dispose(id)
    }

    class Input {
        +composition(el, callback)
        +dispose(el)
    }

    class EventHandler {
        +on(element, event, handler)
        +off(element, event)
    }

    Select --> Input : uses
    Select --> EventHandler : uses
    Input --> EventHandler : uses

    note for Input "Reusable input composition handling"
Loading

File-Level Changes

Change Details Files
Reused the input composing function in the Select component.
  • Moved the input composing logic from Select.razor.js to the shared input.js module.
  • Simplified the event handling in Select.razor.js by calling the Input.composition function.
  • Removed the isComposing flag and related event listeners from Select.razor.js.
  • Modified the Input.composition function to accept an element and a callback function as arguments.
  • Removed the Blazor invoke from the input module, making it a pure JavaScript module.
  • Improved the handling of composition events in the Input.composition function to prevent unnecessary calls to the callback function during composition.
  • Simplified the logic for handling composition events in the Input.composition function by removing the timeout and directly calling the callback function on compositionend.
src/BootstrapBlazor/Components/Select/Select.razor.js
src/BootstrapBlazor/wwwroot/modules/input.js

Assessment against linked issues

Issue Objective Addressed Explanation
#4970 Refactor the Select component to reuse the existing input composition handling function

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

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 27, 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 and they look great!

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.

This reverts commit b9f6deb.

# Conflicts:
#	src/BootstrapBlazor/BootstrapBlazor.csproj
@ArgoZhang
Copy link
Member Author

@sourcery-ai review

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 and they look great!

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 Dec 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b434bdb) to head (048ad0f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4971   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          630       630           
  Lines        28099     28099           
  Branches      4036      4036           
=========================================
  Hits         28099     28099           

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

@ArgoZhang ArgoZhang merged commit 42b321e into main Dec 27, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-search branch December 27, 2024 13:25
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.

refactor(Select): reuse input composing function

2 participants