Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 8, 2025

add OnClick event callback

Summary of the changes (Less than 80 chars)

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

Description

fixes #5321

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 OnClick and OnClickWithoutRender events to the Dropdown component.

New Features:

  • Added an OnClick event callback to the Dropdown component to allow custom logic to be executed when the dropdown button is clicked.
  • Added an OnClickWithoutRender event callback to the Dropdown component. This event is useful for scenarios where re-rendering the parent component is not desired after the click action.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 8, 2025

Reviewer's Guide by Sourcery

This PR adds support for OnClick event callbacks in the Dropdown component. It introduces new parameters and associated event handling logic in the component, updates the markup to integrate these changes, and modifies sample usage and documentation to reflect the new functionality.

Sequence diagram for Dropdown OnClick event callback

sequenceDiagram
    actor User
    participant Dropdown

    note over Dropdown: On button click triggers OnClickButton()
    User->>Dropdown: Clicks on dropdown button

    Dropdown->>Dropdown: if (OnClickWithoutRender != null)
    alt OnClickWithoutRender exists
        Dropdown->>Dropdown: await OnClickWithoutRender()
    end
    Dropdown->>Dropdown: if (OnClick.HasDelegate)
    alt OnClick delegate present
        Dropdown->>Dropdown: await OnClick.InvokeAsync()
    end
Loading

File-Level Changes

Change Details Files
Introduced OnClick and OnClickWithoutRender event parameters in the Dropdown component.
  • Added new parameters to accept OnClick (EventCallback) and OnClickWithoutRender (Func) in the component's C# code.
  • Implemented a new private method OnClickButton to handle click events by invoking the provided callbacks conditionally.
src/BootstrapBlazor/Components/Dropdown/Dropdown.razor.cs
Updated component markup to integrate the new click event handling functionality.
  • Replaced a static button with a DynamicElement in the Dropdown.razor to bind the OnClickButton event handler.
  • Configured DynamicElement with TriggerClick and OnClick attributes to support the new event callback.
src/BootstrapBlazor/Components/Dropdown/Dropdown.razor
Enhanced sample code and documentation to demonstrate the usage of the new event callbacks.
  • Updated sample events list in Dropdowns.razor.cs to include OnClick and OnClickWithoutRender event descriptions.
  • Modified sample usage in Dropdowns.razor to trigger the new event functionalities by adjusting ShowSplit usage.
  • Revised locale files (en-US and zh-CN) to support event description entries.
src/BootstrapBlazor.Server/Components/Samples/Dropdowns.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Dropdowns.razor
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5303 Enable developers to add @OnClick to the first button when ShowSplit='true'
#5303 Provide separate click events for split dropdown buttons similar to GitHub's Copilot 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 8, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 8, 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 forwarding the MouseEventArgs parameter to OnClick.InvokeAsync so that event handlers can access click details.
  • Review if invoking both OnClickWithoutRender and OnClick in sequence is intended and document the order if necessary.
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.


private string? ButtonText => IsFixedButtonText ? FixedButtonText : SelectedItem?.Text;

private async Task OnClickButton()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: Event callback handler signature may be missing MouseEventArgs parameter.

Since the OnClick parameter is of type EventCallback, consider updating OnClickButton to accept a MouseEventArgs parameter (e.g. OnClickButton(MouseEventArgs e)) and passing it to OnClick.InvokeAsync(e). This ensures that any event data provided by the underlying click event is not lost.

@ArgoZhang ArgoZhang merged commit c19f3ab into main Feb 8, 2025
2 of 3 checks passed
@ArgoZhang ArgoZhang deleted the feat-dropdown branch February 8, 2025 15:59
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(Dropdown): add OnClick parameter

2 participants