From eab763c386902cb205901fad1807a115dd823172 Mon Sep 17 00:00:00 2001 From: Emil Tholin Date: Fri, 26 Apr 2019 21:55:42 +0200 Subject: [PATCH] Document how to remove a component.$on listener This PR documents how `component.$on` returns a function that removes the event listener when called. --- site/content/docs/03-run-time.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/site/content/docs/03-run-time.md b/site/content/docs/03-run-time.md index 843ac05e4c..0876cf3a36 100644 --- a/site/content/docs/03-run-time.md +++ b/site/content/docs/03-run-time.md @@ -573,10 +573,14 @@ component.$on(event, callback) Causes the `callback` function to be called whenever the component dispatches an `event`. +A function is returned that will remove the event listener when called. + ```js -app.$on('selected', event => { +const off = app.$on('selected', event => { console.log(event.detail.selection); }); + +off(); ``` #### `$destroy`