@ulu/frontend 0.0.6 → 0.0.7

package/README.md

@@ -2,9 +2,7 @@
 
 Front end development library (SCSS, JS, Vue)
 
-[SCSS Documentation](https://jscherbe.github.io/frontend/scss/)
-
-[JS Documentation](https://jscherbe.github.io/frontend/js/)
+[Documentation](https://jscherbe.github.io/frontend/)
 
 ## SCSS Library
 

package/js/helpers/css-breakpoint.js

@@ -1,23 +1,21 @@
 /**
- * @module css-breakpoint
+ * @module helpers/css-breakpoint
  */
 
-// Description:     Pass breakpoints from CSS to stylesheet, use this to attach 
-//                  behaviors on breakpoints
-
+// Pass breakpoints from CSS to stylesheet, use this to attach behaviors on breakpoints
 import { debounce } from "@ulu/utils/performance";
 import { removeArrayElement } from "@ulu/utils/array";
 import { getName } from "../events/index.js";
 import { log, logError } from "../utils/logger.js";
 
-/**
- * Resize Handler to update breakpoints for all instances (Called after resize finished)
- */
+
+// Resize Handler to update breakpoints for all instances (Called after resize finished)
 window.addEventListener(getName("pageResized"), () => {
   CssBreakpoints.instances.forEach(i => i.update());
 });
 
 /**
+ * @class
  * Class that provides method for retrieving and acting on breakpoints passed
  * from CSS (using element psuedo content prop)
  */
@@ -112,6 +110,7 @@ export class CssBreakpoints {
   }
 }
 /**
+ * @class
  * Used to handle a breakpoints direction's handler and state
  */
 class BreakpointDirection {
@@ -180,6 +179,7 @@ class BreakpointDirection {
   }
 }
 /**
+ * @class
  * Single breakpoint management
  */
 class Breakpoint {

package/js/helpers/file-save.js

@@ -1,5 +1,5 @@
 /**
- * @module file-save
+ * @module helpers/file-save
  */
 
 // Description:     Simple script that is useful for testing. It will:

package/js/helpers/node-data-manager.js

@@ -1,5 +1,5 @@
 /**
- * @module node-data-manager
+ * @module helpers/node-data-manager
  */
 
 /**

package/js/helpers/pause-youtube-video.js

@@ -1,5 +1,5 @@
 /**
- * @module pause-youtube-video
+ * @module helpers/pause-youtube-video
  */
 
 // Version:         1.0.4

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

@@ -1,5 +1,5 @@
 /**
- * @module scrollbar-width-property
+ * @module helpers/scrollbar-width-property
  */
 
 /**

package/js/ui/flipcard.js

@@ -1,5 +1,5 @@
 /**
- * @module flipcard
+ * @module ui/flipcard
  */
 
 // =============================================================================

package/js/ui/grid.js

@@ -1,5 +1,5 @@
 /**
- * @module grid
+ * @module ui/grid
  */
 
 import { getName } from "../events/index.js";

package/js/ui/modals.js

@@ -1,5 +1,5 @@
 /**
- * @module modals
+ * @module ui/modals
  */
 // Version:         1.0.4
 // Changes:

package/js/ui/overflow-scroller-pager.js

@@ -1,5 +1,5 @@
 /**
- * @module overflow-scroller-pager
+ * @module ui/overflow-scroller-pager
  */
 /**
  * Function to be used in overflow scrollers "amount" option. This function will

package/js/ui/overflow-scroller.js

@@ -1,5 +1,5 @@
 /**
- * @module overflow-scroller
+ * @module ui/overflow-scroller
  */
 /**
  * @todo - Need to have scroll handler check scroll position

package/js/ui/programmatic-modal.js

@@ -1,5 +1,5 @@
 /**
- * @module programmatic-modal
+ * @module ui/programmatic-modal
  */
 // =============================================================================
 // Grabs Breakpoint from CSS

package/js/ui/resizer.js

@@ -1,5 +1,5 @@
 /**
- * @module resizer
+ * @module ui/resizer
  */
 // =============================================================================
 // Element Resizer

package/js/ui/slider.js

@@ -1,5 +1,5 @@
 /**
- * @module slider
+ * @module ui/slider
  */
 // =============================================================================
 // Slider

package/js/ui/tabs.js

@@ -1,5 +1,5 @@
 /**
- * @module tabs
+ * @module ui/tabs
  */
 // =============================================================================
 // Tabs

package/js/ui/tooltip.js

@@ -1,5 +1,5 @@
 /**
- * @module tooltip
+ * @module ui/tooltip
  */
 // =============================================================================
 // Tooltip

package/js/utils/logger.js

@@ -1,5 +1,5 @@
 /**
- * @module logger
+ * @module utils/logger
  */
 // Goal: minimzing console conditions for nessasary production log statements
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ulu/frontend",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Theming library",
   "browser": "js/index.js",
   "main": "index.js",
@@ -15,7 +15,7 @@
     "docs:preview": "vitepress preview docs-src",
     "docs:update:scss": "node ./docs-src/.vitepress/sassdoc.js",
     "docs:update:scss:debug": "node --inspect-brk ./docs-src/.vitepress/sassdoc.js",
-    "docs:build:js": "node_modules/.bin/jsdoc -c jsdoc.json"
+    "docs:build:js": "node ./docs-src/.vitepress/jsdoc.js"
   },
   "repository": {
     "type": "git",
@@ -37,10 +37,13 @@
   },
   "homepage": "https://github.com/Jscherbe/frontend#readme",
   "devDependencies": {
+    "@ulu/utils": "^0.0.4",
     "@ulu/vitepress-auto-menus": "^0.0.3",
     "@ulu/vitepress-sassdoc": "^0.0.6",
     "clean-jsdoc-theme": "^4.2.17",
+    "fs-extra": "^11.2.0",
     "jsdoc": "^4.0.2",
+    "jsdoc-to-markdown": "^8.0.0",
     "sass": "^1.51.0",
     "vitepress": "^1.0.0-rc.27"
   }