feat: EphemeralController - an extendable base controller that can cl…

…eanly uninstall controllers/targets/classes/values from DOM elements

dist/index.d.ts

@@ -1,4 +1,5 @@
 export { BaseController } from "./utilities/base_controller";
+export { EphemeralController } from "./utilities/ephemeral_controller";
 export { AnchorSpyController } from "./controllers/anchor_spy_controller";
 export { AppearanceController } from "./controllers/utility/appearance_controller";
 export { AsyncBlockController } from "./controllers/async_block_controller";

docs/docs/controllers/ephemeral_controller.mdx

@@ -0,0 +1,40 @@
+---
+id: EphemeralController
+title: EphemeralController
+---
+
+
+## Purpose
+
+Provide a set of controller behaviours that allow a Stimulus controller to remove its own controllerisms (controllers, targets, actions, classes, values) from an element cleanly.
+
+## Methods
+
+This controller provides the following methods to sub-classes.
+
+| Name | Parameters | Purpose | Default |
+| --- | --- | --- | --- |
+| `cleanup` |  | Remove all identifiers related to this controller from an element. | |
+|  | `element` | The element to cleanup | |
+
+
+## How to Use
+
+```typescript
+import {EphemeralController} from "stimulus-library";
+
+export default class extends EphemeralController {
+  static targets = ["temp"];
+
+ removeTempTarget() {
+   if (this.hasTempTarget){
+    this.cleanup(this.tempTarget);
+   }
+ }
+
+ uninstallController() {
+    this.cleanup(this.el);
+ }
+
+}
+```

docs/sidebars.js

@@ -17,6 +17,7 @@ module.exports = {
       {
         "Extendable Controllers": [
           "controllers/BaseController",
+          "controllers/EphemeralController",
         ]
       },
       {

src/index.ts

@@ -1,5 +1,6 @@
 // Utilities
 export {BaseController} from "./utilities/base_controller";
+export {EphemeralController} from "./utilities/ephemeral_controller";
 
 // Controllers
 export {AnchorSpyController} from "./controllers/anchor_spy_controller";