feat(Table): add AutoSearchOnInput parameter #6306
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: Jaders77 <[email protected]>
Contributor
Reviewer's GuideThis PR adds an AutoSearchOnInput flag to the Table component so that searches fire automatically on each input change, refactors the search input markup to use explicit Value/OnValueChanged handlers with the new UseInputEvent setting, implements the corresponding change handler to trigger searches programmatically, and updates the unit tests to cover the new behavior. Sequence diagram for search triggering with AutoSearchOnInputsequenceDiagram
participant User as actor User
participant Table as Table<TItem>
participant BootstrapInput
User->>BootstrapInput: types in search box
BootstrapInput-->>Table: OnValueChanged (if AutoSearchOnInput=true)
Table->>Table: OnSearchTextValueChanged(value)
Table->>Table: SearchClick()
Table-->>User: Updates search results
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces the AutoSearchOnInput parameter to enable automatic search triggering when input values change, addressing issue #6283. The key changes include:
- Converting the OnSearchKeyUp test method to asynchronous and adding a change event simulation.
- Adding the AutoSearchOnInput parameter with accompanying documentation in Table.razor.cs.
- Implementing a new OnSearchTextValueChanged method to trigger searches on input change and updating the BootstrapInput components accordingly.
- Bumping the project version in the csproj file.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/UnitTest/Components/TableTest.cs | Updated test method to async form and simulated additional change. |
| src/BootstrapBlazor/Components/Table/Table.razor.cs | Added AutoSearchOnInput parameter with documentation. |
| src/BootstrapBlazor/Components/Table/Table.razor.Search.cs | Introduced OnSearchTextValueChanged to trigger search on input change. |
| src/BootstrapBlazor/Components/Table/Table.razor | Modified input components to use OnValueChanged and UseInputEvent. |
| src/BootstrapBlazor/BootstrapBlazor.csproj | Incremented project version. |
Comments suppressed due to low confidence (1)
test/UnitTest/Components/TableTest.cs:392
- Consider adding a separate test case where AutoSearchOnInput is enabled to verify that the search is automatically triggered upon input changes.
pb.Add(a => a.AutoSearchOnInput, false);
| /// <returns></returns> | ||
| protected List<IFilterAction> GetSearches() => Columns.Where(col => col.GetSearchable()).ToSearches(SearchText); | ||
|
|
||
| private async Task OnSearchTextValueChanged(string? value) |
There was a problem hiding this comment.
Since OnSearchTextValueChanged triggers a search on every input change when AutoSearchOnInput is enabled, consider debouncing the invocation of SearchClick to mitigate potential performance issues during rapid input.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes and they look great!
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6306 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 714 714
Lines 31452 31457 +5
Branches 4438 4438
=========================================
+ Hits 31452 31457 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #6283
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Add a new AutoSearchOnInput parameter to the Table component to enable automatic searches when the user types by wiring the search inputs to use Value/OnValueChanged with an InputEvent binding and invoking the search handler on input change.
New Features:
Enhancements:
Tests: