Skip to content

Commit

Permalink
Clarify the items in the each needing ids/keys (#446)
Browse files Browse the repository at this point in the history
* Clarify the items in the each needing ids/keys

Try to clarify that it is updating the DOM/components after deleting the last item.

For some reason, I read this as changing the array itself by removing the last item.

I suspect my changes need to be slimmed down and edited.

Yes, I am neuro-divergent. Why do you ask? 😃

* Apply suggestions from code review

---------

Co-authored-by: Rich Harris <[email protected]>
  • Loading branch information
docwhat and Rich-Harris authored Jan 23, 2024
1 parent 40b4205 commit 7bf2069
Showing 1 changed file with 9 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@
title: Keyed each blocks
---

By default, when you modify the value of an `each` block, it will add and remove items at the _end_ of the block, and update any values that have changed. That might not be what you want.
By default, when you modify the value of an `each` block, it will add and remove DOM nodes at the _end_ of the block, and update any values that have changed. That might not be what you want.

It's easier to show why than to explain. Click the 'Remove first thing' button a few times, and notice what happens: it does not remove the first `<Thing>` component, but rather the _last_ DOM node. Then it updates the `name` value in the remaining DOM nodes, but not the emoji, which is fixed when each `<Thing>` is created.
It's easier to show why than to explain. The `<Thing>` component sets the emoji as a constant on initialization, but the name is passed in via a prop.

Click the 'Remove first thing' button a few times, and notice what happens:

1. It removes the last component.
2. It then updates the `name` value in the remaining DOM nodes, but not the emoji, which is fixed when each `<Thing>` is created.

Instead, we'd like to remove only the first `<Thing>` component and its DOM node, and leave the others unaffected.

To do that, we specify a unique identifier (or "key") for the `each` block:
To do that, we specify a unique identifier (or "key") for each iteration of the `each` block:

```svelte
/// file: App.svelte
Expand All @@ -17,6 +22,6 @@ To do that, we specify a unique identifier (or "key") for the `each` block:
{/each}
```

Here, `(thing.id)` is the _key_, which tells Svelte how to figure out which DOM node to change when the component updates.
Here, `(thing.id)` is the _key_, which tells Svelte how to figure out what to update when the values (`name` in this example) change.

> You can use any object as the key, as Svelte uses a `Map` internally — in other words you could do `(thing)` instead of `(thing.id)`. Using a string or number is generally safer, however, since it means identity persists without referential equality, for example when updating with fresh data from an API server.

1 comment on commit 7bf2069

@vercel
Copy link

@vercel vercel bot commented on 7bf2069 Jan 23, 2024

Choose a reason for hiding this comment

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

Please sign in to comment.