@mgdis/stencil-helpers 1.0.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, MGDIS
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,18 @@
+# @mgdis/stencil-helpers
+
+This package centralizes helper functions for your [Stencil](https://stenciljs.com/) projects. It is divided into four thematic sections:
+
+- **Components**: Centralizes all component utilities.
+- **Locale**: Centralizes all necessary locale utilities for managing content translation.
+- **Storybook**: Centralizes all Storybook helpers useful for building your own Storybook.
+- **Test**: Centralizes all test utilities to simplify testing your components.
+
+## Installation
+
+```bash
+pnpm i @mgdis/stencil-helpers
+```
+
+## Documentation
+
+Read the full [documentation](./doc/README.md)

package/dist/components/index.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Create random ID
+ * @param prefix - add prefix to created ID
+ * @param length - ID length
+ * @returns ID
+ */
+export declare const createID: (prefix?: string, length?: number) => string;
+/**
+ * Class to manage component classlist
+ */
+export declare class ClassList {
+    /**
+     * Available classes
+     */
+    classes: string[];
+    constructor(classlist?: string[]);
+    /**
+     * Add class
+     * @param className - class name to add
+     */
+    add: (className: string) => void;
+    /**
+     * Delete class
+     * @param className - class name to delete
+     */
+    delete: (className: string) => void;
+    /**
+     * Check if class exist in list
+     * @param className - class name to check
+     * @returns class name is in the list
+     */
+    has: (className: string) => boolean;
+    /**
+     * Join classes seperated by spaces
+     * @returns joined values
+     */
+    join: () => string;
+}
+/**
+ * Typeguard function to check if all array items are strings.
+ * @param items - items to check
+ * @returns `true` if all items are strings
+ */
+export declare const allItemsAreString: (items: unknown) => items is string[];
+/**
+ * Check if element belongs to the given tagNames list
+ * @param element - element to check
+ * @param tagNames - allowed tag names list
+ * @returns `true` if element tagName is in the tagNames list
+ */
+export declare const isTagName: (element: Element, tagNames: string[]) => boolean;
+/**
+ * CSS selector to select focusable elements.
+ * @example
+ * ```ts
+ * const allFocusableElements: HTMLElement[] = Array.from(this.element.querySelectorAll(focusableElements));
+ * ```
+ */
+export declare const focusableElements = "a[href], button, input, textarea, select, details, [tabindex]:not([tabindex=\"-1\"]), [identifier], mg-button";
+/**
+ * Get windows
+ * @param localWindow - the window we are lookink for other windows
+ * @returns The list of windows found
+ */
+export declare const getWindows: (localWindow: Window) => Window[];
+/**
+ * Get parent windows
+ * @param localWindow - the window we are lookink for parents
+ * @param windows - The list of allready found windows
+ * @returns The list of windows found
+ */
+export declare const getParentWindows: (localWindow: Window, windows?: Window[]) => Window[];
+/**
+ * Validate string
+ * @param value - value to check
+ * @returns `true` if string is valid
+ */
+export declare const isValidString: (value: unknown) => boolean;
+/**
+ * Cleans string characters by removing special characters and converting to lowercase.
+ * @param text - text to clean
+ * @returns cleaned string
+ * @example
+ * ```ts
+ * cleanString('âäàçéèêñù') // 'aaaceeenu'
+ * cleanString('BATMAN') // 'batman'
+ * ```
+ */
+export declare const cleanString: (text: string) => string;
+/**
+ * Use to process code next tick in the event loop
+ * @param callback - code to excute on next tick
+ * @returns differed code excution
+ */
+export declare const nextTick: (callback: () => void) => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,wCAA+B,MAWnD,CAAC;AAEF;;GAEG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;gBAEN,SAAS,GAAE,MAAM,EAAO;IAIpC;;;OAGG;IACH,GAAG,cAAe,MAAM,KAAG,IAAI,CAI7B;IAEF;;;OAGG;IACH,MAAM,cAAe,MAAM,KAAG,IAAI,CAKhC;IAEF;;;;OAIG;IACH,GAAG,cAAe,MAAM,KAAG,OAAO,CAEhC;IAEF;;;OAGG;IACH,IAAI,QAAO,MAAM,CAEf;CACH;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,UAAW,OAAO,sBAA6F,CAAC;AAE9I;;;;;GAKG;AACH,eAAO,MAAM,SAAS,YAAa,OAAO,YAAY,MAAM,EAAE,KAAG,OAEhE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,kHAAgH,CAAC;AAE/I;;;;GAIG;AACH,eAAO,MAAM,UAAU,gBAAiB,MAAM,KAAG,MAAM,EAItD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,gBAAiB,MAAM,YAAW,MAAM,EAAE,KAAQ,MAAM,EAgBpF,CAAC;AAkBF;;;;GAIG;AACH,eAAO,MAAM,aAAa,UAAW,OAAO,KAAG,OAA2D,CAAC;AAE3G;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,KAAG,MAMjC,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,QAAQ,aAAoB,MAAM,IAAI,KAAG,QAAQ,IAAI,CAAe,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './storybook';
+export * from './locale';
+export * from './components';
+export * from './test';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}