@codady/utils 0.0.22 → 0.0.24

package/src/parseClasses.ts

@@ -0,0 +1,39 @@
+/**
+ * @since Last modified: 2026/01/07 11:45:59
+ * @function parseClasses
+ * @description Converts a string or an array of class names into an array of class names.
+ * If a string is provided, it can be a comma-separated or space-separated list of class names.
+ * The function cleans up any unnecessary spaces and ensures the result is an array of strings.
+ * @param {string | string[]} data - A string containing class names separated by commas or spaces, or an array of class names.
+ * @returns {string[]} - Returns an array of class names as strings.
+ * @example
+ * parseClasses('demo01,demo02'); // Returns ['demo01', 'demo02']
+ * parseClasses('demo01 demo02'); // Returns ['demo01', 'demo02']
+ * parseClasses(['demo01', 'demo02']); // Returns ['demo01', 'demo02']
+ */
+'use strict';
+
+import COMMA from "./comma";
+import SPACE from "./space";
+import trim from "./trim";
+
+const parseClasses = (data: string | string[]): string[] => {
+    let separator: string,
+        result: string[] = [];
+
+    if (Array.isArray(data)) {
+        // If data is already an array, filter out invalid values
+        result = (data as string[]).filter((k: any) => k && typeof k === 'string');
+    } else {
+        // Trim the input string and handle multiple spaces
+        data = trim(data as string);
+        // Use comma as the separator if present, otherwise use space
+        separator = data.includes(COMMA) ? COMMA : SPACE;
+        result = data.split(separator);
+    }
+
+    // Trim each item globally and filter out any empty strings
+    return result.map((k: string) => trim(k, 'global')).filter(Boolean);
+};
+
+export default parseClasses;

package/src/removeClasses.js

@@ -0,0 +1,44 @@
+/**
+ * @since Last modified: 2026/01/07 12:05:02
+ * @namespace removeClasses
+ * @description Removes one or more CSS classes from a DOM element. This function can remove a list of class names
+ *   either passed as a space/comma-separated string or an array of strings.
+ *   It also supports an optional `intercept` callback to modify or intercept the class removal process.
+ *
+ * @param {string | Node | null} target - The target DOM element, Node, or CSS selector from which the classes will be removed.
+ *   It can be:
+ *   - A string representing a CSS selector (e.g., `#elementId`)
+ *   - A DOM Node or Element.
+ *   - `null` (in which case, no action will be performed).
+ * @param {string | string[]} classes - A string or an array of CSS class names to remove. This can be:
+ *   - A space/comma-separated string of class names (e.g., `'class1 class2'`)
+ *   - An array of class names (e.g., `['class1', 'class2']`)
+ * @param {Function} [intercept] - An optional callback function that intercepts the class removal process.
+ *   It takes the class name as a parameter and can return:
+ *   - `true`: to remove the class name.
+ *   - A new class name (string): to replace the class name with a new one.
+ *   - `false` or `undefined`: to skip removing the class.
+ * @returns {void} This function does not return a value. It modifies the target DOM element.
+ *
+ */
+'use strict';
+import getEl from "./getEl";
+import parseClasses from "./parseClasses";
+const removeClasses = (target, classes, intercept) => {
+    const el = getEl(target), arr = parseClasses(classes);
+    if (!el || arr.length === 0)
+        return;
+    arr.forEach((k) => {
+        let tmp;
+        if (intercept) {
+            tmp = intercept(k);
+            tmp === true ? el.classList.remove(k) :
+                (typeof tmp === 'string' && tmp) ? el.classList.remove(tmp) : null;
+        }
+        else {
+            el.classList.remove(k);
+        }
+    });
+    return;
+};
+export default removeClasses;

package/src/removeClasses.ts

@@ -0,0 +1,47 @@
+/**
+ * @since Last modified: 2026/01/07 12:05:02
+ * @namespace removeClasses
+ * @description Removes one or more CSS classes from a DOM element. This function can remove a list of class names
+ *   either passed as a space/comma-separated string or an array of strings.
+ *   It also supports an optional `intercept` callback to modify or intercept the class removal process.
+ * 
+ * @param {string | Node | null} target - The target DOM element, Node, or CSS selector from which the classes will be removed.
+ *   It can be:
+ *   - A string representing a CSS selector (e.g., `#elementId`)
+ *   - A DOM Node or Element.
+ *   - `null` (in which case, no action will be performed).
+ * @param {string | string[]} classes - A string or an array of CSS class names to remove. This can be:
+ *   - A space/comma-separated string of class names (e.g., `'class1 class2'`)
+ *   - An array of class names (e.g., `['class1', 'class2']`)
+ * @param {Function} [intercept] - An optional callback function that intercepts the class removal process.
+ *   It takes the class name as a parameter and can return:
+ *   - `true`: to remove the class name.
+ *   - A new class name (string): to replace the class name with a new one.
+ *   - `false` or `undefined`: to skip removing the class.
+ * @returns {void} This function does not return a value. It modifies the target DOM element.
+ * 
+ */
+'use strict';
+
+import getEl from "./getEl";
+import parseClasses from "./parseClasses";
+
+const removeClasses = (target: string | Node | null, classes: string | string[], intercept?: (className: string) => string | boolean | void): void => {
+    const el = getEl(target),
+        arr = parseClasses(classes);
+    if (!el || arr.length === 0) return;
+
+    arr.forEach((k: string) => {
+        let tmp: any;
+        if (intercept) {
+            tmp = intercept(k);
+            tmp === true ? (el as Element).classList.remove(k) :
+                (typeof tmp === 'string' && tmp) ? (el as Element).classList.remove(tmp) : null;
+        } else {
+            (el as Element).classList.remove(k);
+        }
+    });
+    return;
+}
+export default removeClasses;
+

package/src/space.js

@@ -0,0 +1,2 @@
+const SPACE = ' ';
+export default SPACE;

package/src/space.ts

@@ -0,0 +1,2 @@
+const SPACE = ' ';
+export default SPACE;

package/src/trim.js

@@ -0,0 +1,41 @@
+/**
+ * @since Last modified: 2026/01/07 11:20:29
+ * @function trim
+ * @description Removes spaces, newlines, and carriage returns from the string.
+ * Supports removing spaces at specific positions (start, end, or both) or globally within the string.
+ * This is more powerful than the native `trim` method.
+ * @param {string} str - The string to be trimmed.
+ * @param {string} [placement='global'] - Defines where to remove spaces:
+ *   - 'start' to remove spaces from the beginning.
+ *   - 'end' to remove spaces from the end.
+ *   - 'both' to remove spaces from both the start and the end.
+ *   - 'global' to remove all spaces, newlines, and carriage returns globally.
+ *   If omitted, the default is 'global'.
+ * @returns {string} - The string after trimming, without altering the original string.
+ * @example
+ * trim('   My name     is Lily  '); // Returns 'My name is Lily'
+ * trim('   My name     is Lily  ', 'start'); // Returns 'My name     is Lily  '
+ * trim('   My name     is Lily  ', 'end'); // Returns '   My name     is Lily'
+ * trim('   My name     is Lily  ', 'both'); // Returns 'My name     is Lily'
+ * trim('   My name     is Lily  ', 'global'); // Returns 'MynameisLily'
+ */
+'use strict';
+const trim = (str, placement = 'global') => {
+    if (typeof str !== 'string') {
+        console.warn('Expected a string input');
+        return '';
+    }
+    switch (placement) {
+        case 'start':
+            return str.trimStart();
+        case 'end':
+            return str.trimEnd();
+        case 'both':
+            return str.trim();
+        case 'global':
+            return str.replace(/[\s\r\n]+/g, '');
+        default:
+            return str.trim().replace(/[\s\r\n]+/g, ' '); // Default behavior, trims both ends and replaces inner spaces
+    }
+};
+export default trim;

package/src/trim.ts

@@ -0,0 +1,44 @@
+/**
+ * @since Last modified: 2026/01/07 11:20:29
+ * @function trim
+ * @description Removes spaces, newlines, and carriage returns from the string. 
+ * Supports removing spaces at specific positions (start, end, or both) or globally within the string. 
+ * This is more powerful than the native `trim` method.
+ * @param {string} str - The string to be trimmed.
+ * @param {string} [placement='global'] - Defines where to remove spaces:
+ *   - 'start' to remove spaces from the beginning.
+ *   - 'end' to remove spaces from the end.
+ *   - 'both' to remove spaces from both the start and the end.
+ *   - 'global' to remove all spaces, newlines, and carriage returns globally.
+ *   If omitted, the default is 'global'.
+ * @returns {string} - The string after trimming, without altering the original string.
+ * @example
+ * trim('   My name     is Lily  '); // Returns 'My name is Lily'
+ * trim('   My name     is Lily  ', 'start'); // Returns 'My name     is Lily  '
+ * trim('   My name     is Lily  ', 'end'); // Returns '   My name     is Lily'
+ * trim('   My name     is Lily  ', 'both'); // Returns 'My name     is Lily'
+ * trim('   My name     is Lily  ', 'global'); // Returns 'MynameisLily'
+ */
+'use strict';
+
+const trim = (str: string, placement: 'start' | 'end' | 'both' | 'global' = 'global'): string => {
+    if (typeof str !== 'string') {
+        console.warn('Expected a string input');
+        return '';
+    }
+
+    switch (placement) {
+        case 'start':
+            return str.trimStart();
+        case 'end':
+            return str.trimEnd();
+        case 'both':
+            return str.trim();
+        case 'global':
+            return str.replace(/[\s\r\n]+/g, '');
+        default:
+            return str.trim().replace(/[\s\r\n]+/g, ' '); // Default behavior, trims both ends and replaces inner spaces
+    }
+};
+
+export default trim;

package/src/svgToBase64.js

@@ -1,22 +0,0 @@
-/**
- * @since Last modified: 2026/01/06 21:45:02
- * Converts an SVG string to a Base64 or URL-encoded format for use in `src` or background image.
- * This function ensures the SVG string is properly encoded to be safely used as a data URL.
- *
- * @param {string} svgString - The SVG string to be encoded.
- * @returns {string} - A data URL that can be used in `src` or as a background image, formatted as `data:image/svg+xml;charset=utf-8,`.
- *
- * @since Last modified: 2026/01/06 21:43:33
- *
- * Note:
- * - The function first URI-encodes the input string to make sure special characters are escaped.
- * - It replaces single quotes (') and double quotes (") with their respective URL-encoded forms (`%27` and `%22`) to prevent any potential issues in the URL.
- * - This approach provides better compatibility when embedding the SVG directly in HTML, CSS, or JavaScript.
- */
-export const svgToBase64 = (svgString) => {
-    // 1. This method provides the best compatibility (escaping special characters)
-    const encoded = encodeURIComponent(svgString)
-        .replace(/'/g, "%27")
-        .replace(/"/g, "%22");
-    return `data:image/svg+xml;charset=utf-8,${encoded}`;
-};

package/src/svgToBase64.ts

@@ -1,22 +0,0 @@
-/**
- * @since Last modified: 2026/01/06 21:45:02
- * Converts an SVG string to a Base64 or URL-encoded format for use in `src` or background image.
- * This function ensures the SVG string is properly encoded to be safely used as a data URL.
- *
- * @param {string} svgString - The SVG string to be encoded.
- * @returns {string} - A data URL that can be used in `src` or as a background image, formatted as `data:image/svg+xml;charset=utf-8,`.
- * 
- * @since Last modified: 2026/01/06 21:43:33
- * 
- * Note:
- * - The function first URI-encodes the input string to make sure special characters are escaped.
- * - It replaces single quotes (') and double quotes (") with their respective URL-encoded forms (`%27` and `%22`) to prevent any potential issues in the URL.
- * - This approach provides better compatibility when embedding the SVG directly in HTML, CSS, or JavaScript.
- */
-export const svgToBase64 = (svgString: string):string => {
-    // 1. This method provides the best compatibility (escaping special characters)
-    const encoded = encodeURIComponent(svgString)
-        .replace(/'/g, "%27")
-        .replace(/"/g, "%22");
-    return `data:image/svg+xml;charset=utf-8,${encoded}`;
-};