@ulu/frontend 0.1.0-beta.8 → 0.1.0-beta.80

package/types/utils/index.d.ts

@@ -5,5 +5,6 @@ export * as id from "./id.js";
 export * as index from "./index.js";
 export * as pauseYoutubeVideo from "./pause-youtube-video.js";
 export * as fileSave from "./file-save.js";
-declare namespace ___Users_joescherben_Personal_Projects_ULU_frontend_js_utils_index_ { }
+export * as fontAwesome from "./font-awesome.js";
+declare namespace ___Users_joe_Projects_Personal_Github_frontend_js_utils_index_ { }
 //# sourceMappingURL=index.d.ts.map

package/types/utils/system.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Class serves as a utility for UI modules, handling the selection of elements and the initialization of corresponding component instances, ensuring consistent setup within the module
+ */
+export class ComponentInitializer {
+    static defaults: {
+        type: any;
+        baseAttribute: any;
+    };
+    static requiredOptions: string[];
+    static hasRequiredOptions: Function;
+    /**
+     * Create a new instance of ComponentInitializer
+     * @param {Object} options Options for configuring the component initializer.
+     * @param {String} options.type Type of component (used for logs).
+     * @param {String} options.baseAttribute Prefix and base attribute name (used for base attribute and further element attribute names).
+     */
+    constructor(options: {
+        type: string;
+        baseAttribute: string;
+    });
+    options: any;
+    logTitle: string;
+    /**
+     * Initializes the component based on the provided configuration.
+     * @param {Object} config The initialization configuration.
+     * @param {Function} config.setup The setup function to call for each element.
+     * @param {String} config.key [null] The optional key to use with attribute selector.
+     * @param {Boolean} config.withData [null] Whether to retrieve element data.
+     * @param {Array} config.events [null] Ulu events that should call setup when dispatched (ie. pageModified, pageResized)
+     * @param {Boolean} config.onPageResized [null] Whether to bind event listener for page resize end
+     * @param {HTMLElement} config.context [document] The context to query within.
+     */
+    init(config: {
+        setup: Function;
+        key: string;
+        withData: boolean;
+        events: any[];
+        onPageResized: boolean;
+        context: HTMLElement;
+    }): void;
+    /**
+     * Processes the elements based on the provided configuration.
+     * @param {object} config The initialization configuration.
+     * @param {function} config.setup The setup function to call for each element.
+     * @param {string} config.key The optional key to use with attribute selector.
+     * @param {boolean} config.withData [false] Whether to retrieve element data.
+     * @param {boolean} config.onPageModified [true] Whether to bind event listener for page modifications.
+     * @param {HTMLElement} config.context [document] The context to query within.
+     */
+    setupElements(config: {
+        setup: Function;
+        key: string;
+        withData: boolean;
+        onPageModified: boolean;
+        context: HTMLElement;
+    }): void;
+    /**
+     * Get an attribute name
+     * @param {String} key Optional key, if no key will return baseAttribute if key will return key added to base
+     * @returns {String} String like data-ulu-dialog or data-ulu-dialog-element
+     */
+    getAttribute(key: string): string;
+    /**
+     * Create an attribute selector
+     * @param {String} key Optional key (see getAttribute)
+     */
+    attributeSelector(key: string): string;
+    /**
+     * Create an attribute selector for initial
+     * @return {String}
+     */
+    attributeSelectorInitial(key: any): string;
+    /**
+     * Queries all main elements of a component that have not been initialized and extracts their data attributes.
+     * @param {HTMLElement} context The context to query within.
+     * @param {Boolean} withData Include dataset from element (as optional JSON)
+     * @param {Node} context Element to query elements from
+     * @returns {Array<{element: HTMLElement, data: object, initialize: Function}>} An array of objects containing the elements, their data, and convenience function initialize() which when called will set the init attribute on the element
+     */
+    queryAllInitial(key: any, withData: boolean, context?: HTMLElement): Array<{
+        element: HTMLElement;
+        data: object;
+        initialize: Function;
+    }>;
+    /**
+     * Sets the init attribute on an element, marking it as initialized.
+     * @param {HTMLElement} element The element to initialize.
+     */
+    initializeElement(element: HTMLElement): void;
+    /**
+     * Get an elements dataset value as JSON or other value
+     * @return {*} The value of the dataset, if JSON will return object else will return string value or undefined
+     */
+    getData(element: any, key: any): any;
+    /**
+     * Will output namespaced console logs for the given initializer
+     */
+    log(...msgs: any[]): void;
+    /**
+     * Will output namespaced console warnings for the given initializer
+     */
+    warn(...msgs: any[]): void;
+    /**
+     * Will output namespaced console error for the given initializer
+     */
+    logError(...msgs: any[]): void;
+}
+/**
+ * Class serves as a base for representing individual occurrences of a UI component, providing a consistent structure for each
+ */
+export class ComponentInstance {
+}
+//# sourceMappingURL=system.d.ts.map

package/types/utils/system.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system.d.ts","sourceRoot":"","sources":["../../js/utils/system.js"],"names":[],"mappings":"AAUA;;GAEG;AACH;IACE;;;MAGE;IACF,iCAGE;IACF,oCAEE;IAEF;;;;;OAKG;IACH;QAH2B,IAAI;QACJ,aAAa;OAUvC;IAFC,aAAwE;IACxE,iBAAgD;IAElD;;;;;;;;;OASG;IACH;QAP4B,KAAK;QACP,GAAG;QACF,QAAQ;QACV,MAAM;QACJ,aAAa;QACT,OAAO,EAA3B,WAAW;aAYrB;IACD;;;;;;;;OAQG;IACH;QAN4B,KAAK;QACP,GAAG,EAAlB,MAAM;QACU,QAAQ,EAAxB,OAAO;QACS,cAAc,EAA9B,OAAO;QACa,OAAO,EAA3B,WAAW;aAMrB;IACD;;;;OAIG;IACH,kCAGC;IACD;;;OAGG;IACH,uCAEC;IACD;;;OAGG;IACH,2CAEC;IACD;;;;;;OAMG;IACH,uDALW,WAAW,GAGT,MAAM;QAAC,OAAO,EAAE,WAAW,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,WAAU;KAAC,CAAC,CAS7E;IACD;;;OAGG;IACH,2BAFW,WAAW,QAIrB;IACD;;;OAGG;IACH,qCAGC;IACD;;OAEG;IACH,0BAEC;IACD;;OAEG;IACH,2BAEC;IACD;;OAEG;IACH,+BAEC;CACF;AAED;;GAEG;AACH;CAEC"}