OLD | NEW |
1 iron-signals | 1 iron-signals |
2 ============ | 2 ============ |
3 | 3 |
4 `iron-signals` provides basic publish-subscribe functionality. | 4 `iron-signals` provides basic publish-subscribe functionality. |
5 | 5 |
6 Note: avoid using `iron-signals` whenever you can use | 6 Note: avoid using `iron-signals` whenever you can use |
7 a controller (parent element) to mediate communication | 7 a controller (parent element) to mediate communication |
8 instead. | 8 instead. |
9 | 9 |
10 To send a signal, fire a custom event of type `iron-signal`, with | 10 To send a signal, fire a custom event of type `iron-signal`, with |
11 a detail object containing `name` and `data` fields. | 11 a detail object containing `name` and `data` fields. |
12 | 12 |
13 ```javascript | 13 ```javascript |
14 this.fire('iron-signal', {name: 'hello', data: null}); | 14 this.fire('iron-signal', {name: 'hello', data: null}); |
15 ``` | 15 ``` |
16 | 16 |
17 To receive a signal, listen for `iron-signal-<name>` event on a | 17 To receive a signal, listen for `iron-signal-<name>` event on a |
18 `iron-signals` element. | 18 `iron-signals` element. |
19 | 19 |
20 ```html | 20 ```html |
21 <iron-signals on-iron-signal-hello="{{helloSignal}}"> | 21 <iron-signals on-iron-signal-hello="{{helloSignal}}"> |
22 ``` | 22 ``` |
23 | 23 |
24 You can fire a signal event from anywhere, and all | 24 You can fire a signal event from anywhere, and all |
25 `iron-signals` elements will receive the event, regardless | 25 `iron-signals` elements will receive the event, regardless |
26 of where they are in DOM. | 26 of where they are in DOM. |
OLD | NEW |