@loudy/lib 0.0.8 → 0.1.0

package/README.md

@@ -1,23 +1 @@
-# tsdown-starter
-
-A starter for creating a TypeScript package.
-
-## Development
-
-- Install dependencies:
-
-```bash
-npm install
-```
-
-- Run the unit tests:
-
-```bash
-npm run test
-```
-
-- Build the library:
-
-```bash
-npm run build
-```
+# a javascript library to do the boring part of webdev

package/dist/index.d.mts

@@ -5,22 +5,92 @@ type Signal<T> = {
   subscribe(fn: (value: T) => void): () => void;
 };
 declare function signal<T>(initialValue: T): Signal<T>;
-declare function computed<T>(fn: () => T): Signal<T>;
-declare function effect(fn: () => void): void;
+declare function effect<T>(signal: Signal<T>, fn: (value: T) => void): () => void;
 //#endregion
 //#region src/index.d.ts
 declare function $(elementOrFn: string | (() => void)): LoudLibElement | void | null;
 declare class LoudLibElement {
   constructor(element: Element);
   element: Element;
+  /**
+   * Allows for adding event listeners to elements
+   * @param event the event you want to listen to
+   * @param fn the handler for the event
+   */
   on(event: EventHandlers, fn: (e: Event) => void): this;
+  /**
+   * Allows for removing event listeners from elements
+   * @param event the event type
+   * @param fn this needs to be the exact same handler function as used in on()
+   */
+  off(event: EventHandlers, fn: (e: Event) => void): this;
+  /**
+   * Adds a class to an element
+   * @param className name of the class that should be added
+   */
   addClass(className: string): this;
+  /**
+   * removes a class from an element
+   * @param className name of the class you want to remove
+   */
+  removeClass(className: string): this;
+  /**
+   * toggles a class of an element
+   * @param className name of the class you want to toggle
+   */
+  toggleClass(className: string): this;
   hidden: boolean;
+  /**
+   * hides an element
+   */
   hide(): this;
+  /**
+   * shows an element
+   */
   show(): this;
+  /**
+   * toggles if an element is visible or not
+   */
   toggle(): this;
+  /**
+   * get/setter for the textContent of an element
+   * @example
+   * $(".text").text() // gets the textcontent
+   * @example
+   * $(".text").text("example") // sets the textcontent
+   */
   text(content?: string): string | this;
+  /**
+   * get/setter for the attributes of an element
+   * @example
+   * $(".img").attr("src") // gets the attribute
+   * @example
+   * $(".img").attr("src", "/image.png") // sets the attribute
+   */
+  attr(name: string, value?: string): string | this | null;
+  /**
+   * get/setter for the input of an input element
+   * @example
+   * $(".input").val() // gets the value
+   * @example
+   * $(".input").val("example") // sets the value
+   */
+  val(value?: string): string | this;
+  /**
+   * get/setter for the innerHtml of an element
+   * @example
+   * $(".img").html() // gets the innerHtml
+   * @example
+   * $(".img").html("<p>example</p>") // sets the innerHtml
+   */
+  html(content?: string): string | this;
+  /**
+   * removes the element
+   * @example
+   * $(".img").remove()
+   */
+  remove(): void;
 }
 type EventHandlers = { [K in Extract<keyof GlobalEventHandlers, `on${string}`>]: K extends `on${infer E}` ? E : never }[Extract<keyof GlobalEventHandlers, `on${string}`>];
 //#endregion
-export { $, LoudLibElement, Signal, computed, effect, signal };
+export { $, LoudLibElement, Signal, effect, signal };

package/dist/index.iife.js

@@ -0,0 +1 @@
+var loudlib=(function(e){function t(e){let t=e,n=new Set;return{get(){return t},set(e){t=e,n.forEach(e=>e(t))},subscribe(e){return n.add(e),e(t),()=>n.delete(e)}}}function n(e,t){return e.subscribe(t)}function r(e){if(typeof e==`function`){document.readyState===`loading`?document.addEventListener(`DOMContentLoaded`,e):e();return}let t=document.querySelector(e);return t?new i(t):null}var i=class{constructor(e){this.element=e}element;on(e,t){return this.element.addEventListener(e,t),this}off(e,t){return this.element.removeEventListener(e,t),this}addClass(e){return this.element.classList.add(e),this}removeClass(e){return this.element.classList.remove(e),this}toggleClass(e){return this.element.classList.toggle(e),this}hidden=!1;hide(){return this.element.style.display=`none`,this.hidden=!0,this}show(){return this.element.style.display=``,this.hidden=!1,this}toggle(){return this.hidden?this.show():this.hide(),this}text(e){return e===void 0?this.element.textContent:(this.element.textContent=e,this)}attr(e,t){return t===void 0?this.element.getAttribute(e):(this.element.setAttribute(e,t),this)}val(e){return e===void 0?this.element.value:(this.element.value=e,this)}html(e){return e===void 0?this.element.innerHTML:(this.element.innerHTML=e,this)}remove(){this.element.remove()}};return e.$=r,e.LoudLibElement=i,e.effect=n,e.signal=t,e})({});

package/dist/index.mjs

@@ -1 +1 @@
-function e(e){let t=e,n=new Set;return{get(){return t},set(e){t=e,n.forEach(e=>e(t))},subscribe(e){return n.add(e),e(t),()=>n.delete(e)}}}function t(t){return e(t())}function n(e){e()}function r(e){if(typeof e==`function`){document.readyState===`loading`?document.addEventListener(`DOMContentLoaded`,e):e();return}let t=document.querySelector(e);return t?new i(t):null}var i=class{constructor(e){this.element=e}element;on(e,t){return this.element.addEventListener(e,t),this}addClass(e){return this.element.classList.add(e),this}hidden=!1;hide(){return this.element.style.display=`none`,this.hidden=!0,this}show(){return this.element.style.display=``,this.hidden=!1,this}toggle(){return this.hidden?this.show():this.hide(),this}text(e){return e===void 0?this.element.textContent:(this.element.textContent=e,this)}};export{r as $,i as LoudLibElement,t as computed,n as effect,e as signal};
+function e(e){let t=e,n=new Set;return{get(){return t},set(e){t=e,n.forEach(e=>e(t))},subscribe(e){return n.add(e),e(t),()=>n.delete(e)}}}function t(e,t){return e.subscribe(t)}function n(e){if(typeof e==`function`){document.readyState===`loading`?document.addEventListener(`DOMContentLoaded`,e):e();return}let t=document.querySelector(e);return t?new r(t):null}var r=class{constructor(e){this.element=e}element;on(e,t){return this.element.addEventListener(e,t),this}off(e,t){return this.element.removeEventListener(e,t),this}addClass(e){return this.element.classList.add(e),this}removeClass(e){return this.element.classList.remove(e),this}toggleClass(e){return this.element.classList.toggle(e),this}hidden=!1;hide(){return this.element.style.display=`none`,this.hidden=!0,this}show(){return this.element.style.display=``,this.hidden=!1,this}toggle(){return this.hidden?this.show():this.hide(),this}text(e){return e===void 0?this.element.textContent:(this.element.textContent=e,this)}attr(e,t){return t===void 0?this.element.getAttribute(e):(this.element.setAttribute(e,t),this)}val(e){return e===void 0?this.element.value:(this.element.value=e,this)}html(e){return e===void 0?this.element.innerHTML:(this.element.innerHTML=e,this)}remove(){this.element.remove()}};export{n as $,r as LoudLibElement,t as effect,e as signal};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loudy/lib",
   "type": "module",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "library for various stuff.",
   "author": "loudsynth",
   "license": "MIT",