| Index: third_party/polymer/v0_8/components-chromium/iron-signals/README.md
|
| diff --git a/third_party/polymer/v0_8/components-chromium/iron-signals/README.md b/third_party/polymer/v0_8/components-chromium/iron-signals/README.md
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..fe82ffd967b8197628763f1ea03ecb9ee08c86af
|
| --- /dev/null
|
| +++ b/third_party/polymer/v0_8/components-chromium/iron-signals/README.md
|
| @@ -0,0 +1,26 @@
|
| +iron-signals
|
| +============
|
| +
|
| +`iron-signals` provides basic publish-subscribe functionality.
|
| +
|
| +Note: avoid using `iron-signals` whenever you can use
|
| +a controller (parent element) to mediate communication
|
| +instead.
|
| +
|
| +To send a signal, fire a custom event of type `iron-signal`, with
|
| +a detail object containing `name` and `data` fields.
|
| +
|
| +```javascript
|
| +this.fire('iron-signal', {name: 'hello', data: null});
|
| +```
|
| +
|
| +To receive a signal, listen for `iron-signal-<name>` event on a
|
| +`iron-signals` element.
|
| +
|
| +```html
|
| +<iron-signals on-iron-signal-hello="{{helloSignal}}">
|
| +```
|
| +
|
| +You can fire a signal event from anywhere, and all
|
| +`iron-signals` elements will receive the event, regardless
|
| +of where they are in DOM.
|
|
|