# ember-receive

> A teleporter there and back again!

Latest version **0.2.0** (published 2016-01-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install ember-receive
pnpm add ember-receive
yarn add ember-receive
bun add ember-receive
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2016-01-22 |
| First published | 2016-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ilya Radchenko |
| Maintainers | knownasilya |
| Keywords | ember-addon, teleport, portal, contextual components |

## Links

- npm: https://www.npmjs.com/package/ember-receive
- Repository: https://github.com/knownasilya/ember-receive
- Homepage: https://github.com/knownasilya/ember-receive#readme
- Issues: https://github.com/knownasilya/ember-receive/issues
- npm.io page: https://npm.io/package/ember-receive

## Dependencies (3)

- [ember-portal](https://npm.io/package/ember-portal.md) 0.0.5
- [ember-cli-babel](https://npm.io/package/ember-cli-babel.md) ^5.1.5
- [ember-cli-htmlbars](https://npm.io/package/ember-cli-htmlbars.md) ^1.0.1

## Recent versions

- 0.2.0 (latest) — 2016-01-22
- 0.1.0 — 2016-01-22
- 0.0.1 — 2016-01-22
- 0.0.0 — 2016-01-22

## README

# ember-receive

It's like a teleporter there and back again!

[![NPM][npm-badge-img]][npm-badge-link]
[![Build Status][travis-badge]][travis-badge-url]
[![Ember Observer Score][ember-observer-badge]][ember-observer-url]  
![Ember Version][ember-version]

```no-highlight
ember install ember-receive
```

There are many uses for `ember-receive`, but one of the main uses is to unblock blocked components. Let me show you.

```hbs
<!-- app/components/sidebar/template.hbs -->

{{#some-component data=model as |result|}}
  <!--
    You must use `result` here, or somehow pass it elsewhere
    ember-receive to the rescue!
  -->
  {{pass-to 'outside-area' result}}
{{/some-component}}
```

In another place:
```hbs
<!-- app/application/template.hbs -->

{{#receive-for 'outside-area' as |result send|}}
  <!-- do something with result -->
{{/receive-for}}
```

Check out the demo, `npm start` and `http://localhost:4200`.

## Advanced

```hbs
{{pass-to 'outside-area' (hash test=(component 'some-thing' name=name))}}
```

And consume:

```hbs
{{#receive-for 'outside-area' as |ui send|}}
  <!-- everything inside will be rendered where the data came from -->
  {{#send.back}}
    {{#ui.test something=data}}
      Block data
      {{different-component}}
    {{/ui.test}}
  {{/send.back}}
{{/receive-for}}
```

## API

### `pass-to`

* first parameter - Name of the source where the receiver can pick it up, this is required but doesn't have to be unique. String.
* second parameter - The data to pass to the source. This can be anything, primitive, object, array or a hash of contextual components.
* `blockTracking` - Prevent the receiver from sending back anything. Boolean, defaults to `false`.

### `receive-for`

* first parameter - Name of the source to reeive data from. Required.
* first yield - The data that is coming from the source.
* second yield - The send hash, which has one component at the moment:
  - `back` - The teleport back to sender, used in block form and has no parameters/attributes.
    This will not send back if the sender has set `blockTracking=true`.

Can also be used with an `else` block:

```hbs
{{#receive-for 'outer-rim' as |spaceships|}}
  <!-- spaceships here -->
{{else}}
  Lightspeed is too slow
{{/receive-for}}
```

[npm-badge-img]: https://badge.fury.io/js/ember-receive.svg
[npm-badge-link]: http://badge.fury.io/js/ember-receive
[travis-badge]: https://travis-ci.org/knownasilya/ember-receive.svg
[travis-badge-url]: https://travis-ci.org/knownasilya/ember-receive
[ember-observer-badge]: http://emberobserver.com/badges/ember-receive.svg
[ember-observer-url]: http://emberobserver.com/addons/ember-receive
[ember-version]: https://embadge.io/v1/badge.svg?start=2.3.0

---
_Source: https://npm.io/package/ember-receive · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._