solid-ctrl-flow 5.0.1 → 5.1.1

package/dist/index.d.ts

@@ -6,6 +6,12 @@ import { Owner } from 'solid-js';
 import { ParentProps } from 'solid-js';
 import { splitProps } from 'solid-js';
 
+/** Minimal representation of an event target */
+declare type AbstractEventTarget<K, F> = {
+    addEventListener(k: K, f: F): void;
+    removeEventListener(k: K, f: F): void;
+};
+
 /** Like a {@link Match} but gets the value from the closest {@link On} ancestor */
 export declare function Case(props: ParentProps<{
     value: unknown;
@@ -151,6 +157,16 @@ export declare class OrderedLinkedListNode<T> extends OrderedLinkedList<T> {
     remove(): void;
 }
 
+/**
+ * Adds the {@link f} event listener to the {@link k} event of the {@link obj} emitter and removes it when the current reactive context is disposed
+ * @param obj The emitter to which to add the event listener
+ * @param k The key of the event for which to add the listener
+ * @param f The function to call when the event is emitted
+ */
+export declare function registerEventListener<K extends keyof HTMLElementEventMap>(obj: HTMLElement, type: K, listener: (this: HTMLElement, e: HTMLElementEventMap[K]) => any): void;
+
+export declare function registerEventListener<K, F>(obj: AbstractEventTarget<K, F>, k: K, f: F): void;
+
 /**
  * Executes {@link f} with the provided value for the specified {@link Context}.
  * You can pass `undefined` to {@link value} in order to get back the default value for {@link ctx}.

package/dist/index.mjs

@@ -1,8 +1,12 @@
-import { untrack, createRoot, getOwner, createMemo, Show, createContext, useContext, onCleanup, For, createRenderEffect, on, splitProps, createSignal, createSelector, equalFn, Match, runWithOwner } from "solid-js";
+import { untrack, onCleanup, createRoot, getOwner, createMemo, Show, createContext, useContext, For, createRenderEffect, on, splitProps, createSignal, createSelector, equalFn, Match, runWithOwner } from "solid-js";
 import { createComponent, memo, mergeProps, spread } from "solid-js/web";
 function untrackCall(f, ...args) {
   return untrack(() => f.apply(this, args));
 }
+function registerEventListener(obj, k, f) {
+  obj.addEventListener(k, f);
+  onCleanup(() => obj.removeEventListener(k, f));
+}
 function runWithContext(ctx2, value, f) {
   return createRoot((d) => {
     try {
@@ -270,6 +274,7 @@ export {
   SameContext,
   Spread,
   memoProps,
+  registerEventListener,
   runWithContext,
   splitAndMemoProps,
   untrackCall,

package/dist/index.umd.js

@@ -5,6 +5,10 @@
   function untrackCall(f, ...args) {
     return solidJs.untrack(() => f.apply(this, args));
   }
+  function registerEventListener(obj, k, f) {
+    obj.addEventListener(k, f);
+    solidJs.onCleanup(() => obj.removeEventListener(k, f));
+  }
   function runWithContext(ctx2, value, f) {
     return solidJs.createRoot((d) => {
       try {
@@ -271,6 +275,7 @@
   exports2.SameContext = SameContext;
   exports2.Spread = Spread;
   exports2.memoProps = memoProps;
+  exports2.registerEventListener = registerEventListener;
   exports2.runWithContext = runWithContext;
   exports2.splitAndMemoProps = splitAndMemoProps;
   exports2.untrackCall = untrackCall;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-ctrl-flow",
-  "version": "5.0.1",
+  "version": "5.1.1",
   "description": "Control flow components for solid-js",
   "author": "AFatNiBBa",
   "license": "ISC",

package/readMe.md

@@ -233,5 +233,8 @@ Like `splitProps()` but passes the every part except the last one to [`memoProps
 ### `untrackCall()`
 Calls a function untracking what happens inside of it but not what gets passed as its argument
 
+### `registerEventListener()`
+Adds an event listener and registers its removal
+
 ### `runWithContext()`
 Creates a context scope that persists for the duration of a function