Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 13, 2025

support OnEnteryAsync/OnEscAsync parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5356

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 OnEnterAsync and OnEscAsync parameters to the TextArea component.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 13, 2025

Reviewer's Guide by Sourcery

This PR introduces asynchronous event support for the TextArea component by adding OnEnterAsync and OnEscAsync parameters. The implementation includes updating sample pages to demonstrate the new key event functionality, adjusting component attributes for proper JS interop, and minor locale updates.

Sequence diagram for TextArea async key events

sequenceDiagram
    actor User
    participant TextArea
    participant SampleComponent
    participant ConsoleLogger

    User->>TextArea: Press Enter key
    TextArea->>SampleComponent: Invoke OnEnterAsync(val)
    SampleComponent->>ConsoleLogger: Log "Trigger Enter Key Event"

    User->>TextArea: Press Esc key
    TextArea->>SampleComponent: Invoke OnEscAsync(val)
    SampleComponent->>ConsoleLogger: Log "Trigger Esc Key Event"
Loading

Updated class diagram for TextAreas sample component

classDiagram
    class TextAreasSampleComponent {
      +ConsoleLogger ConsoleLogger
      +Task OnEnterAsync(string val)
      +Task OnEscAsync(string val)
      +void MockChat()
    }

    class ConsoleLogger {
      +void Log(string message)
    }

    TextAreasSampleComponent --> ConsoleLogger : uses
Loading

File-Level Changes

Change Details Files
Added asynchronous key event handlers for TextArea component.
  • Implemented OnEnterAsync and OnEscAsync methods in the sample code to log key events.
  • Updated TextArea sample page to invoke these async handlers on key events.
  • Integrated a ConsoleLogger component to display key event logs.
src/BootstrapBlazor.Server/Components/Samples/TextAreas.razor.cs
src/BootstrapBlazor.Server/Components/Samples/TextAreas.razor
Modified component attribute for improved JavaScript interop support.
  • Updated the BootstrapModuleAutoLoader attribute on the Textarea component to include the JSObjectReference parameter.
src/BootstrapBlazor/Components/Textarea/Textarea.razor
Performed localization adjustments for new demo content.
  • Updated the en-US and zh-CN locale files to provide text for the new key event demo.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5356 Support OnEnteryAsync parameter for TextArea component
#5356 Support OnEscAsync parameter for TextArea 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 13, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 13, 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 adding a debounce to the OnEnterAsync and OnEscAsync events to prevent excessive calls.
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 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (07a3944) to head (b228413).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5357   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29212     29212           
  Branches      4125      4125           
=========================================
  Hits         29212     29212           

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

@ArgoZhang ArgoZhang merged commit 56e3600 into main Feb 13, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-textarea branch February 13, 2025 10:52
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 OnEnteryAsync/OnEscAsync parameter

2 participants