consul

History

John Cowen 308e5a480e ui: Remove storybook, add docfy (#9831 ) This PR removes storybook and adds docfy and uses docfy to render our existing README files. This now means we can keep adding README documentation without committing any specific format or framework. If we eventually move to storybook then fine, or if we just want to remove docfy for whatever reason then fine - we will still have a full set of README files viewable via GitHub.		2021-03-08 12:22:01 +00:00
..
README.mdx	ui: Remove storybook, add docfy (#9831 )	2021-03-08 12:22:01 +00:00
index.hbs	…
index.js	…

README.mdx

## EventSource

```hbs
<EventSource
  @src={{eventSourceObject}}
  @onerror={{action 'error'}}
/>
```

### Arguments

| Argument | Type | Default | Description |
| --- | --- | --- | --- |
| `src` | `EventSourceProxy` | | An EventSource object |
| `onerror` | `Function` |  | The action to fire when an error occurs. Emits ErrorEvent object with an `error` property containing the Error. |
| `closeOnDestroy` | `Boolean` | true | Whether to close and destroy the event source when the component is destroyed |

This component is used to configure event source error from within a template, but also ensures that EventSources are cleaned/up destroyed when the user leaves the page (when the component is removed from the page)

### See

- [Component Source Code](./index.js)
- [Template Source Code](./index.hbs)

---