Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/buschtoens/ember-collect-helper
Ember.computed.collect as a template helper
https://github.com/buschtoens/ember-collect-helper
ember ember-addon ember-helpers emberjs helper
Last synced: 3 months ago
JSON representation
Ember.computed.collect as a template helper
- Host: GitHub
- URL: https://github.com/buschtoens/ember-collect-helper
- Owner: buschtoens
- License: mit
- Created: 2017-07-19T07:44:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T20:13:28.000Z (about 1 year ago)
- Last Synced: 2024-10-10T12:42:09.294Z (3 months ago)
- Topics: ember, ember-addon, ember-helpers, emberjs, helper
- Language: JavaScript
- Homepage: https://buschtoens.github.io/ember-collect-helper/
- Size: 4.17 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-collect-helper
[](https://travis-ci.org/buschtoens/ember-collect-helper)
[](http://badge.fury.io/js/ember-collect-helper)
[](http://badge.fury.io/js/ember-collect-helper)
[](https://emberobserver.com/addons/ember-collect-helper)
[](https://greenkeeper.io/)
> [`Ember.computed.collect`][computed.collect] as a template helper
[computed.collect]: https://www.emberjs.com/api/ember/2.14/namespaces/Ember.computed/methods/collect?anchor=collect
## Installation
```
ember install ember-collect-helper
```
## Usage
For detailed documentation, please view the [API docs][docs].
You have to imagine `{{collect source paths}}` as the love child of
[`{{get}}`][helpers.get] and [`Ember.computed.collect`][computed.collect].
In its simplest form, you pass a `source` object and an array of `paths`.
`{{collect}}` will then return an array of the values from `source`. Just as if
you would have called `{{get source path}}` for every path of the `paths` array.
```hbs
{{collect
(hash
foo="bar"
quux="baz"
)
(array "quux" "foo")
}} => ['baz', 'bar']
```
The order you specified for `paths` is kept.
You can also access arbitrarily deeply nested properties:
```hbs
{{collect
(hash
foo="bar"
quux=(hash
quax="baz"
)
)
(array "quux.quax" "foo")
}} => ['baz', 'bar']
```
If a path is not defined, `null` will be inserted in its place:
```hbs
{{collect
(hash
foo="bar"
quux=(hash
quax="baz"
)
)
(array "quux.quax" "unknown" "foo")
}} => ['baz', null, 'bar']
```
If you want a `defaultValue` other than `null`, just specify it:
```hbs
{{collect
(hash
foo="bar"
quux=(hash
quax="baz"
)
)
(array "quux.quax" "unknown" "foo")
defaultValue="oh no!"
}} => ['baz', 'oh no!', 'bar']
```
To make `{{collect}}` a fully backwards compatible drop-in replacement for
`{{get}}`, you can also pass just a string for `paths` instead of an array of
strings.
```hbs
{{collect (hash foo="bar") "foo"}} => 'bar'
{{collect (hash foo="bar") (array "foo")}} => ['bar']
```
In that case, the helper will not return an array with one value, but rather
only the value itself, just like `{{get}}` would. This is especially useful,
when you're adding `{{collect}}` to an existing code base and only need its
capabilities in isolated cases, that you enable by passing an array of paths
instead of a single path.
If you want to force `{{collect}}` to return an array, you can pass `wrapSingular=true`.
```hbs
{{collect (hash foo="bar") "foo" wrapSingular=true}} => ['bar']
```
[docs]: https://buschtoens.github.io/ember-collect-helper/docs/classes/CollectHelper.html
[helpers.get]: https://www.emberjs.com/api/ember/2.14/classes/Ember.Templates.helpers/methods/get?anchor=get