Class Ember.Helper

public
Module: ember
Since: v1.13.0

Ember Helpers are functions that can compute values, and are used in templates. For example, this code calls a helper named format-currency:

1
<div>{{format-currency cents currency="$"}}</div>

Additionally, a helper can be called as a nested helper (sometimes called a subexpression). In this example, the computed value of a helper is passed to a component named show-money:

1
{{show-money amount=(format-currency cents currency="$")}}

Helpers defined using a class must provide a compute function. For example:

1
2
3
4
5
6
7
export default Ember.Helper.extend({
  compute(params, hash) {
    let cents = params[0];
    let currency = hash.currency;
    return `${currency}${cents * 0.01}`;
  }
});

Each time the input to a helper changes, the compute function will be called again.

As instances, these helpers also have access to the container and will accept injected dependencies.

Additionally, class helpers can call recompute to force a new computation.

If the output of your helper is only dependent on the current input, then you can use the Helper.helper function. See Ember.Helper.helper.

In this form the example above becomes:

1
2
3
4
5
export default Ember.Helper.helper((params, hash) => {
  let cents = params[0];
  let currency = hash.currency;
  return `${currency}${cents * 0.01}`;
});

Show:

Methods

Properties

No documented items

Events

No documented items