adopted-ember-addons / adopted-ember-addons/ember-set-helper
Documentation around setting nested keys
- Langage dominant
- JavaScript
- Étoiles
- 69
- Forks
- 9
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
Have just spent about an hour trying to convert this:
```oninput={{action (mut this.creativeForForm.shareContent.shareCommentary.text) value="target.value"}}```
into this:
```{{on "input" (pick "target.value" (set this "creativeForForm.shareContent.shareCommentary.text"))}}```
I would have expected this to work per your docs, since the format generally appears to be `set thisContext "path" newValue`, though after a while it apparent that no examples of nested paths are actually provided in the docs. It says `dynamic paths can be provided`, but still sticks to the syntax of `set thisContext pathExpressedAsVariable`.
Eventually through trial and error, I discovered that
``` {{on "input" (pick "target.value" (set this.creativeForForm.shareContent.shareCommentary.text))}}```
works, although this is not documented at all (but is the same format as `mut` but this style isn't mentioned once in the docs). Given your API for everything else, I even would have expected
``` {{on "input" (pick "target.value" (set this.creativeForForm.shareContent.shareCommentary "text"))}}```
over the one that actually ended up working.
Would appreciate a callout added to the docs on how exactly setting nested paths should be achieved then as I don't want to be using an undocumented method if this is not stable. Thanks!
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Start by reading the existing documentation for the set helper and its dynamic-path examples. Document the supported syntax for setting nested paths, including the form shown in the issue, and clarify whether that usage is stable. Done means a newcomer can find an accurate nested-path example and understand the expected arguments.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100