docs(nuxt): explain stable keys in dynamic lists - #930
Open
MuslumYilmaz wants to merge 1 commit into
Open
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
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.
Documentation gap
The “Avoiding Hydration Mismatch” section already recommends deterministic
v-forkeys and warns against index-based keys for dynamic lists. It does notexplain an important distinction: an array index may be identical during the
initial server and client render, yet still represent the wrong logical item
after an insertion, removal, or reorder.
That can cause Vue to reuse component or DOM identity for a different item,
allowing local state, focus, or uncontrolled input values to appear on the
wrong row.
Proposed documentation change
Add a short explanation and a minimal before/after example:
:key="index"when the list can change order or membership.:key="item.id".initial item sequence and keys must still agree during hydration.
This would expand the existing recommendation without changing any Vuetify0
API or runtime behavior.
Optional reader exercise
For readers who want to reproduce the identity problem with insertion and
reordering, this focused exercise may be useful:
https://frontendatlas.com/vue/trivia/vue-v-for-keys-why-not-index
Disclosure: I maintain FrontendAtlas. The external exercise is optional and can
be omitted if the project prefers to keep the explanation self-contained.