emberjs/ember.js

Documentation for special values of key in each template helper

Open

#16719 opened on Jun 6, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (22,437 stars) (4,216 forks)batch import
DocumentationHelp Wanted

Description

Hello! I'm not sure if this is the right place for this but I wasn't sure where to ask. In the current documentation for the each template helper it talks about specifying keys but makes no mention of the special values for key, namely:

@index - The index of the item in the array. @item - The item in the array itself. This can only be used for arrays of strings or numbers. @guid - Generate a unique identifier for each object (uses Ember.guidFor).

Which I discovered in this comment

Are these special values actually still valid in 3.2? And if they are, is it alright if I write them back into the documentation?

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with Ember.js template helpers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The user needs to confirm the validity of special key values (@index, @item, @guid) mentioned in the forum comment (https://discuss.emberjs.com/t/new glimmer consideration each key/8128/9). The documentation should be added to the Ember.js API docs for the each helper. The issue requires a maintainer to respond and approve before proceeding. No linked PRs or files are mentioned.