Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(MultiSelect): update OnEditCallback sample code #5101

Merged
merged 2 commits into from
Jan 12, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 12, 2025

update OnEditCallback sample code

Summary of the changes (Less than 80 chars)

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

Description

fixes #5100 #5067

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

Documentation:

  • Update the MultiSelect component documentation with an example of how to use the OnEditCallback parameter.

Copy link

sourcery-ai bot commented Jan 12, 2025

Reviewer's Guide by Sourcery

This PR updates the OnEditCallback sample code in the MultiSelects component to demonstrate the functionality of adding new items to the list when the user types in a value that is not already present. It also removes unused loggers and variables.

Sequence diagram for MultiSelect OnEditCallback flow

sequenceDiagram
    actor User
    participant MS as MultiSelect
    participant CB as OnEditCallback
    participant Items as EditableItems

    User->>MS: Enter new value
    MS->>CB: Call OnEditCallback(value)
    CB->>Items: Search for existing item
    alt Item exists
        Items-->>CB: Return existing item
    else Item does not exist
        CB->>Items: Create new item
        Items-->>CB: Return new item
    end
    CB-->>MS: Return selected item
    MS-->>User: Update display
Loading

File-Level Changes

Change Details Files
Updated the MultiSelects component to use the OnEditCallback parameter.
  • Added OnEditCallback parameter to the MultiSelect component.
  • Implemented the OnEditCallback function to handle new items.
  • Bound the MultiSelect component's value to a new variable _editString.
  • Added a Display component to show the selected value.
  • Removed unused loggers and variables from the component.
  • Updated the sample code to use the EditSubmitKey.Enter value for the EditSubmitKey parameter.
  • Added a new SelectedItem to the EditableItems list if the entered value doesn't exist.
  • Set the maximum number of selectable items to 2 using the Max parameter.
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.cs
Removed unused loggers and variables.
  • Removed the OptionLogger from the MultiSelects.razor component.
  • Removed the OptionLogger variable from the MultiSelects.razor.cs file.
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5100 Update the OnEditCallback sample code for MultiSelect 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 documentation Improvements or additions to documentation label Jan 12, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 12, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 12, 2025 13:39
Copy link

@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: 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 linked an issue Jan 12, 2025 that may be closed by this pull request
1 task
Copy link

codecov bot commented Jan 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ae7d91b) to head (1f0b7d6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5101   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          633       633           
  Lines        28136     28136           
  Branches      4036      4036           
=========================================
  Hits         28136     28136           

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

@ArgoZhang ArgoZhang merged commit 6f491d7 into main Jan 12, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-multi branch January 12, 2025 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(MultiSelect): update OnEditCallback sample code feat(MultiSelect): add IsEditable parameter
1 participant