feat: onDestroy life-cycle hook

README.md

@@ -21,6 +21,7 @@ The result is a reactive UI on property changes.
     1. [`onInit`](#oninit) - the component is connected to the DOM, before view is initialized
     1. [`afterViewInit`](#afterviewinit) - after the view is first initialized
     1. [`onChanges`](#onchanges) - every time an attribute value changes
+    1. [`onDestroy`]()
 
 ## Import via unpkg
 Import using [unpkg](https://unpkg.com/web-component-base) in your vanilla JS component. We will use this in the rest of our [usage examples](#usage).
@@ -136,8 +137,8 @@ Here is an example of using a custom element in a single .html file:
 Define behavior when certain events in the component's life cycle is triggered by providing hook methods
 
 ### onInit()
-- triggered when the component is connected to the DOM
+- Triggered when the component is connected to the DOM
-- best for setting up the component
+- Best for setting up the component
 
 ```js
 import WebComponent from "https://unpkg.com/web-component-base/index.js";
@@ -155,7 +156,8 @@ class ClickableText extends WebComponent {
 ```
 
 ### afterViewInit()
-- triggered after the view is first initialized
+- Triggered after the view is first initialized
+
 
 ```js
 class ClickableText extends WebComponent {
@@ -171,8 +173,40 @@ class ClickableText extends WebComponent {
 }
 ```
 
+### onDestroy()
+- Triggered when the component is disconnected from the DOM
+- best for undoing any setup done in `onInit()`
+
+```js
+import WebComponent from "https://unpkg.com/web-component-base/index.js";
+
+class ClickableText extends WebComponent {
+ 
+  clickCallback() {
+    console.log(">>> click!");
+  }
+
+  onInit() {
+    this.onclick = this.clickCallback;
+  }
+
+  onDestroy() {
+    console.log(">>> removing event listener");
+    this.removeEventListener("click", this.clickCallback);
+  }
+
+  get template() {
+    return `<span style="cursor:pointer">Click me!</span>`;
+  }
+}
+```
+
+
+
+
+
 ### onChanges()
-- triggered when an attribute value changed
+- Triggered when an attribute value changed
 
 ```js
 import WebComponent from "https://unpkg.com/web-component-base/index.js";

demo/SimpleText.mjs

@@ -3,8 +3,16 @@
 import WebComponent from "../src/index.js";
 
 class SimpleText extends WebComponent {
+  clickCallback() {
+    console.log(">>> click!");
+  }
   onInit() {
-    this.onclick = () => console.log(">>> click!");
+    this.onclick = this.clickCallback;
+  }
+
+  onDestroy() {
+    console.log(">>> removing event listener");
+    this.removeEventListener("click", this.clickCallback);
   }
 
   get template() {

demo/index.html

@@ -20,6 +20,10 @@
       helloWorld.addEventListener("click", () => {
         helloWorld.setAttribute("name", "Clicked");
       });
+      const clickableText = document.querySelector("simple-text");
+      setTimeout(() => {
+        clickableText.remove();
+      }, 2000);
     </script>
   </body>
 </html>

src/WebComponent.js

@@ -18,15 +18,20 @@ export class WebComponent extends HTMLElement {
   }
 
   /**
-   * triggered after view is initialized
+   * Triggered after view is initialized
    */
   afterViewInit() {}
 
   /**
-   * triggered when the component is connected to the DOM
+   * Triggered when the component is connected to the DOM
    */
   onInit() {}
 
+  /**
+   * Triggered when the component is disconnected from the DOM
+   */
+  onDestroy() {}
+
   /**
    * @param {{'property': string, 'previousValue': any, 'currentValue': any}} changes
    */
@@ -38,6 +43,10 @@ export class WebComponent extends HTMLElement {
     this.afterViewInit();
   }
 
+  disconnectedCallback() {
+    this.onDestroy();
+  }
+
   /**
    * @param {string} property
    * @param {any} previousValue