fix(Tab): should not rerender tabitem after close #6294
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: Ockyd007 <[email protected]>
This reverts commit 25b6158.
Contributor
Reviewer's GuideThis PR prevents unintended rerendering of TabItems upon closing by stabilizing component keys, wrapping each TabItem in its own container with explicit keys and class names, and streamlining CSS and lookup logic. Class diagram for updated Tab and TabItemContent componentsclassDiagram
class Tab {
+List<TabItem> TabItems
+RenderTabItem(TabItem item)
+static GetTabItemClassString(TabItem item) string
}
class TabItemContent {
-Guid _key
+Render()
-RenderContent()
-BuildRenderTree(RenderTreeBuilder builder)
-RenderItemContent(RenderFragment? content)
}
Tab --> TabItemContent : uses
TabItemContent --> TabItem : uses
class TabItem {
+string Id
+bool IsActive
+RenderFragment? ChildContent
}
Flow diagram for TabItem rendering and rerender preventionflowchart TD
A[TabItems collection] -->|Find active| B[TabItem]
B --> C{IsActive?}
C -- Yes --> D[Wrap in div with key and class]
D --> E[RenderTabItem]
C -- No --> F[Skip or render with d-none class]
E --> G[TabItemContent]
G --> H[Render content with stable key]
H --> I[Display TabItem content]
F --> J[Hidden TabItem]
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![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 - here's some feedback:
- Regenerating a new Guid for
_keyon everyRender()will remount the content each cycle—if you only want to force a remount on close, consider updating_keyonly whenItem.IsActiveactually changes. - You’re using both
@key="@item"on the wrapper andbuilder.SetKey(_key)insideTabItemContent; choosing a single stable key (for example,item.Id) will simplify reconciliation and make the intent clearer. GetTabItemClassStringis declared to returnstring?but always returns a non-null string—removing the nullable annotation will better reflect its actual behavior.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Regenerating a new Guid for `_key` on every `Render()` will remount the content each cycle—if you only want to force a remount on close, consider updating `_key` only when `Item.IsActive` actually changes.
- You’re using both `@key="@item"` on the wrapper and `builder.SetKey(_key)` inside `TabItemContent`; choosing a single stable key (for example, `item.Id`) will simplify reconciliation and make the intent clearer.
- `GetTabItemClassString` is declared to return `string?` but always returns a non-null string—removing the nullable annotation will better reflect its actual behavior.
## Individual Comments
### Comment 1
<location> `src/BootstrapBlazor/Components/Tab/Tab.razor:36` </location>
<code_context>
foreach (var item in TabItems)
{
- @RenderTabItem(item)
+ <div @key="@item" id="@item.Id" class="@GetTabItemClassString(item)">
+ @RenderTabItem(item)
+ </div>
</code_context>
<issue_to_address>
Adding @key to the div may affect Blazor's diffing behavior.
If item is a complex object, property changes may not trigger updates as expected. Using a unique, stable value like item.Id as the key is recommended.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| foreach (var item in TabItems) | ||
| { | ||
| @RenderTabItem(item) | ||
| <div @key="@item" id="@item.Id" class="@GetTabItemClassString(item)"> |
Contributor
There was a problem hiding this comment.
suggestion: Adding @key to the div may affect Blazor's diffing behavior.
If item is a complex object, property changes may not trigger updates as expected. Using a unique, stable value like item.Id as the key is recommended.
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 #6271
fixes #6293
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Prevent tab items from re-rendering on close by stabilizing component keys and isolating content in wrapper divs.
Bug Fixes:
Enhancements: