@ulu/frontend 0.0.22 → 0.1.0-beta.0

package/types/utils/dom.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Get an elements JSON dataset value
+ * @param {Node} element
+ * @param {String} key key in dataset object for element
+ * @returns {Object} Empty object or JSON object from dataset
+ */
+export function getDatasetJson(element: Node, key: string): any;
+/**
+ * Get an elements JSON dataset value that could potentially just be a single string
+ * - If JSON it will return the object else it will return the value directly
+ * @param {Node} element
+ * @param {String} key key in dataset object for element
+ * @returns {Object|String} JSON object or current dataset value (string or empty string if no value)
+ */
+export function getDatasetOptionalJson(element: Node, key: string): any | string;
+/**
+ * Check if a pointer event x/y was outside an elements bounding box
+ */
+export function wasClickOutside(element: any, event: any): boolean;
+/**
+ *   Sets up the positional classes that would come from the equal
+ *   height module. Needs to be rerun by user when layout changes
+ *   or new instances are added to the screen
+ *   - Used for gutter crops
+ *   - Used for rule placement
+ *   - **Devs** Remember that default classes should match sass defaults
+ *   @param {Node} parent  The grid parent <data-grid="">
+ *   @param {Object} classes Override the default equal heights classes
+ */
+export function setPositionClasses(parent: Node, classes?: any): void;
+/**
+ * Resolve a target to Element
+ * @param {String|Node} target The selector or node/element
+ * @param {Object} context [document] The context to query possible selectors from
+ */
+export function getElement(target: string | Node, context?: any): any;
+/**
+ * Sets a CSS custom property equal to the scrollbar width
+ * @param {Node} element The element that is the child of a scrollabel container
+ * @param {Node} container The container that can be scrolled
+ * @param {Stirng} propName Custom property to set
+ */
+export function addScrollbarProperty(element?: Node, container?: Node, propName?: Stirng): void;
+/**
+ * @module utils/dom
+ */
+export const regexJsonString: RegExp;
+//# sourceMappingURL=dom.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../js/utils/dom.js"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,wCAJW,IAAI,oBAYd;AAED;;;;;;GAMG;AACH,gDAJW,IAAI,gBAEF,YAAa,CASzB;AAED;;GAEG;AACH,mEAMC;AAGD;;;;;;;;;GASG;AACH,2CAHa,IAAI,uBAoChB;AAED;;;;GAIG;AACH,mCAHW,SAAO,IAAI,sBAYrB;AAED;;;;;GAKG;AACH,+CAJW,IAAI,cACJ,IAAI,2BAMd;AAzHD;;GAEG;AAGH,qCAAqD"}

package/types/utils/file-save.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @module utils/file-save
+ */
+/**
+ * Options
+ * @typedef {Object} FileSaveOptions
+ * @property {String} filename Filename for blob when creating a link (ie createLink) [default "filesave-file.txt"]
+ * @property {String} type Filename for blob when creating a link (ie createLink) [default "text/plain;charset=utf-8"]
+ */
+/**
+ * Simple script that is useful for testing
+ * - Make a file
+ * - Create a URL to it
+ * - Gives utility function to create a link to the file (for front end)
+ * - Gives method to destroy the file when no longer needed
+ * - User can redefine the program by passing options object matching props.
+ * Limited to new browsers that support Blob(), also user preferences or type of browser may limit access to Blob functionality
+ */
+export class FileSave {
+    static defaults: {
+        filename: string;
+        type: string;
+    };
+    /**
+     * Check for Compatibility (optional, implement on user side)
+     */
+    static isBrowserSupported(): boolean;
+    /**
+     * @param {*} data Data to put in blob file
+     * @param {FileSaveOptions} options Options for file, see defaults (ie. type, filename)
+     */
+    constructor(data: any, options: FileSaveOptions);
+    options: any;
+    data: any;
+    blob: Blob;
+    url: string;
+    /**
+     * Remove the blob url
+     */
+    destroy(): void;
+    /**
+     * Get the blob url
+     */
+    getUrl(): string;
+    /**
+     * Create link element with blob as href
+     * @param {String} text The text to put in the link
+     */
+    createLink(text: string): HTMLAnchorElement;
+}
+/**
+ * Options
+ */
+export type FileSaveOptions = {
+    /**
+     * Filename for blob when creating a link (ie createLink) [default "filesave-file.txt"]
+     */
+    filename: string;
+    /**
+     * Filename for blob when creating a link (ie createLink) [default "text/plain;charset=utf-8"]
+     */
+    type: string;
+};
+//# sourceMappingURL=file-save.d.ts.map

package/types/utils/file-save.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-save.d.ts","sourceRoot":"","sources":["../../js/utils/file-save.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AAGH;;;;;;;;GAQG;AACH;IACE;;;MAGC;IAmCD;;OAEG;IACH,qCAEC;IAvCD;;;OAGG;IACH,gCAFW,eAAe,EAOzB;IAJC,aAA4D;IAC5D,UAAgB;IAChB,WAAyD;IACzD,YAAyC;IAE3C;;OAEG;IACH,gBAEC;IACD;;OAEG;IACH,iBAEC;IACD;;;OAGG;IACH,4CAOC;CAOF"}

package/types/utils/floating-ui.d.ts

@@ -0,0 +1,19 @@
+/**
+ *
+ * @param {Object} elements Elements (trigger, content, and optionally contentArrow)
+ * @param {*} options Configuration options for floatingUi
+ * @returns {Function} floating cleanup function call when no longer needed
+ */
+export function createFloatingUi(elements: any, config: any): Function;
+export namespace defaults {
+    let strategy: string;
+    let placement: string;
+    let inline: boolean;
+    namespace offset {
+        let mainAxis: number;
+    }
+    let shift: boolean;
+    let flip: boolean;
+    let arrow: boolean;
+}
+//# sourceMappingURL=floating-ui.d.ts.map

package/types/utils/floating-ui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"floating-ui.d.ts","sourceRoot":"","sources":["../../js/utils/floating-ui.js"],"names":[],"mappings":"AA0BA;;;;;GAKG;AACH,uEAuCC"}

package/types/utils/id.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Create new uid
+ */
+export function newId(): string;
+/**
+ * Sets an ID if element doesn't have one vie newUid
+ * @param {Node} element Element to make sure has an id
+ */
+export function ensureId(element: Node): void;
+//# sourceMappingURL=id.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"id.d.ts","sourceRoot":"","sources":["../../js/utils/id.js"],"names":[],"mappings":"AAMA;;GAEG;AACH,gCAEC;AAED;;;GAGG;AACH,kCAFW,IAAI,QAMd"}

package/types/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * as classLogger from "./class-logger.js";
+export * as dom from "./dom.js";
+export * as floatingUi from "./floating-ui.js";
+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_ { }
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../js/utils/index.js"],"names":[],"mappings":""}

package/types/utils/pause-youtube-video.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pause-youtube-video.d.ts","sourceRoot":"","sources":["../../js/utils/pause-youtube-video.js"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,sCAFW,OAAO,GAAC,IAAI,QAWtB;AACD;;;;GAIG;AACH,qDAQC"}

package/js/helpers/file-save.js

@@ -1,52 +0,0 @@
-/**
- * @module helpers/file-save
- */
-
-// Description:     Simple script that is useful for testing. It will:
-//                  - Make a file 
-//                  - Create a URL to it
-//                  - Gives utility function to create a link to the file (for front end)
-//                  - Gives method to destroy the file when no longer needed
-//                  - User can redefine the program by passing options object matching props.
-
-// Dependencies:    No
-
-// Support:         Limited to knew browsers that support Blob(), also user preferences or 
-//                  type of browser may limit access to Blob functionality
-
-// Related Docs:
-//                  - https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
-//                  - https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL
-//                  - https://developer.mozilla.org/en-US/docs/Web/API/URL/revokeObjectURL
-
-
-class FileSave {
-  constructor(data, options) {
-    this.filename = "filesave-file.txt";
-    this.type = "text/plain;charset=utf-8";
-    // Allow user to override above
-    if (options) Object.assign(this, options);
-    this.data = data;
-    this.blob = new Blob([data], { type: this.type });
-    this.url = URL.createObjectURL(this.blob);
-  }
-  destroy() {
-    return URL.revokeObjectURL(this.url);
-  }
-  getUrl() {
-    return this.url;
-  }
-  createLink(text) {
-    var link = d.createElement('a');
-    text = d.createTextNode(text);
-    link.setAttribute('download', this.filename);
-    link.setAttribute('href', this.url);
-    link.appendChild(text);
-    return link;
-  }
-  static isBrowserSupported() {
-    return "FileReader" in window;
-  }
-}
-
-export default FileSave;

package/js/helpers/scrollbar-width-property.js

@@ -1,14 +0,0 @@
-/**
- * @module helpers/scrollbar-width-property
- */
-
-/**
- * Sets a CSS custom property equal to the scrollbar width
- * @param {Node} element The element that is the child of a scrollabel container
- * @param {Node} container The container that can be scrolled
- * @param {Stirng} propName Custom property to set
- */
-export default function addScrollbarProperty(element = document.body, container = window, propName = "--scrollbar-width") {
-  const scrollbarWidth = container.innerWidth - element.clientWidth;
-  element.style.setProperty(propName, `${ scrollbarWidth }px`);
-}

package/project.todo

@@ -1,22 +0,0 @@
-Bring in Vue components as a separate package:
-  ☐ Decided that vue stuff should stay seperate as we wouldn't want to udpate this library to make changes to vue components (as vue changes over time)
-    ☐ This other module may use peer deps or something to limit which version of ulu it works with
-Todos:
-  ☐ Do we need some way to go back to older docs?
-    - Think this is overkill until there is a major revision
-  ☐ SCSS
-    ☐ Add line-height-densest typography utility class
-    ☐ Remove clearfix, or at least in any outputted styles
-  ☐ Need to add guide about how you can use the modules (ie by chaining or individually)
-  ☐ Need to add guide about configuration
-  ☐ Bring in common components
-    * Only what we would want to support in the core library!
-      * More specific modules should probably be handled like the vue components 
-      * Any module added should likely stay in the library indefinetly, so modules that are more opionated or used as infrequently should probably be made into their own package. Or if they don't seem like they have a future omitted
-    ☐ badge
-    ☐ tag
-    ☐ card
-    ☐ card grid
-    ☐ spinner
-Ideas:
-  ☐ Add scaffolding @idea

package/scss/_calculate.scss

@@ -1,64 +0,0 @@
-////
-/// @group calculate
-////
-
-@use "sass:math";
-@use "sass:map";
-@use "utils";
-
-/// Module Settings
-/// @type Map
-/// @prop {Number} $config.responsive-change Default responsive amount to modify items using responsive-property mixin
-
-$config: (
-  "responsive-change": 0.5vw
-) !default;
-
-/// Change modules $config
-/// @param {Map} $changes Map of changes
-///   @include module-name.set(( "property" : value ));
-@mixin set($changes) {
-  $config: map.merge($config, $changes) !global;
-}
-
-/// Get a config option
-/// @param {Map} $name Name of property
-///   @include module-name.get("property");
-
-@function get($name) {
-  @return utils.require-map-get($config, $name, "calculate [config]");
-}
-
-/// Calculate the size of something at a given scale (percentage/exponential)
-/// @param {Number} $base The number the scale starts at
-/// @param {Number} $ratio The amount the scale changes over one set
-/// @param {Number} $sizes The number of steps in the scale
-/// @param {Number} $size The step you are trying to calculate
-/// @return {Number}
-
-@function ratio-scale-size($base, $ratio, $sizes, $size) {
-  @return $base * math.pow($ratio, math.div($size, $sizes));
-}
-
-/// Convert from pixel to em
-/// @param {Number} $pixels The number the scale starts at
-/// @param {Number} $base How many pixels equal 1em
-/// @return {Number} Em Conversion
-
-@function pixel-to-em($pixels, $base: 16px) {
-  @return math.div($pixels, $base) + 1em;
-}
-
-/// Provides user with a fallback for a calc that's just an enhancement
-/// @param {String} $property The CSS property to set
-/// @param {*} $value The value to set on the property
-/// @param {Css} $responsive-change The amount to change (vw or vh units) (combined with unit past)
-
-@mixin responsive-property(
-  $property, 
-  $value, 
-  $responsive-change: get("responsive-change")
-) {
-  #{ $property } : $value;
-  #{ $property } : calc(#{ $value } + #{ $responsive-change });
-}

package/scss/_utility.scss

@@ -1,12 +0,0 @@
-////
-/// @group utility
-////
-
-@use "sass:math";
-
-/// Strips the unit from the number
-/// @link https://stackoverflow.com/questions/12328259/how-do-you-strip-the-unit-from-any-number-in-sass/12335841#12335841 Orginal source (Miriam Suzanne)
-
-@function strip-unit($value) {
-  @return math.div($value, ($value * 0 + 1));
-}

package/types/helpers/css-breakpoint.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"css-breakpoint.d.ts","sourceRoot":"","sources":["../../js/helpers/css-breakpoint.js"],"names":[],"mappings":"AAeA;;;;GAIG;AACH;IACE,wBAAsB;IACtB;;;;;;;MAOC;IACD;;;;;;;OAOG;IACH;QANyB,KAAK;QACL,cAAc;QACd,eAAe;QAChB,OAAO,EAApB,IAAI;QACW,cAAc;OAevC;IAXC,YAAkB;IAClB,cAAoB;IACpB,iBAAuB;IACvB,wBAA2B;IAC3B,mBAAyB;IACzB,gBAAqB;IACrB,yBAA2B;IAM7B;;;;;OAKG;IACH,mCAEC;IACD;;;OAGG;IACH,yCAEC;IACD;;OAEG;IACH,gCAEC;IACD;;OAEG;IACH,kCAEC;IACD;;OAEG;IACH,wBAMC;IACD;;OAEG;IACH,eA6CC;IACD;;;;OAIG;IACH,kBAFY,UAAU,CAQrB;CACF;;AAsED;;;GAGG;AACH;IACE,qCAQC;IAPC;;;;MAIC;IACD,cAAuB;IACvB,UAAgB;IAElB;;;;;OAKG;IACH,wDAEC;IACD;;;;;OAKG;IACH,6BAEC;IACD;;;;;OAKG;IACH,6BAEC;IACD;;;OAGG;IACH,8BAEC;IACD;;;;OAIG;IACH,mDAGC;IAED,yBAGC;CACF;AAnID;;;GAGG;AACH;IACE,6CAMC;IALC,eAA0B;IAC1B,gBAAmB;IACnB,UAAY;IACZ,WAAa;IACb,gBAA4B;IAE9B;;OAEG;IACH,sBAMC;IACD;;OAEG;IACH,4BAIC;IACD;;OAEG;IACH,+BAEC;IACD;;;;;OAKG;IACH,aAJW,cAAe,QAiBzB;IACD;;OAEG;IACH,2BAQC;CACF"}

package/types/helpers/file-save.d.ts

@@ -1,17 +0,0 @@
-export default FileSave;
-/**
- * @module helpers/file-save
- */
-declare class FileSave {
-    static isBrowserSupported(): boolean;
-    constructor(data: any, options: any);
-    filename: string;
-    type: string;
-    data: any;
-    blob: Blob;
-    url: string;
-    destroy(): void;
-    getUrl(): string;
-    createLink(text: any): any;
-}
-//# sourceMappingURL=file-save.d.ts.map

package/types/helpers/file-save.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"file-save.d.ts","sourceRoot":"","sources":["../../js/helpers/file-save.js"],"names":[],"mappings":";AAAA;;GAEG;AAoBH;IAwBE,qCAEC;IAzBD,qCAQC;IAPC,iBAAmC;IACnC,aAAsC;IAGtC,UAAgB;IAChB,WAAiD;IACjD,YAAyC;IAE3C,gBAEC;IACD,iBAEC;IACD,2BAOC;CAIF"}

package/types/helpers/node-data-manager.d.ts

@@ -1,45 +0,0 @@
-/**
- * @module helpers/node-data-manager
- */
-/**
- * Class that provides a method to store data based on node/element
- */
-export default class NodeDataManager {
-    store: any[];
-    /**
-     * Get data for an element/node
-     * @param {Node} node Html Node/Element to get data for
-     * @param {String|Boolean} key If key is passed, return that key's data for the element, if falsey return elements complete dataset
-     */
-    get(node: Node, key?: string | boolean): any;
-    /**
-     * Bind data to a specific Node/Element
-     * @param {Node} node Html Node/Element to get data for
-     * @param {String} key Key to save the data under
-     * @param {*} value Value to save
-     */
-    set(node: Node, key: string, value: any): void;
-    /**
-     * Return an elements store object
-     */
-    find(node: any): any;
-    /**
-     * Destroy all references to data and nodes/elements
-     */
-    destroy(): void;
-}
-/**
- * Child class that provides a store for one specific node/element
- */
-export class NodeDataStore {
-    constructor(node: any, data: any);
-    node: any;
-    data: any;
-    set(key: any, value: any): void;
-    get(key?: boolean): any;
-    remove(key: any): void;
-    isNode(node: any): any;
-    clearData(): void;
-    destroy(): void;
-}
-//# sourceMappingURL=node-data-manager.d.ts.map

package/types/helpers/node-data-manager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"node-data-manager.d.ts","sourceRoot":"","sources":["../../js/helpers/node-data-manager.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH;IAEI,aAAe;IAEjB;;;;OAIG;IACH,UAHW,IAAI,QACJ,gBAAc,OAOxB;IACD;;;;;OAKG;IACH,UAJW,IAAI,iCAWd;IACD;;OAEG;IACH,qBAEC;IACD;;OAEG;IACH,gBAGC;CACF;AACD;;GAEG;AACH;IACE,kCAGC;IAFC,UAAgB;IAChB,UAAsB;IAExB,gCAEC;IACD,wBAEC;IACD,uBAEC;IACD,uBAEC;IACD,kBAEC;IACD,gBAGC;CACF"}

package/types/helpers/pause-youtube-video.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pause-youtube-video.d.ts","sourceRoot":"","sources":["../../js/helpers/pause-youtube-video.js"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,sCAFW,OAAO,GAAC,IAAI,QAWtB;AACD;;;;GAIG;AACH,qDAQC"}

package/types/helpers/scrollbar-width-property.d.ts

@@ -1,11 +0,0 @@
-/**
- * @module helpers/scrollbar-width-property
- */
-/**
- * Sets a CSS custom property equal to the scrollbar width
- * @param {Node} element The element that is the child of a scrollabel container
- * @param {Node} container The container that can be scrolled
- * @param {Stirng} propName Custom property to set
- */
-export default function addScrollbarProperty(element?: Node, container?: Node, propName?: Stirng): void;
-//# sourceMappingURL=scrollbar-width-property.d.ts.map

package/types/helpers/scrollbar-width-property.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"scrollbar-width-property.d.ts","sourceRoot":"","sources":["../../js/helpers/scrollbar-width-property.js"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,uDAJW,IAAI,cACJ,IAAI,2BAMd"}

package/types/ui/modals.d.ts

@@ -1,27 +0,0 @@
-export function attachTriggers(context?: Document): void;
-/**
- * Function to setup each modal
- * - Creates structure
- * - Gets settings from elements data attrite
- * - Moves it to the end of the document
- * - Adds resizer if position (left || right)
- * @param {Node} modal Modal element ie. `[data-site-modal]`
- * @param {Object} settings Custom settings object to merge, same interface as `[data-site-modal]` settings
- */
-export function setupModal(modal: Node, settings: any): void;
-/**
- * Intialize all modals on the page
- * - can be used after AJAX adds content
- */
-/**
- * Open a modal
- * @param {String} id The id of the modal to open
- */
-export function show(id: string, config: any): void;
-/**
- * Close a modal
- * @param {String} id The id of the modal to open
- */
-export function close(id: string): void;
-export const triggerAttr: "data-site-modal-trigger";
-//# sourceMappingURL=modals.d.ts.map

package/types/ui/modals.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"modals.d.ts","sourceRoot":"","sources":["../../js/ui/modals.js"],"names":[],"mappings":"AA6DA,yDAeC;AAED;;;;;;;;GAQG;AACH,kCAHW,IAAI,uBAmFd;AACD;;;GAGG;AAIH;;;GAGG;AACH,oDAGC;AACD;;;GAGG;AACH,wCAEC;AAlKD,oDAA8C"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../js/utils/logger.js"],"names":[],"mappings":"AAgCA;;;GAGG;AACH,wCAEC;AAED;;;;GAIG;AACH,+CAFe,GAAG,UAMjB;AAED;;;;GAIG;AACH,sDAFe,GAAG,UAMjB;AAED;;;;GAIG;AACH,oDAFe,GAAG,UAMjB"}

package/vite.config.js

@@ -1,36 +0,0 @@
-import { dirname, resolve } from "path";
-import { fileURLToPath } from "url";
-import { defineConfig } from "vite";
-import autoprefixer from "autoprefixer";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-export default defineConfig({
-  build: {
-    // target: "es2015",
-    // manifest: true,
-    minify: true,
-    cssMinify: true,
-    cssCodeSplit: false,
-    outDir: "dist",
-    rollupOptions: {
-      input: "dist-src/main.js",
-      output: {
-        entryFileNames: `ulu-frontend.min.js`,
-        assetFileNames: `ulu-frontend.min.[ext]`,
-      },
-    },
-  },
-  css: {
-    postcss: {
-      plugins: [
-        autoprefixer()
-      ],
-    },
-    preprocessorOptions: {
-      scss: {
-        includePaths: [resolve(__dirname, `./scss`)],
-      },
-    },
-  },
-});