@appartmint/mint 0.13.3 → 0.13.4

package/dist/js/util.js

@@ -24,8 +24,8 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.mintSide = void 0;
-/**
- * Side Enum
+/**
+ * Side Enum
  */
 var mintSide;
 (function (mintSide) {
@@ -51,85 +51,85 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.mintSelectors = void 0;
-/**
- * CSS-selector helpers
- * @public
+/**
+ * CSS-selector helpers
+ * @public
  */
 class mintSelectors {
-  /**
-   * Adds the library prefix to the beginning of the provided string
-   * @param base - the string to be prefixed
-   * @returns - the provided string prefixed with the library name
+  /**
+   * Adds the library prefix to the beginning of the provided string
+   * @param base - the string to be prefixed
+   * @returns - the provided string prefixed with the library name
    */
   static prefix(base) {
     base = base.toLowerCase();
     return base.startsWith(this.pre) ? base : `${this.pre}${base}`;
   }
-  /**
-   * Adds two dashes to the beginning of the provided string
-   * @param base - the string to be prefixed
-   * @returns - the provided string prefixed with two dashes
+  /**
+   * Adds two dashes to the beginning of the provided string
+   * @param base - the string to be prefixed
+   * @returns - the provided string prefixed with two dashes
    */
   static cssPrefix(base) {
     return `--${this.prefix(base.replace(/^-+/, ''))}`;
   }
-  /**
-   * Turns the provided string into a CSS variable call
-   * @param base - the name of the CSS variable to call
-   * @returns - the CSS variable call for the provided string
+  /**
+   * Turns the provided string into a CSS variable call
+   * @param base - the name of the CSS variable to call
+   * @returns - the CSS variable call for the provided string
    */
   static cssVar(base) {
     return `var(${this.cssPrefix(base)})`;
   }
-  /**
-   * Negates the provided CSS selector
-   * @param base - the CSS selector to negate
-   * @returns - the negated CSS selector
+  /**
+   * Negates the provided CSS selector
+   * @param base - the CSS selector to negate
+   * @returns - the negated CSS selector
    */
   static neg(base) {
     return `:not(${base})`;
   }
-  /**
-   * Generates a class CSS selector
-   * @param base - the name of the class to generate
-   * @returns - the generated CSS selector
+  /**
+   * Generates a class CSS selector
+   * @param base - the name of the class to generate
+   * @returns - the generated CSS selector
    */
   static class(base) {
     return `.${this.prefix(base)}`;
   }
-  /**
-   * Generates an id CSS selector
-   * @param base - the name of the id to generate
-   * @returns - the generated CSS selector
+  /**
+   * Generates an id CSS selector
+   * @param base - the name of the id to generate
+   * @returns - the generated CSS selector
    */
   static id(base) {
     return `#${this.prefix(base)}`;
   }
-  /**
-   * Generates an aria-controls CSS selector
-   * @param id - the id of the controlled element
-   * @returns - the generated CSS selector
+  /**
+   * Generates an aria-controls CSS selector
+   * @param id - the id of the controlled element
+   * @returns - the generated CSS selector
    */
   static controls(id) {
     return id ? `[aria-controls="${this.prefix(id)}"]` : this.hasControls;
   }
-  /**
-   * Generates an aria-expanded CSS selector
-   * @param bool - whether the element is expanded or not
-   * @returns - the generated CSS selector
+  /**
+   * Generates an aria-expanded CSS selector
+   * @param bool - whether the element is expanded or not
+   * @returns - the generated CSS selector
    */
   static expanded(bool) {
     return typeof bool === 'boolean' ? `[aria-expanded="${bool}"]` : this.hasExpanded;
   }
-  /**
-   * Returns the id of the requested element
+  /**
+   * Returns the id of the requested element
    */
   static getId(id) {
     var _b;
     return (_b = this.ids[id !== null && id !== void 0 ? id : -1]) !== null && _b !== void 0 ? _b : '';
   }
-  /**
-   * Returns the class of the requested element
+  /**
+   * Returns the class of the requested element
    */
   static getClass(className, classGroup) {
     var _b, _c;
@@ -139,10 +139,10 @@ class mintSelectors {
     }
     return (_c = this.classes[className !== null && className !== void 0 ? className : -1]) !== null && _c !== void 0 ? _c : '';
   }
-  /**
-   * Returns a NodeList of HTMLElements within the given element that are focusable
-   * @param el - the element whose focusable children will be returned
-   * @returns - the elements within the given element that are focusable
+  /**
+   * Returns a NodeList of HTMLElements within the given element that are focusable
+   * @param el - the element whose focusable children will be returned
+   * @returns - the elements within the given element that are focusable
    */
   static getFocusables(el) {
     let focusables;
@@ -153,12 +153,12 @@ class mintSelectors {
     }
     return focusables.filter(el => this.isFocusable(el));
   }
-  /**
-   * Returns true if an element is focusable and false if not,
-   * based on styles (i.e. a parent has display: none;)
-   * NOTE: Still need to determine what other styles may make an element un-focusable
-   * @param el - the element
-   * @returns - true if the element is focusable; false if not
+  /**
+   * Returns true if an element is focusable and false if not,
+   * based on styles (i.e. a parent has display: none;)
+   * NOTE: Still need to determine what other styles may make an element un-focusable
+   * @param el - the element
+   * @returns - true if the element is focusable; false if not
    */
   static isFocusable(el) {
     let current = el;
@@ -173,48 +173,48 @@ class mintSelectors {
 }
 exports.mintSelectors = mintSelectors;
 _a = mintSelectors;
-/**
- * The library name that will be added as a prefix
+/**
+ * The library name that will be added as a prefix
  */
 mintSelectors.lib = 'mint';
-/**
- * The prefix built from the library name
+/**
+ * The prefix built from the library name
  */
 mintSelectors.pre = `${_a.lib}-`;
-/**
- * CSS-selector for disabled elements
+/**
+ * CSS-selector for disabled elements
  */
 mintSelectors.disabled = '[disabled]';
-/**
- * CSS-selector for elements with an aria-controls attribute
+/**
+ * CSS-selector for elements with an aria-controls attribute
  */
 mintSelectors.hasControls = '[aria-controls]';
-/**
- * CSS-selector for elements with an aria-expanded attribute
+/**
+ * CSS-selector for elements with an aria-expanded attribute
  */
 mintSelectors.hasExpanded = '[aria-expanded]';
-/**
- * CSS-selector for elements with an href attribute
+/**
+ * CSS-selector for elements with an href attribute
  */
 mintSelectors.hasLink = '[href]';
-/**
- * CSS-selector for elements with a routerLink attribute
+/**
+ * CSS-selector for elements with a routerLink attribute
  */
 mintSelectors.hasRouterLink = '[routerLink]';
-/**
- * CSS-selector for elements with an id attribute
+/**
+ * CSS-selector for elements with an id attribute
  */
 mintSelectors.hasId = '[id]';
-/**
- * CSS-selector for elements that aren't tabbable (i.e. tabindex is negative)
+/**
+ * CSS-selector for elements that aren't tabbable (i.e. tabindex is negative)
  */
 mintSelectors.notTabbable = '[tabindex^="-"]';
-/**
- * CSS-selector for elements that are tabbable (i.e. tabindex isn't negative)
+/**
+ * CSS-selector for elements that are tabbable (i.e. tabindex isn't negative)
  */
 mintSelectors.tabbable = `[tabindex]${_a.neg(_a.notTabbable)}`;
-/**
- * CSS-selector for elements that can receive focus
+/**
+ * CSS-selector for elements that can receive focus
  */
 mintSelectors.focusable = `input${_a.neg(_a.disabled)}${_a.neg(_a.notTabbable)},
                                 select${_a.neg(_a.disabled)}${_a.neg(_a.notTabbable)},
@@ -224,16 +224,16 @@ mintSelectors.focusable = `input${_a.neg(_a.disabled)}${_a.neg(_a.notTabbable)},
                                 a${_a.hasLink}, a${_a.hasRouterLink},
                                 area${_a.hasLink},
                                 ${_a.tabbable}`.replace(/\s/g, '');
-/**
- * CSS-selector for submenu buttons
+/**
+ * CSS-selector for submenu buttons
  */
 mintSelectors.subMenuButtons = `button${_a.hasControls}`;
-/**
- * CSS-selector for submenus
+/**
+ * CSS-selector for submenus
  */
 mintSelectors.subMenu = `${_a.subMenuButtons} + ul${_a.hasId}`;
-/**
- * Frequently-used ids
+/**
+ * Frequently-used ids
  */
 mintSelectors.ids = {
   header: _a.prefix('header'),
@@ -241,8 +241,8 @@ mintSelectors.ids = {
   wrapper: _a.prefix('wrapper'),
   mainContent: _a.prefix('main-content')
 };
-/**
- * Classes
+/**
+ * Classes
  */
 mintSelectors.classes = {
   sides: {
@@ -274,19 +274,19 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.mintSettings = void 0;
-/**
- * Imports
+/**
+ * Imports
  */
 const enum_1 = __webpack_require__(/*! ../enum */ "./src/ts/imports/enum.ts");
 const selectors_1 = __webpack_require__(/*! ./selectors */ "./src/ts/imports/util/selectors.ts");
-/**
- * Settings management
- * @public
+/**
+ * Settings management
+ * @public
  */
 class mintSettings {
-  /**
-   * Update the provided settings variables
-   * @param settings - Object of settings variables to update
+  /**
+   * Update the provided settings variables
+   * @param settings - Object of settings variables to update
    */
   static set(settings) {
     let newDelay = false;
@@ -313,8 +313,8 @@ class mintSettings {
       this.setFixed(settings.fixed);
     }
   }
-  /**
-   * Updates the delay variables based on `this.delayBase` and `this.delayStep`
+  /**
+   * Updates the delay variables based on `this.delayBase` and `this.delayStep`
    */
   static setDelay() {
     this.delay = {
@@ -326,8 +326,8 @@ class mintSettings {
       slow: this.delayBase + this.delayStep * 5
     };
   }
-  /**
-   * Updates the direction the navbar enters from
+  /**
+   * Updates the direction the navbar enters from
    */
   static setFrom(from) {
     if (this.from !== from) {
@@ -337,8 +337,8 @@ class mintSettings {
       header === null || header === void 0 ? void 0 : header.classList.add(selectors_1.mintSelectors.getClass(enum_1.mintSide[this.from].toLowerCase(), 'sides'));
     }
   }
-  /**
-   * Updates whether or not the navbar is fixed
+  /**
+   * Updates whether or not the navbar is fixed
    */
   static setFixed(fixed) {
     if (this.fixed !== fixed) {
@@ -355,16 +355,16 @@ class mintSettings {
 }
 exports.mintSettings = mintSettings;
 _a = mintSettings;
-/**
- * Value added to all delay variables
+/**
+ * Value added to all delay variables
  */
 mintSettings.delayBase = 0;
-/**
- * Value multiplied by delay variable index
+/**
+ * Value multiplied by delay variable index
  */
 mintSettings.delayStep = 100;
-/**
- * Delay variables
+/**
+ * Delay variables
  */
 mintSettings.delay = {
   instant: _a.delayBase + _a.delayStep * 0,
@@ -396,29 +396,29 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.mintUtil = void 0;
-/**
- * Imports
+/**
+ * Imports
  */
 const enum_1 = __webpack_require__(/*! ./imports/enum */ "./src/ts/imports/enum.ts");
 const settings_1 = __importDefault(__webpack_require__(/*! ./imports/util/settings */ "./src/ts/imports/util/settings.ts"));
-/**
- * Utility functions
- * @public
+/**
+ * Utility functions
+ * @public
  */
 class mintUtil {
-  /**
-   * Returns the width of the window, including fractional pixels
-   * @returns the width of the window
+  /**
+   * Returns the width of the window, including fractional pixels
+   * @returns the width of the window
    */
   static windowWidth() {
     const decimal = document.body.getBoundingClientRect().width % 1;
     return window.innerWidth + decimal;
   }
-  /**
-   * Ensures that a function `func` is run only after not being called for `wait` milliseconds
-   * @param func - the function to debounce
-   * @param wait - the amount of time to wait before running the function
-   * @returns - the debounced function
+  /**
+   * Ensures that a function `func` is run only after not being called for `wait` milliseconds
+   * @param func - the function to debounce
+   * @param wait - the amount of time to wait before running the function
+   * @returns - the debounced function
    */
   static debounce(func) {
     let wait = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : settings_1.default.delay.default;
@@ -430,22 +430,22 @@ class mintUtil {
       timer = setTimeout(func, wait, e);
     };
   }
-  /**
-   * Ensures that a function `func` is run only after not being called for `wait` milliseconds
-   * @param func - the function to debounce
-   * @param wait - the amount of time to wait before running the function
-   * @returns - the debounced function as an EventListener
+  /**
+   * Ensures that a function `func` is run only after not being called for `wait` milliseconds
+   * @param func - the function to debounce
+   * @param wait - the amount of time to wait before running the function
+   * @returns - the debounced function as an EventListener
    */
   static debounceEvent(func) {
     let wait = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : settings_1.default.delay.default;
     return mintUtil.debounce(func, wait);
   }
-  /**
-   * Ensures that a function `func` is called at most every `wait` milliseconds with optional leading and trailing calls
-   * @param func - the function to throttle
-   * @param wait - the amount of time between function calls
-   * @param options - leading and trailing options: default = \{ leading: true, trailing, true \}
-   * @returns - the throttled function
+  /**
+   * Ensures that a function `func` is called at most every `wait` milliseconds with optional leading and trailing calls
+   * @param func - the function to throttle
+   * @param wait - the amount of time between function calls
+   * @param options - leading and trailing options: default = \{ leading: true, trailing, true \}
+   * @returns - the throttled function
    */
   static throttle(func) {
     let wait = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : settings_1.default.delay.default;
@@ -488,23 +488,23 @@ class mintUtil {
       };
     return throttled;
   }
-  /**
-   * Ensures that a function `func` is called at most every `wait` milliseconds with optional leading and trailing calls
-   * @param func - the function to throttle
-   * @param wait - the amount of time between function calls
-   * @param options - leading and trailing options: default = \{ leading: true, trailing, true \}
-   * @returns - the throttled function as an EventListener
+  /**
+   * Ensures that a function `func` is called at most every `wait` milliseconds with optional leading and trailing calls
+   * @param func - the function to throttle
+   * @param wait - the amount of time between function calls
+   * @param options - leading and trailing options: default = \{ leading: true, trailing, true \}
+   * @returns - the throttled function as an EventListener
    */
   static throttleEvent(func) {
     let wait = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : settings_1.default.delay.default;
     let options = arguments.length > 2 ? arguments[2] : undefined;
     return mintUtil.throttle(func, wait, options);
   }
-  /**
-   * Sets the element's height to its `innerHeight`, then to `auto` after a delay
-   * @param el - the element whose height will be set
-   * @param delay - the amount of time in milliseconds that the show animation will be active
-   * @param from - the side that the element is animating from
+  /**
+   * Sets the element's height to its `innerHeight`, then to `auto` after a delay
+   * @param el - the element whose height will be set
+   * @param delay - the amount of time in milliseconds that the show animation will be active
+   * @param from - the side that the element is animating from
    */
   static show(el) {
     let delay = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : settings_1.default.delay.default;
@@ -527,11 +527,11 @@ class mintUtil {
       });
     }
   }
-  /**
-   * Sets the element's height to 0
-   * @param el - the element whose height will be set
-   * @param delay - the amount of time in milliseconds that the show animation will be active
-   * @param from - the side that the element is animating from
+  /**
+   * Sets the element's height to 0
+   * @param el - the element whose height will be set
+   * @param delay - the amount of time in milliseconds that the show animation will be active
+   * @param from - the side that the element is animating from
    */
   static hide(el) {
     let delay = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : settings_1.default.delay.default;
@@ -561,10 +561,10 @@ class mintUtil {
       }, delay);
     }
   }
-  /**
-   * Copies the provided text to the clipboard
-   * @param text - the text to copy
-   * @returns - true if the text was successfully copied to the clipboard; else false
+  /**
+   * Copies the provided text to the clipboard
+   * @param text - the text to copy
+   * @returns - true if the text was successfully copied to the clipboard; else false
    */
   static copyText(text) {
     let textArea = document.createElement('textarea');
@@ -587,11 +587,11 @@ class mintUtil {
     document.body.removeChild(textArea);
     return true;
   }
-  /**
-   * Tests the validity of an email address
-   * @see {@link https://stackoverflow.com/questions/201323/how-can-i-validate-an-email-address-using-a-regular-expression}
-   * @param text - the string to test
-   * @returns - true if the given string is an email address; false if not
+  /**
+   * Tests the validity of an email address
+   * @see {@link https://stackoverflow.com/questions/201323/how-can-i-validate-an-email-address-using-a-regular-expression}
+   * @param text - the string to test
+   * @returns - true if the given string is an email address; false if not
    */
   static isEmail(text) {
     return null !== text.match(/(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])/);