Skip to content
This repository was archived by the owner on Aug 5, 2025. It is now read-only.
This repository was archived by the owner on Aug 5, 2025. It is now read-only.

#each documentation should be more helpful and direct about keys #392

@zzolo

Description

@zzolo

The current documentation for {#each} block only mentions keyed each blocks as a note. To me, this is a serious problem, since not using a key in many cases causes broken/unexpected results when the state/data is updated.

I think the following should happen:

  • The keyed documentation should be included in the #each block documentation
  • There should be clear documentation about how not using a key can lead to unexpected behavior, and is basically necessary for updating data
  • (optional) The prime example for the documentation should involve keys, and the later example can talk about how not using a key can be more performant but may lead to unexpected results.

References:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions