Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 12, 2025

add OnKeyUpAsync parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5315

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:

  • Added an OnKeyUpAsync parameter to the TextArea component. This parameter allows developers to specify a callback function that will be invoked when the user releases a key while the textarea is focused.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 12, 2025

Reviewer's Guide by Sourcery

This PR introduces an asynchronous callback for keyboard events by adding an OnKeyUpAsync parameter and updating the Textarea component to handle keyup events. The changes include parameter declaration, event binding, and method implementation for handling keys.

Sequence diagram for Textarea KeyUp event handling

sequenceDiagram
    participant Browser as Browser
    participant TA as Textarea

    Browser->>TA: KeyUp Event (KeyboardEventArgs)
    TA->>TA: OnKeyUp(KeyboardEventArgs)
    alt Key == "Enter"
        TA-->>TA: Invoke OnEnterAsync(Value)
    else Key == "Escape"
        TA-->>TA: Invoke OnEscAsync(Value)
    end
    alt OnKeyUpAsync present
        TA->>TA: await OnKeyUpAsync(KeyboardEventArgs)
    end
    TA-->>Browser: Event handled
Loading

Updated class diagram for Textarea component

classDiagram
    class Textarea {
      +bool IsAutoScroll
      +Func<KeyboardEventArgs,Task>? OnKeyUpAsync
      -async Task OnKeyUp(KeyboardEventArgs args)
      // Other existing properties and methods not shown
    }

    note for Textarea "Added asynchronous keyup callback support via OnKeyUpAsync and event binding"
Loading

File-Level Changes

Change Details Files
Added asynchronous keyboard event callback parameter
  • Declared the OnKeyUpAsync parameter in the Textarea code-behind
  • Included the necessary using directive for keyboard event handling
Textarea.razor.cs
Integrated keyup event handling in the Textarea component
  • Implemented the OnKeyUp method to handle Enter, Escape, and custom keyup events
  • Bound the @onkeyup event in the Textarea Razor file to the new OnKeyUp method
Textarea.razor.cs
Textarea.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5315 Support Enter key to send message in Textarea component
#5315 Implement Shift+Enter for creating a new line The PR does not explicitly handle Shift+Enter for creating a new line. It only adds an OnKeyUpAsync parameter and handles Enter and Escape key events.

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 12, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 12, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 12, 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 key check logic in OnKeyUp to a separate method for better readability.
  • It might be helpful to include a brief description of the intended use case for the OnKeyUpAsync parameter in the component's documentation.
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.

@codecov
Copy link

codecov bot commented Feb 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7b78b81) to head (3f5750d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5351   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29210     29212    +2     
  Branches      4124      4125    +1     
=========================================
+ Hits         29210     29212    +2     

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

@ArgoZhang ArgoZhang changed the title feat(TextArea): add OnKeyUpAsync parameter feat(TextArea): add UseShiftEnter parameter Feb 13, 2025
@ArgoZhang ArgoZhang merged commit a0fc459 into main Feb 13, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-textarea branch February 13, 2025 06:20
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(Textarea): support @OnEnterAsync

2 participants