@mgdis/mg-components 5.10.0 → 5.10.1

package/dist/types/utils/components.utils.d.ts

@@ -1,8 +1,8 @@
 /**
  * Create random ID
- * @param {string} prefix  add prefix to created ID
- * @param {number} length ID length
- * @returns {string} ID
+ * @param prefix - add prefix to created ID
+ * @param length - ID length
+ * @returns ID
  */
 export declare const createID: (prefix?: string, length?: number) => string;
 /**
@@ -14,39 +14,37 @@ export declare class ClassList {
   constructor(classlist?: string[]);
   /**
    * Add class
-   * @param {string} className class name to add
-   * @returns {void}
+   * @param className - class name to add
    */
   add: (className: string) => void;
   /**
    * Delete class
-   * @param {string} className class name to delete
-   * @returns {void}
+   * @param className - class name to delete
    */
   delete: (className: string) => void;
   /**
    * Check if class exist in list
-   * @param {string} className class name to check
-   * @returns {boolean} class name is in the list
+   * @param className - class name to check
+   * @returns class name is in the list
    */
   has: (className: string) => boolean;
   /**
    * Join classes seperated by spaces
-   * @returns {string} joined values
+   * @returns joined values
    */
   join: () => string;
 }
 /**
  * Check if all items are string
- * @param {unknown} items items to check
- * @returns {boolean} all items are string
+ * @param items - items to check
+ * @returns all items are string
  */
 export declare const allItemsAreString: (items: unknown) => items is string[];
 /**
  * Check if element is a heading
- * @param {Element} element slotted element
- * @param {string[]} tagNames allowed tag names list
- * @returns {boolean} element is a heading
+ * @param element - slotted element
+ * @param tagNames - allowed tag names list
+ * @returns element is a heading
  */
 export declare const isTagName: (element: Element, tagNames: string[]) => boolean;
 /**
@@ -55,14 +53,14 @@ export declare const isTagName: (element: Element, tagNames: string[]) => boolea
 export declare const focusableElements = "a[href], button, input, textarea, select, details, [tabindex]:not([tabindex=\"-1\"]), [identifier]";
 /**
  * Get windows
- * @param {Window} localWindow the window we are lookink for other windows
- * @returns {Window[]} The list of windows found
+ * @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 {Window} localWindow the window we are lookink for parents
- * @param {Window[]} windows The list of allready found windows
- * @returns {Window[]} The list of windows found
+ * @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[];

package/dist/types/utils/locale.utils.d.ts

@@ -1,16 +1,16 @@
 /**
  * Format number to the locale currency
- * @param {number} number number to format
- * @param {string} locale locale to apply
- * @param {string} currency currency to apply
- * @returns {string} formatted currency
+ * @param number - number to format
+ * @param locale - locale to apply
+ * @param currency - currency to apply
+ * @returns formatted currency
  */
 export declare const localeCurrency: (number: number, locale: string, currency: string) => string;
 /**
  * Format number to locale
- * @param {number} number number to format
- * @param {string} locale locale to apply
- * @returns {string} formatted number
+ * @param number - number to format
+ * @param locale - locale to apply
+ * @returns formatted number
  */
 export declare const localeNumber: (number: number, locale: string) => string;
 /**
@@ -19,18 +19,18 @@ export declare const localeNumber: (number: number, locale: string) => string;
 export declare const dateRegExp: RegExp;
 /**
  * Locale date format
- * @param {string} date date to format
- * @param {string} locale locale to apply
- * @returns {string} formatted date
+ * @param date - date to format
+ * @param locale - locale to apply
+ * @returns formatted date
  */
 export declare const localeDate: (date: string, locale: string) => string;
 /**
  * Get locale and messages
  * We load the defined locale but for now we only support the first subtag for messages
- * @param {HTMLElement} element element we need to get the language
- * @param {unknown} messages messages to use
- * @param {string} defaultLocale default messages locale
- * @returns {{ locale: string; messages: Record<string, unknown> }} messages object
+ * @param element - element we need to get the language
+ * @param messages - messages to use
+ * @param defaultLocale - default messages locale
+ * @returns messages object
  */
 export declare const getLocaleMessages: (element: HTMLElement, messages: unknown, defaultLocale: string) => {
   locale: string;

package/dist/types/utils/unit.test.utils.d.ts

@@ -1,8 +1,8 @@
 import { MockCustomEvent } from '@stencil/core/mock-doc';
 /**
  * Clone Deep function
- * @param {unknown} obj object to clone
- * @returns {unknown} cloned json
+ * @param obj - object to clone
+ * @returns cloned json
  */
 export declare const cloneDeep: (obj: unknown) => unknown;
 /**
@@ -11,10 +11,8 @@ export declare const cloneDeep: (obj: unknown) => unknown;
  * overwrite method. `jest.fn()` mock functions can be passed here if the goal is to not only
  * mock the mutation observer, but its methods.
  * You can manually fire an intersection entry:
- * @param {Function} mutationObserverMock.disconnect disconnect function
- * @param {Function} mutationObserverMock.observe observe function
- * @param {Function} mutationObserverMock.takeRecords takeRecords function
- * @returns {MutationObserver} Mocked MutationObserver
+ * @param mutationObserverMock - configuration object
+ * @returns Mocked MutationObserver
  * @example
  * ```
  * let fireMo;
@@ -39,9 +37,8 @@ export declare const setupMutationObserverMock: ({ disconnect, observe, takeReco
  * overwrite method. `jest.fn()` mock functions can be passed here if the goal is to not only
  * mock the resize observer, but its methods.
  * You can manually fire an intersection entry:
- * @param {Function} resizeObserverMock.disconnect disconnect function
- * @param {Function} resizeObserverMock.observe observe function
- * @returns {ResizeObserver} Mocked ResizeObserver
+ * @param resizeObserverMock - configuration object
+ * @returns Mocked ResizeObserver
  * @example
  * ```
  * let fireRo;
@@ -67,34 +64,31 @@ type setupResizeObserverMockParams = {
 export declare const setupResizeObserverMock: ({ disconnect, observe }: setupResizeObserverMockParams) => typeof ResizeObserver;
 /**
  * Utility function that mocks the `SubmitEvent` API. Recommended to execute inside `beforeEach`.
- * @returns {void}
  * @example
  * ```
  * setupSubmitEventMock();
  * ```
+ * @returns custom event mock
  */
 export declare const setupSubmitEventMock: () => typeof MockCustomEvent;
 /**
  * force popover id when component use randomed identifier
- * @param {Element} component element wich include mg-popover
- * @param {string} id new fixed id
- * @param {string} interactiveElement element where attribute 'aria-controls' is set
- * @returns {void}
+ * @param component - element wich include mg-popover
+ * @param id - new fixed id
+ * @param interactiveElement - element where attribute 'aria-controls' is set
  */
 export declare const forcePopoverId: (component: Element, id: string, interactiveElement?: string) => void;
 /**
  * fix popper console.error in test
- * it is generated in @popperjs/core/dist/cjs/popper.js l.1859
+ * it is generated in `@popperjs/core/dist/cjs/popper.js l.1859`
  * this is due to internal function isHTMLElement(), so we can not mock it directly.
  * this function check if test DOM element mockHTMLElement instance is 'instanceof HTMLElement'
  * so we only override the console.error side effect for this error
- * @returns {void}
  */
 export declare const mockConsoleError: () => void;
 /**
  * Add missing window.frames property to test context
  * usefull for component with iframe listeners, ex: mg-popover
- * @returns {void}
  */
 export declare const mockWindowFrames: () => void;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mgdis/mg-components",
-  "version": "5.10.0",
+  "version": "5.10.1",
   "description": "MG Components",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",