@ulu/frontend-vue 0.6.0 → 0.6.2

package/dist/plugins/breakpoints/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/breakpoints/index.js"],"names":[],"mappings":"AAiBA;;;;;;;;;GASG;AACH,qCALW,MAAM,eAEd;IAA6B,gBAAgB;IAChB,cAAc;CAC7C,QA8BA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/breakpoints/index.js"],"names":[],"mappings":"AAoBA;;;;;;;;;GASG;AACH,qCALW,MAAM,eAEd;IAA6B,gBAAgB;IAChB,cAAc;CAC7C,QA8BA"}

package/dist/plugins/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/core/index.js"],"names":[],"mappings":"AAoCA;;;;;;;;;;GAUG;AACH,qCAPW,MAAM,iBAEd;IAA+B,iBAAiB;IAClB,aAAa;IACX,gBAAgB;IAClB,WAAW;CAC3C,QA0DA;AAtED,gCAA0D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/core/index.js"],"names":[],"mappings":"AAqCA;;;;;;;;;;GAUG;AACH,qCAPW,MAAM,iBAEd;IAA+B,iBAAiB;IAClB,aAAa;IACX,gBAAgB;IAClB,WAAW;CAC3C,QA0DA;AAtED,gCAA0D"}

package/dist/plugins/index.d.ts

@@ -1,6 +1,6 @@
 export { default as corePlugin } from './core/index.js';
-export { default as modalsPlugin } from './modals/index.js';
 export { default as toastPlugin } from './toast/index.js';
 export { default as breakpointsPlugin } from './breakpoints/index.js';
 export { default as popoversPlugin, useTooltip, useTooltipFollow } from './popovers/index.js';
+export { default as modalsPlugin, useModals } from './modals/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/plugins/modals/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/api.js"],"names":[],"mappings":";;;;AA6BO;;IAML;;;;OAIG;;IAKH;;;OAGG;oBADS,MAAM;IAUlB;;OAEG;;IAKH;;;OAGG;uBADS,MAAM;EAUlB;AAxDF;;GAEG;AACH;;;EAAyB;AAnBzB,4BAAkB"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/api.js"],"names":[],"mappings":";;;;AAgCO;;IAML;;;;OAIG;;IAKH;;;OAGG;oBADS,MAAM;IAUlB;;OAEG;;IAKH;;;OAGG;uBADS,MAAM;EAUlB;AAxDF;;GAEG;AACH;;;EAAyB;AAnBzB,4BAAkB"}

package/dist/plugins/modals/index.d.ts

@@ -1,9 +1,11 @@
+import { useModals } from './useModals.js';
 /**
  * Modals Vue Plugin
  * @param {Object} App Vue app instance passed to plugin
  * @param {UluModalsPluginOptions} userOptions Options to change (see defaults)
  */
 export default function install(app: any, userOptions: UluModalsPluginOptions): void;
+export { useModals };
 /**
  * Default plugin options
  */

package/dist/plugins/modals/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/index.js"],"names":[],"mappings":"AAsBA;;;;GAIG;AACH,uDAFW,sBAAsB,QA8BhC;;;;;;;;;;;;kBAxCa,eAAe"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/index.js"],"names":[],"mappings":"AAsBA;;;;GAIG;AACH,uDAFW,sBAAsB,QA8BhC;;;;;;;;;;;;;kBAxCa,eAAe;;0BANH,gBAAgB"}

package/dist/plugins/modals/useModals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useModals.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/useModals.js"],"names":[],"mappings":"AASO,6BAHM,MAAM,CASlB"}
+{"version":3,"file":"useModals.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/useModals.js"],"names":[],"mappings":"AAYO,6BAHM,MAAM,CASlB"}

package/dist/plugins/modals/useModals.js

@@ -0,0 +1,10 @@
+import { inject as r } from "vue";
+const l = () => {
+  const o = r("uluModals");
+  if (!o)
+    throw new Error("Modals plugin not installed");
+  return o;
+};
+export {
+  l as useModals
+};

package/dist/plugins/popovers/defaults.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/defaults.js"],"names":[],"mappings":";gBAGY,MAAM;;;;;;;;;iBA8CN,MAAM"}
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/defaults.js"],"names":[],"mappings":";gBAMY,MAAM;;;;;;;;;iBA8CN,MAAM"}

package/dist/plugins/popovers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/index.js"],"names":[],"mappings":"AAiDA;;;;GAIG;AACH,qCAHW,MAAM,gBACN,MAAM,QAgJhB;AA9LD;;GAEG;AACH,kCAAmC,mBAAmB,CAAC;AAEvD;;GAEG;AACH,gCAAiC,iBAAiB,CAAC;AAEnD;;GAEG;AACH,yBAA0B,oBAAoB,CAAC;;;AAcxC,gDAJI,GAAC,mBACD,MAAM,GACJ,MAAM,GAAC,IAAI,CAgBvB;2BA3C0B,iBAAiB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/index.js"],"names":[],"mappings":"AAoDA;;;;GAIG;AACH,qCAHW,MAAM,gBACN,MAAM,QAgJhB;AA9LD;;GAEG;AACH,kCAAmC,mBAAmB,CAAC;AAEvD;;GAEG;AACH,gCAAiC,iBAAiB,CAAC;AAEnD;;GAEG;AACH,yBAA0B,oBAAoB,CAAC;;;AAcxC,gDAJI,GAAC,mBACD,MAAM,GACJ,MAAM,GAAC,IAAI,CAgBvB;2BA3C0B,iBAAiB"}

package/dist/plugins/popovers/useTooltip.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTooltip.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/useTooltip.js"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,8BAFa;IAAC,WAAW,WAAW;IAAC,WAAW,WAAW;IAAC,YAAY,EAAE,MAAM,CAAA;CAAC,CAmBhF"}
+{"version":3,"file":"useTooltip.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/useTooltip.js"],"names":[],"mappings":"AAMA;;;;;GAKG;AACH,8BAFa;IAAC,WAAW,WAAW;IAAC,WAAW,WAAW;IAAC,YAAY,EAAE,MAAM,CAAA;CAAC,CAmBhF"}

package/dist/plugins/popovers/useTooltipFollow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTooltipFollow.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/useTooltipFollow.js"],"names":[],"mappings":"AAKA;;;;;;EA4DC"}
+{"version":3,"file":"useTooltipFollow.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/useTooltipFollow.js"],"names":[],"mappings":"AAQA;;;;;;EA4DC"}

package/dist/plugins/toast/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/toast/index.js"],"names":[],"mappings":"AAIA;;GAEG;AACH,kEASC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/toast/index.js"],"names":[],"mappings":"AAOA;;GAEG;AACH,kEASC"}

package/dist/plugins/toast/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../lib/plugins/toast/store.js"],"names":[],"mappings":"AAMA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwBG;;IAMD;;;;OAIG;IACH,sBAHW,MAAM,OAYhB;IACD;;;OAGG;IACH,gCAKC;IACD;;OAEG;IACH,2BAEC"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../lib/plugins/toast/store.js"],"names":[],"mappings":"AASA;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwBG;;IAMD;;;;OAIG;IACH,sBAHW,MAAM,OAYhB;IACD;;;OAGG;IACH,gCAKC;IACD;;OAEG;IACH,2BAEC"}

package/dist/plugins/toast/useToast.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useToast.d.ts","sourceRoot":"","sources":["../../../lib/plugins/toast/useToast.js"],"names":[],"mappings":"AAWO,4BAPM,MAAM,CAalB"}
+{"version":3,"file":"useToast.d.ts","sourceRoot":"","sources":["../../../lib/plugins/toast/useToast.js"],"names":[],"mappings":"AAcO,4BAPM,MAAM,CAalB"}

package/dist/resolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["../lib/resolver.js"],"names":[],"mappings":"AAQA;;;;;GAKG;AACH,iEAHG;IAA+B,QAAQ,EAA/B,KAAK,QAAQ;CACrB,OAeF"}
+{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["../lib/resolver.js"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,iEAHG;IAA+B,QAAQ,EAA/B,KAAK,QAAQ;CACrB,OAeF"}

package/dist/utils/dom.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @module utils.dom
+ */
 /**
  * Resolves a Vue template ref's unwrapped value to its underlying DOM element
  *

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

@@ -1 +1 @@
-{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../lib/utils/dom.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oCAHW,WAAW,GAAC,MAAM,GAChB,WAAW,CASvB;AAKD;;;;;;GAMG;AACH,+BAHW,MAAM,GACJ,MAAM,CASlB"}
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../lib/utils/dom.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;GAKG;AACH,oCAHW,WAAW,GAAC,MAAM,GAChB,WAAW,CASvB;AAKD;;;;;;GAMG;AACH,+BAHW,MAAM,GACJ,MAAM,CASlB"}

package/dist/utils/props.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @module utils.props
+ */
 /**
  * Ensures the array consists of objects
  * @param {Array} array Array to check

package/dist/utils/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../lib/utils/props.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wDAEC;AAED;;;;;GAKG;AACH,4CAJW,MAAM,mBACN,MAAM,EAAE,4BASlB"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../lib/utils/props.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;GAIG;AACH,wDAEC;AAED;;;;;GAKG;AACH,4CAJW,MAAM,mBACN,MAAM,EAAE,4BASlB"}

package/dist/utils/router.d.ts

@@ -1,8 +1,9 @@
 /**
- * This Module Creates Menus from route or router config
- * - Note: Functions prefixed with "$" work with $route objects (running application, provided by vue-router ie $router, useRoute, etc),
- * @module router-utils
+ * @module utils.router
  */
+/**
+ * This Module Creates Menus from route or router config
+
 /**
  * Resolves a route's title from its meta.
  * - If `meta.title` is a function, it's called with the `currentRoute` (or the route itself).
@@ -25,7 +26,7 @@ export function getRouteTitle(route: object, currentRoute?: object): string | un
  * @param {Object} options Options
  * @param {Object} options.qualifier Callback to qualify as a base route (defaults to isStaticBaseRoute)
  * @param {Object} options.item Options for createMenuItem
- * @returns {Array.<RouteMenuItem>} Array of menu items
+ * @returns {Array<RouteMenuItem>} Array of menu items
  */
 export function createBaseMenu(routes: any, options: {
     qualifier: Object;
@@ -42,9 +43,9 @@ export function flattenMenu(menu: Array<RouteMenuItem>): Array<RouteMenuItem>;
  * @param {*} routes All routes
  * @param {*} sectionPath Path for section to create menu
  * @param {Object} options Options
- * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie ({ path: "" })
+ * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie path: ""
  * @param {Object} options.item Options to be passed to createMenuItem
- * @returns {Array.<RouteMenuItem>} Array of menu items
+ * @returns {Array<RouteMenuItem>} Array of menu items
  */
 export function createSectionMenu(routes: any, sectionPath: any, options: {
     includeIndex: boolean;
@@ -82,7 +83,7 @@ export function isStaticRoute(route: Object): boolean;
  */
 export function isStaticBaseRoute(route: Object): boolean;
 /**
- * Function to make normal <a> behave as router links instread of page reload
+ * Function to make normal `<a>` behave as router links instread of page reload
  * @param {Object} router Router instance (ie src/router) to push routes to
  * @param {Object} event The event object that triggered route change (ie. onclick) pass event object
  */
@@ -107,9 +108,9 @@ export function $getParentRoute(route: Object, deepest: Object): Object | null;
  * @param {Object} route Actual $route object
  * @param {Object} options Options
  * @param {Object} options.parent Route parent object, defaults to parent of route
- * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie ({ path: "" })
+ * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie path: ""
  * @param {Object} options.item Options for createMenuItem
- * @returns {Array.<RouteMenuItem>} Array of menu items
+ * @returns {Array<RouteMenuItem>} Array of menu items
  */
 export function $createSectionMenu(route: Object, options: {
     parent: Object;
@@ -123,13 +124,9 @@ export function $createSectionMenu(route: Object, options: {
  * - Skips routes where `meta.breadcrumb` is set to `false`.
  * - Avoids duplicate crumbs for nested routes with empty paths.
  * @param {Object} route The Vue Router `$route` object.
- * @returns {Array.<{title: String, to: Object, current: Boolean}>} An array of breadcrumb items.
+ * @returns {Array<Object>} An array of breadcrumb items with title, to, and current properties.
  */
-export function $createBreadcrumb(route: Object): Array<{
-    title: string;
-    to: Object;
-    current: boolean;
-}>;
+export function $createBreadcrumb(route: Object): Array<Object>;
 /**
  * Route Menu Item
  */

package/dist/utils/router.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../lib/utils/router.js"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;GAQG;AACH,qCAJW,MAAM,iBACN,MAAM,GACJ,MAAM,GAAC,SAAS,CAW5B;AAED;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,uCANW,GAAC,WAET;IAAwB,SAAS,EAAzB,MAAM;IACU,IAAI,EAApB,MAAM;CACd,GAAU,KAAK,CAAE,aAAa,CAAC,CAgCjC;AAED;;;;GAIG;AACH,kCAHW,KAAK,CAAC,aAAa,CAAC,GAClB,KAAK,CAAC,aAAa,CAAC,CAgBhC;AAED;;;;;;;;GAQG;AACH,0CAPW,GAAC,eACD,GAAC,WAET;IAAyB,YAAY;IACb,IAAI,EAApB,MAAM;CACd,GAAU,KAAK,CAAE,aAAa,CAAC,CA4BjC;AAED;;;;GAIG;AACH,qDAFa,MAAM,CAIlB;AAED;;;;;;;;GAQG;AACH,sCAPW,MAAM,aACN,MAAM,uBAEd;IAA0B,MAAM;IACN,SAAS;CACnC,GAAU,aAAa,CAuBzB;AAED;;;;GAIG;AACH,qCAHW,MAAM,WAKhB;AAED;;;;GAIG;AACH,yCAHW,MAAM,WAMhB;AAED;;;;GAIG;AACH,yCAHW,MAAM,SACN,MAAM,QAYhB;AAED;;;;GAIG;AACH,yCAHW,MAAM,2BACJ,KAAK,CAAC,MAAM,CAAC,GAAC,SAAS,CAInC;AAED;;;;;GAKG;AACH,uCAJW,MAAM,WACN,MAAM,GACL,MAAM,OAAK,CAUtB;AAUD;;;;;;;;;;GAUG;AACH,0CAPW,MAAM,WAEd;IAAwB,MAAM,EAAtB,MAAM;IACW,YAAY;IACb,IAAI,EAApB,MAAM;CACd,GAAU,KAAK,CAAE,aAAa,CAAC,CAgBjC;AAED;;;;;;;;GAQG;AACH,yCAHW,MAAM,GACJ,KAAK,CAAE;IAAC,KAAK,SAAS;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,UAAS;CAAC,CAAC,CAmCjE"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../lib/utils/router.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;;;;;;;;;;;GAWG;AACH,qCAJW,MAAM,iBACN,MAAM,GACJ,MAAM,GAAC,SAAS,CAW5B;AAED;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,uCANW,GAAC,WAET;IAAwB,SAAS,EAAzB,MAAM;IACU,IAAI,EAApB,MAAM;CACd,GAAU,KAAK,CAAC,aAAa,CAAC,CAgChC;AAED;;;;GAIG;AACH,kCAHW,KAAK,CAAC,aAAa,CAAC,GAClB,KAAK,CAAC,aAAa,CAAC,CAgBhC;AAED;;;;;;;;GAQG;AACH,0CAPW,GAAC,eACD,GAAC,WAET;IAAyB,YAAY;IACb,IAAI,EAApB,MAAM;CACd,GAAU,KAAK,CAAC,aAAa,CAAC,CA4BhC;AAED;;;;GAIG;AACH,qDAFa,MAAM,CAIlB;AAED;;;;;;;;GAQG;AACH,sCAPW,MAAM,aACN,MAAM,uBAEd;IAA0B,MAAM;IACN,SAAS;CACnC,GAAU,aAAa,CAuBzB;AAED;;;;GAIG;AACH,qCAHW,MAAM,WAKhB;AAED;;;;GAIG;AACH,yCAHW,MAAM,WAMhB;AAED;;;;GAIG;AACH,yCAHW,MAAM,SACN,MAAM,QAYhB;AAED;;;;GAIG;AACH,yCAHW,MAAM,2BACJ,KAAK,CAAC,MAAM,CAAC,GAAC,SAAS,CAInC;AAED;;;;;GAKG;AACH,uCAJW,MAAM,WACN,MAAM,GACL,MAAM,OAAK,CAUtB;AAUD;;;;;;;;;;GAUG;AACH,0CAPW,MAAM,WAEd;IAAwB,MAAM,EAAtB,MAAM;IACW,YAAY;IACb,IAAI,EAApB,MAAM;CACd,GAAU,KAAK,CAAC,aAAa,CAAC,CAgBhC;AAED;;;;;;;;GAQG;AACH,yCAHW,MAAM,GACJ,KAAK,CAAC,MAAM,CAAC,CAmCzB"}

package/lib/components/elements/UluBadge.vue

@@ -1,11 +1,7 @@
 <template>
   <component 
     class="badge" 
-    :class="[
-      size ? `badge--${ size }` : null,
-      type ? `badge--${ type }` : null,
-      { 'badge--clickable' : isInteractive }
-    ]"
+    :class="resolvedModifiers"
     :is="element"
     :to="to"
     :href="href"
@@ -29,6 +25,7 @@
 <script setup>
   import { computed } from "vue";
   import { RouterLink } from "vue-router";
+  import { useModifiers } from "../../composables/useModifiers.js";
 
   const props = defineProps({
     /**
@@ -63,12 +60,26 @@
      * A URL. Renders as a standard <a> tag.
      */
     href: String,
+    /**
+     * Modifiers (to add any modifier classes based on base class [ie. 'tertiary'])
+     */
+    modifiers: [String, Array]
   });
 
   const isInteractive = computed(() => {
     return Boolean(props.to || props.click);
   });
 
+  const { resolvedModifiers } = useModifiers({ 
+    props, 
+    baseClass: "badge",
+    internal: computed(() => ({
+      [props.size] : props.size,
+      [props.type] : props.type,
+      "clickable" : isInteractive.value
+    }))
+  });
+
   const element = computed(() => {
     const { click, to, href } = props;
     /* eslint-disable */

package/lib/components/index.js

@@ -1,3 +1,6 @@
+/**
+ * @module components
+ */
 /**
  * @module components/index.js
  * Responsible for exporting all components

package/lib/components/systems/facets/useFacets.js

@@ -1,3 +1,6 @@
+/**
+ * @module useFacets
+ */
 import { ref, computed, watch, watchPostEffect } from "vue";
 import Fuse from "fuse.js";
 

package/lib/components/systems/index.js

@@ -1,3 +1,6 @@
+/**
+ * @module systems
+ */
 export { useFacets } from './facets/useFacets.js';
 export { default as UluFacetsActiveFilters } from './facets/UluFacetsActiveFilters.vue';
 export { default as UluFacetsFilterLists } from './facets/UluFacetsFilterLists.vue';

package/lib/components/systems/scroll-anchors/useScrollAnchorSection.js

@@ -1,3 +1,6 @@
+/**
+ * @module useScrollAnchorSection
+ */
 import { ref, onMounted, onUnmounted, inject, computed, reactive, watch } from 'vue';
 import { urlize } from '@ulu/utils/string.js';
 

package/lib/components/systems/scroll-anchors/useScrollAnchorSections.js

@@ -1,3 +1,6 @@
+/**
+ * @module useScrollAnchorSections
+ */
 import { inject } from 'vue';
 
 /**

package/lib/components/systems/scroll-anchors/useScrollAnchors.js

@@ -1,3 +1,6 @@
+/**
+ * @module useScrollAnchors
+ */
 import { onMounted, onUnmounted, nextTick, watch } from "vue";
 import { getScrollParent } from "@ulu/utils/browser/dom.js";
 import { debounce } from "@ulu/utils/performance.js";

package/lib/composables/useBreakpointManager.js

@@ -1,3 +1,6 @@
+/**
+ * @module useBreakpointManager
+ */
 import { ref, markRaw } from "vue";
 import { isBrowser } from "@ulu/utils/browser/dom.js";
 

package/lib/composables/useDocumentTitle.js

@@ -1,3 +1,6 @@
+/**
+ * @module useDocumentTitle
+ */
 import { reactive, watchEffect, onUnmounted, unref, computed } from "vue";
 import { useHead as defaultUseHead } from "@unhead/vue";
 import { useRoute as defaultUseRoute } from "vue-router";

package/lib/composables/useIcon.js

@@ -1,3 +1,6 @@
+/**
+ * @module useIcon
+ */
 /**
  * A utility composable for handling and formatting icon props for `UluIcon`.
  * It provides helpers to convert various icon definition formats into either

package/lib/composables/useModifiers.js

@@ -1,5 +1,7 @@
 /**
- * @module composables/useModifiers
+ * @module useModifiers
+ */
+/**
  * Handles user modifiers prop and internal modifiers for a given component
  */
 

package/lib/composables/usePagination.js

@@ -1,3 +1,6 @@
+/**
+ * @module usePagination
+ */
 import { computed, watch } from "vue";
 import { useRoute, useRouter } from "vue-router";
 

package/lib/composables/useRequiredInject.js

@@ -1,3 +1,6 @@
+/**
+ * @module useRequiredInject
+ */
 import { inject } from 'vue';
 import { injectRegistry } from "../meta.js";
 

package/lib/composables/useTableData.js

@@ -1,3 +1,6 @@
+/**
+ * @module useTableData
+ */
 import { ref, computed, watch } from 'vue';
 
 /**

package/lib/composables/useUluFloating.js

@@ -1,3 +1,6 @@
+/**
+ * @module useUluFloating
+ */
 import { ref, computed, watch } from "vue";
 import { 
   useFloating,

package/lib/composables/useWindowResize.js

@@ -1,3 +1,6 @@
+/**
+ * @module useWindowResize
+ */
 /**
  * Reusable window resize
  * - Future could have request animation frame throttled onResize

package/lib/index.js

@@ -1,5 +1,5 @@
 /**
- * @module index.js
+ * @module index
  * - Main library entrypoint
  * - Exports everything
  */

package/lib/meta.js

@@ -1,5 +1,5 @@
 /**
- * @module lib/meta
+ * @module meta
  * @description A central lookup for meta like info in the system
  */
 

package/lib/plugins/breakpoints/index.js

@@ -1,3 +1,6 @@
+/**
+ * @module breakpointsPlugin
+ */
 import { ref, computed } from "vue";
 import { useBreakpointManager } from "../../composables/useBreakpointManager.js";
 

package/lib/plugins/core/index.js

@@ -1,7 +1,8 @@
 /**
- * @module plugins/core/index.js
+ * @module corePlugin
  * @description Core plugin for managing shared configuration for the library.
  */
+
 import { reactive } from 'vue';
 
 const defaults = {

package/lib/plugins/index.js

@@ -1,5 +1,5 @@
 /**
- * @module plugins/index.js
+ * @module plugins
  * Responsible for exporting all plugins
  * - Used in bundle exports
  */
@@ -7,6 +7,6 @@
 
 export { default as corePlugin } from './core/index.js';
 export { default as popoversPlugin, useTooltip, useTooltipFollow } from './popovers/index.js';
-export { default as modalsPlugin } from './modals/index.js';
+export { default as modalsPlugin, useModals } from './modals/index.js';
 export { default as toastPlugin } from './toast/index.js';
 export { default as breakpointsPlugin } from './breakpoints/index.js';

package/lib/plugins/modals/api.js

@@ -1,3 +1,6 @@
+/**
+ * @module modals.api
+ */
 import { ref, markRaw } from "vue";
 
 // Create array to be used internally to manage individual modals

package/lib/plugins/modals/index.js

@@ -1,13 +1,13 @@
 /**
- * @module plugins/modals/index.js
- * @version 3.0.0
- * Modals plugin (adds components, global registry, etc)
+ * @module modalsPlugin
+ * @description Modals plugin (adds components, global registry, etc)
  * - Updated version handles both independent and global registered/triggered modals
  */
 
 import UluModalsDisplay from "./UluModalsDisplay.vue";
 import UluModal from "../../components/collapsible/UluModal.vue";
 import { createApi, modalsState } from "./api.js";
+import { useModals } from "./useModals.js";
 
 /**
  * Default plugin options
@@ -53,4 +53,9 @@ export default function install(app, userOptions) {
   // Global property for modals component to access state
   // and for debugging logging if needed
   app.config.globalProperties.$uluModalsState = modalsState;
-}
+}
+
+/**
+ * Public export for composable function
+ */
+export { useModals };

package/lib/plugins/modals/useModals.js

@@ -1,3 +1,6 @@
+/**
+ * @module useModals
+ */
 import { inject } from 'vue';
 
 /**

package/lib/plugins/popovers/defaults.js

@@ -1,3 +1,6 @@
+/**
+ * @module popovers.defaults
+ */
 export default {
   /**
    * Default Plugin Options

package/lib/plugins/popovers/index.js

@@ -1,3 +1,6 @@
+/**
+ * @module popoversPlugin
+ */
 import { reactive, markRaw } from 'vue';
 import UluTooltipDisplay from './UluTooltipDisplay.vue';
 import UluPopover from "./UluPopover.vue";

package/lib/plugins/popovers/useTooltip.js

@@ -1,3 +1,6 @@
+/**
+ * @module useTooltip
+ */
 import { useRequiredInject } from '../../composables/useRequiredInject.js';
 import { TOOLTIP_STATE_KEY, POPOVER_OPTIONS_KEY, resolveTooltipConfig } from './index.js';
 

package/lib/plugins/popovers/useTooltipFollow.js

@@ -1,3 +1,6 @@
+/**
+ * @module useTooltipFollow
+ */
 import { ref, computed } from "vue";
 import { useRequiredInject } from '../../composables/useRequiredInject.js';
 import { TOOLTIP_STATE_KEY, POPOVER_OPTIONS_KEY } from './index.js';

package/lib/plugins/toast/defaults.js

@@ -1,3 +1,6 @@
+/**
+ * @module toast.defaults
+ */
 import { markRaw } from "vue";
 import ToastComponent from "./UluToast.vue";
 /**

package/lib/plugins/toast/index.js

@@ -1,3 +1,6 @@
+/**
+ * @module toastPlugin
+ */
 import { store, api } from "./store.js";
 import UluToast from "./UluToast.vue";
 import UluToastDisplay from "./UluToastDisplay.vue";

package/lib/plugins/toast/store.js

@@ -1,3 +1,6 @@
+/**
+ * @module toast.store
+ */
 import { reactive } from "vue";
 import defaults from "./defaults.js";
 

package/lib/plugins/toast/useToast.js

@@ -1,3 +1,6 @@
+/**
+ * @module useToast
+ */
 import { inject } from 'vue';
 
 /**

package/lib/resolver.js

@@ -1,3 +1,6 @@
+/**
+ * @module resolver
+ */
 const defaultExcluded = [
   "UluModalsDisplay",
   "UluTooltipDisplay",

package/lib/utils/dom.js

@@ -1,3 +1,6 @@
+/**
+ * @module utils.dom
+ */
 /**
  * Resolves a Vue template ref's unwrapped value to its underlying DOM element
  *

package/lib/utils/index.js

@@ -1,2 +1,5 @@
+/**
+ * @module utils
+ */
 export * as dom from './dom.js';
 export * as router from './router.js';

package/lib/utils/props.js

@@ -1,3 +1,6 @@
+/**
+ * @module utils.props
+ */
 /**
  * Ensures the array consists of objects
  * @param {Array} array Array to check 

package/lib/utils/router.js

@@ -1,8 +1,8 @@
 /**
- * This Module Creates Menus from route or router config
- * - Note: Functions prefixed with "$" work with $route objects (running application, provided by vue-router ie $router, useRoute, etc), 
- * @module router-utils
+ * @module utils.router
  */
+/**
+ * This Module Creates Menus from route or router config
 
 /**
  * Resolves a route's title from its meta.
@@ -37,7 +37,7 @@ export function getRouteTitle(route, currentRoute) {
  * @param {Object} options Options
  * @param {Object} options.qualifier Callback to qualify as a base route (defaults to isStaticBaseRoute)
  * @param {Object} options.item Options for createMenuItem
- * @returns {Array.<RouteMenuItem>} Array of menu items
+ * @returns {Array<RouteMenuItem>} Array of menu items
  */
 export function createBaseMenu(routes, options) {
   const defaults = {
@@ -97,9 +97,9 @@ export function flattenMenu(menu) {
  * @param {*} routes All routes 
  * @param {*} sectionPath Path for section to create menu
  * @param {Object} options Options
- * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie ({ path: "" })
+ * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie path: ""
  * @param {Object} options.item Options to be passed to createMenuItem
- * @returns {Array.<RouteMenuItem>} Array of menu items
+ * @returns {Array<RouteMenuItem>} Array of menu items
  */
 export function createSectionMenu(routes, sectionPath, options) {
   const defaults = {
@@ -190,7 +190,7 @@ export function isStaticBaseRoute(route) {
 }
 
 /**
- * Function to make normal <a> behave as router links instread of page reload
+ * Function to make normal `<a>` behave as router links instread of page reload
  * @param {Object} router Router instance (ie src/router) to push routes to
  * @param {Object} event The event object that triggered route change (ie. onclick) pass event object
  */
@@ -246,9 +246,9 @@ function sortByWeight(a, b) {
  * @param {Object} route Actual $route object 
  * @param {Object} options Options
  * @param {Object} options.parent Route parent object, defaults to parent of route
- * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie ({ path: "" })
+ * @param {Boolean} options.includeIndex Include the parent/index in the menu items ie path: ""
  * @param {Object} options.item Options for createMenuItem
- * @returns {Array.<RouteMenuItem>} Array of menu items
+ * @returns {Array<RouteMenuItem>} Array of menu items
  */
 export function $createSectionMenu(route, options) {
   const defaults = {
@@ -273,7 +273,7 @@ export function $createSectionMenu(route, options) {
  * - Skips routes where `meta.breadcrumb` is set to `false`.
  * - Avoids duplicate crumbs for nested routes with empty paths.
  * @param {Object} route The Vue Router `$route` object.
- * @returns {Array.<{title: String, to: Object, current: Boolean}>} An array of breadcrumb items.
+ * @returns {Array<Object>} An array of breadcrumb items with title, to, and current properties.
  */
 export function $createBreadcrumb(route) {
   const { matched, path: currentPath } = route;