@ulu/frontend-vue 0.1.0-beta.6 → 0.1.0-beta.7

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@ulu/frontend-vue",
-  "version": "0.1.0-beta.6",
+  "version": "0.1.0-beta.7",
   "description": "A modular and tree-shakeable Vue 3 component library for the Ulu frontend",
   "type": "module",
   "files": [
     "lib",
-    "dist"
+    "dist",
+    "types"
   ],
   "module": "./lib/index.js",
   "exports": {

package/types/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./systems/index.js";
+//# sourceMappingURL=index.d.ts.map

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

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

package/types/components/systems/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/types/components/systems/index.d.ts.map

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

package/types/components/systems/scroll-anchors/symbols.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Symbol for register provide/inject
+ */
+export const REGISTER: any;
+export const UNREGISTER: any;
+export const SECTIONS: any;
+//# sourceMappingURL=symbols.d.ts.map

package/types/components/systems/scroll-anchors/symbols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"symbols.d.ts","sourceRoot":"","sources":["../../../../lib/components/systems/scroll-anchors/symbols.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,2BAAiC;AACjC,6BAAmC;AACnC,2BAAiC"}

package/types/composables/index.d.ts

@@ -0,0 +1,5 @@
+export { useIcon } from "./useIcon.js";
+export { useModifiers } from "./useModifiers.js";
+export { useWindowResize } from "./useWindowResize.js";
+export { useBreakpointManager } from "./useBreakpointManager.js";
+//# sourceMappingURL=index.d.ts.map

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

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

package/types/composables/useBreakpointManager.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Use the CssBreakpoints module in Vue
+ * - Normally use only once, unless you have different sets of breakpoints
+ * @param {Object} options Configuration options overrides
+ * @return {Object} { manager, active, direction } (all are null in SSR environment until init)
+ */
+export function useBreakpointManager(options: any): any;
+//# sourceMappingURL=useBreakpointManager.d.ts.map

package/types/composables/useBreakpointManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBreakpointManager.d.ts","sourceRoot":"","sources":["../../lib/composables/useBreakpointManager.js"],"names":[],"mappings":"AAoBA;;;;;GAKG;AACH,wDAyCC"}

package/types/composables/useIcon.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Utility composable for handling and formatting icon props for UluIcon.
+ * @returns {Object} An object with utility functions { getIconProps, getClassesFromDefinition }
+ */
+export function useIcon(): any;
+//# sourceMappingURL=useIcon.d.ts.map

package/types/composables/useIcon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIcon.d.ts","sourceRoot":"","sources":["../../lib/composables/useIcon.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH,+BAyDC"}

package/types/composables/useModifiers.d.ts

@@ -0,0 +1,69 @@
+/**
+ * A composable to manage and resolve BEM style modifiers for a component,
+ * combining user-passed modifiers with internally derived conditional modifiers.
+ *
+ * @param {object} options - The options for the composable.
+ * @param {object} options.props - The component's props object. (Must contain a 'modifiers' prop if user-passed modifiers are expected)
+ * @param {string | import('vue').Ref<string>} options.baseClass - The base CSS class name for the component (e.g., 'modal').
+ * Can be a string or a ref to a string.
+ * @param {string | string[] | Object.<string, any> | import('vue').ComputedRef<string | string[] | Object.<string, any>>} [options.internal={}] -
+ * A flexible input for component's internal modifiers. Can be a string, array of strings/objects, or an object mapping modifier names to conditions.
+ * @returns {object} An object containing the computed property `resolvedModifiers`
+ *
+ * @example
+ * // In MyComponent.vue:
+ * <template>
+ * <div :class="[resolvedModifiers, 'other-class']"></div>
+ * </template>
+ *
+ * <script>
+ * import { computed, ref } from 'vue';
+ * import { useModifiers } from './composables/useModifiers.js'; // Adjust path
+ *
+ * export default {
+ *   props: {
+ *     variant: String, // e.g., 'primary', 'secondary'
+ *     isActive: Boolean,
+ *     modifiers: [String, Array, Object] // User-passed modifiers
+ *   },
+ *   setup(props) {
+ *     const isHovered = ref(false);
+ *
+ *     // Define component-internal modifiers based on props or local state
+ *     const internalModifiers = computed(() => ({
+ *       [props.variant]: !!props.variant, // Add 'primary' or 'secondary' if prop exists
+ *       'active': props.isActive, // Add 'active' if isActive prop is true
+ *       'hovered': isHovered.value, // Add 'hovered' if local state is true
+ *       'default': !props.variant && !props.isActive // Add 'default' if no variant/active
+ *     }));
+ *
+ *     // Use the composable to get the combined modifier classes
+ *     const { resolvedModifiers } = useModifiers({
+ *       props: props, // Pass component props for 'modifiers' prop
+ *       baseClass: 'button', // The BEM block name
+ *       internal: internalModifiers // The computed internal modifiers
+ *     });
+ *
+ *     return { resolvedModifiers, isHovered };
+ *   }
+ * };
+ * </script>
+ *
+ * // Resulting class examples for 'my-component':
+ * // <MyComponent />                       => class="my-component my-component--default"
+ * // <MyComponent variant="primary" />     => class="my-component my-component--primary"
+ * // <MyComponent isActive />              => class="my-component my-component--active"
+ * // <MyComponent modifiers="condensed" /> => class="my-component my-component--default my-component--condensed"
+ * // <MyComponent variant="secondary" :isActive="true" modifiers="round" />
+ * //   => class="my-component my-component--secondary my-component--active my-component--round"
+ */
+export function useModifiers({ props, baseClass, internal }: {
+    props: object;
+    baseClass: string | import("vue").Ref<string>;
+    internal?: string | string[] | {
+        [x: string]: any;
+    } | import("vue").ComputedRef<string | string[] | {
+        [x: string]: any;
+    }>;
+}): object;
+//# sourceMappingURL=useModifiers.d.ts.map

package/types/composables/useModifiers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useModifiers.d.ts","sourceRoot":"","sources":["../../lib/composables/useModifiers.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,6DAtDG;IAAwB,KAAK,EAArB,MAAM;IACsC,SAAS,EAArD,MAAM,GAAG,OAAO,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC;IAEuF,QAAQ,GAAjI,MAAM,GAAG,MAAM,EAAE,GAAG;YAAQ,MAAM,GAAE,GAAG;KAAC,GAAG,OAAO,KAAK,EAAE,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG;YAAQ,MAAM,GAAE,GAAG;KAAC,CAAC;CAEtH,GAAU,MAAM,CA0ElB"}

package/types/composables/useWindowResize.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Composable function
+ * @return {Object} Contains reactive 'resizing' and two methods for calling callbacks (onResizeStart, onResizeEnd)
+ */
+export function useWindowResize(): any;
+//# sourceMappingURL=useWindowResize.d.ts.map

package/types/composables/useWindowResize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useWindowResize.d.ts","sourceRoot":"","sources":["../../lib/composables/useWindowResize.js"],"names":[],"mappings":"AAiDA;;;GAGG;AACH,uCAUC"}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./plugins/index.js";
+export * from "./components/index.js";
+export * from "./composables/index.js";
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

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

package/types/plugins/breakpoints/index.d.ts

@@ -0,0 +1,2 @@
+export default function install(app: any, userOptions: any): void;
+//# sourceMappingURL=index.d.ts.map

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

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

package/types/plugins/core/index.d.ts

@@ -0,0 +1,3 @@
+export default function install(app: any, userSettings?: {}): void;
+export const iconKeys: string[];
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/core/index.js"],"names":[],"mappings":"AA6BA,mEAyDC;AA3DD,gCAA0D"}

package/types/plugins/index.d.ts

@@ -0,0 +1,6 @@
+export { default as corePlugin } from "./core/index.js";
+export { default as popoversPlugin } from "./popovers/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";
+//# sourceMappingURL=index.d.ts.map

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

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

package/types/plugins/modals/api.d.ts

@@ -0,0 +1,34 @@
+export namespace modalsState {
+    export { data };
+    export { modals };
+}
+export function createApi(resolveModalOptions: any): {
+    open(name: any, props?: any): void;
+    /**
+     * Close the active modal
+     * @param {String|Node} focusTo The element or selector for an element to programmatically focus after modal close
+     * @see https://www.deque.com/blog/accessible-routing-in-javascript-frameworks/
+     */
+    close(): void;
+    /**
+     * Get a modal's config object by name
+     * @return {Object} Modal config object
+     */
+    get(name: any): any;
+    /**
+     * Add a modal config
+     */
+    add(config: any): void;
+    /**
+     * Removes a modal config by name
+     * @return {Object} Modal that was removed
+     */
+    remove(name: any): any;
+};
+/**
+ * Reactive data from state
+ */
+declare const data: any;
+declare const modals: any[];
+export {};
+//# sourceMappingURL=api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/api.js"],"names":[],"mappings":";;;;AA6BO;;IAML;;;;OAIG;;IAKH;;;OAGG;;IASH;;OAEG;;IAKH;;;OAGG;;EASH;AAxDF;;GAEG;AACH,wBAAyB;AAnBzB,4BAAkB"}

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

@@ -0,0 +1,28 @@
+/**
+ * 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;
+/**
+ * Default plugin options
+ */
+export type UluModalsPluginOptions = {
+    /**
+     * Name for modals component that displays app-wide modals
+     */
+    componentNameDisplay: string;
+    /**
+     * Name for modal component
+     */
+    componentNameModal: string;
+    /**
+     * Modals configs [{ name, component, props }]
+     */
+    modals: any[];
+    /**
+     * Options to merge into individual modal options (to serve as defaults for each modal, see UluModalOptions)
+     */
+    modalOptions: UluModalOptions;
+};
+//# sourceMappingURL=index.d.ts.map

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

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

package/types/plugins/modals/useModals.d.ts

@@ -0,0 +1,2 @@
+export function useModals(): any;
+//# sourceMappingURL=useModals.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useModals.d.ts","sourceRoot":"","sources":["../../../lib/plugins/modals/useModals.js"],"names":[],"mappings":"AAEO,iCAMN"}

package/types/plugins/popovers/defaults.d.ts

@@ -0,0 +1,14 @@
+declare namespace _default {
+    let plugin: any;
+    namespace popover {
+        let inline: boolean;
+        let delay: number;
+        let placement: string;
+        let strategy: string;
+        let offset: number;
+        let arrow: boolean;
+    }
+    let tooltip: any;
+}
+export default _default;
+//# sourceMappingURL=defaults.d.ts.map

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

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

package/types/plugins/popovers/directive.d.ts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    function mounted(trigger: any, binding: any): void;
+    function beforeUpdate(trigger: any): void;
+    function updated(trigger: any, binding: any): void;
+    function umounted(trigger: any): void;
+}
+export default _default;
+//# sourceMappingURL=directive.d.ts.map

package/types/plugins/popovers/directive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directive.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/directive.js"],"names":[],"mappings":";IAgBE,mDAEC;IACD,0CAEC;IACD,mDAEC;IACD,sCAEC"}

package/types/plugins/popovers/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Install plugin
+ * - Set user options
+ * - Add the global directive for the user to trigger tooltips
+ */
+export default function install(app: any, userOptions?: {}): void;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/index.js"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,kEAOC"}

package/types/plugins/popovers/manager.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Setup the store options
+ * @param {Object} userOptions
+ * @param {Object} options Resolved options
+ */
+export function init(userOptions?: any): {
+    plugin: any;
+    popover: {
+        inline: boolean;
+        delay: number;
+        placement: string;
+        strategy: string;
+        offset: number;
+        arrow: boolean;
+    };
+    tooltip: any;
+};
+/**
+   * Config for a single tooltip instance
+   */
+export function createConfig(userConfig: any): any;
+/**
+ * Show a tooltip
+ * - Set by directive
+ */
+export function show(config: any): void;
+/**
+ * Hide a tooltip
+ * - Set by directive
+ */
+export function hide(): void;
+export namespace options {
+    let plugin: any;
+    let popover: {
+        inline: boolean;
+        delay: number;
+        placement: string;
+        strategy: string;
+        offset: number;
+        arrow: boolean;
+    };
+    let tooltip: any;
+}
+/**
+ * Whether or not the tooltip is active
+ */
+export const active: import("vue").Ref<boolean, boolean>;
+/**
+ * Current tooltip config
+ */
+export const activeConfig: import("vue").Ref<any, any>;
+//# sourceMappingURL=manager.d.ts.map

package/types/plugins/popovers/manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/manager.js"],"names":[],"mappings":"AAkBA;;;;GAIG;AACH;;;;;;;;;;;EAKC;AAED;;KAEK;AACL,mDAEC;AAED;;;GAGG;AACH,wCAGC;AAED;;;GAGG;AACH,6BAGC;;;;;;;;;;;;;AA5CD;;GAEG;AACH,yDAAiC;AACjC;;GAEG;AACH,uDAAsC"}

package/types/plugins/popovers/useFollow.d.ts

@@ -0,0 +1,31 @@
+export default function useFollowPoint(userOptions: any): {
+    /**
+     * Reactive X value
+     * @type {Object}
+     */
+    x: any;
+    /**
+     * Reactive Y value
+     * @type {Object}
+     */
+    y: any;
+    /**
+     * Show follow tooltip
+     */
+    show(): void;
+    /**
+     * Hide follow tooltip
+     */
+    hide(): void;
+    /**
+     *
+     * @param {Object} changes Updates for virtual element
+     * @param {Object} changes.x New 'x' value
+     * @param {Object} changes.y New 'y' value
+     */
+    update(changes: {
+        x: any;
+        y: any;
+    }): void;
+};
+//# sourceMappingURL=useFollow.d.ts.map

package/types/plugins/popovers/useFollow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFollow.d.ts","sourceRoot":"","sources":["../../../lib/plugins/popovers/useFollow.js"],"names":[],"mappings":"AAOA;IAoCI;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;IAIH;;OAEG;;IAIH;;;;;OAKG;oBAFA;QAAwB,CAAC;QACD,CAAC;KAC3B;EASJ"}

package/types/plugins/popovers/utils.d.ts

@@ -0,0 +1,2 @@
+export function newUid(): string;
+//# sourceMappingURL=utils.d.ts.map

package/types/plugins/popovers/utils.d.ts.map

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

package/types/plugins/toast/defaults.d.ts

@@ -0,0 +1,15 @@
+declare namespace _default {
+    namespace toastOptions {
+        let component: any;
+        let duration: number;
+        let actions: any[];
+    }
+    namespace pluginOptions {
+        let componentName: string;
+        let componentNameDisplay: string;
+        let teleportTo: string;
+        let position: string[];
+    }
+}
+export default _default;
+//# sourceMappingURL=defaults.d.ts.map

package/types/plugins/toast/defaults.d.ts.map

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

package/types/plugins/toast/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Install plugin
+ */
+export default function install(app: any, userOptions?: {}): void;
+//# sourceMappingURL=index.d.ts.map

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

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

package/types/plugins/toast/store.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Reactive State Object (used inside global components, and as API globally)
+ */
+export const store: any;
+export namespace api {
+    /**
+     *
+     * @param {Object} options Toast options
+     * @returns Toast object (to be used to remove)
+     */
+    function add(options: any): any;
+    /**
+     *
+     * @param {Object} toast Toast uid
+     */
+    function remove(uid: any): void;
+    /**
+     * Remove all toasts
+     */
+    function removeAll(): void;
+}
+//# sourceMappingURL=store.d.ts.map

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

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

package/types/plugins/toast/useToast.d.ts

@@ -0,0 +1,2 @@
+export function useToast(): object;
+//# sourceMappingURL=useToast.d.ts.map

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

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

package/types/utils/dom.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Resolves a Vue template ref's unwrapped value to its underlying DOM element
+ *
+ * @param {HTMLElement|Object} value - The unwrapped value from a template ref (e.g., `this.$refs.myElement` or `this.$refs.myComponent`)
+ * @returns {HTMLElement} The HTMLElement or undefined if not found/resolved.
+ */
+export function refToElement(value: HTMLElement | any): HTMLElement;
+//# sourceMappingURL=dom.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../lib/utils/dom.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oCAHW,WAAW,MAAO,GAChB,WAAW,CASvB"}

package/types/utils/placeholder.d.ts

@@ -0,0 +1,8 @@
+declare namespace _default {
+    let text: string;
+    let textSmall: string;
+    let paragraph: string;
+    let paragraphSmall: string;
+}
+export default _default;
+//# sourceMappingURL=placeholder.d.ts.map

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

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

package/types/utils/vue-router.d.ts

@@ -0,0 +1,122 @@
+/**
+ * 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 utils/router-utils
+ */
+/**
+ * Route Menu Item
+ * @typedef {Object} RouteMenuItem
+ * @property {String} path - Menu item route path
+ * @property {String} title - Menu item title
+ */
+/**
+ * Get root/base static routes as menu items
+ * @param {*} routes Routes to build menu from (not router instance)
+ * @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
+ */
+export function createBaseMenu(routes: any, options: {
+    qualifier: any;
+    item: any;
+}): Array<RouteMenuItem>;
+/**
+ * Print out a section's menu based on path
+ * @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 {Object} options.item Options to be passed to createMenuItem
+ * @returns {Array.<RouteMenuItem>} Array of menu items
+ */
+export function createSectionMenu(routes: any, sectionPath: any, options: {
+    includeIndex: boolean;
+    item: any;
+}): Array<RouteMenuItem>;
+/**
+ * For a given route this will return the route that renders. For routes without
+ * children this is the route itself for those with children (first child with empty path)
+ * @param {Object} route Route object to resolve
+ * @returns {Object} Resolved route
+ */
+/**
+ * For a given array of child routes return the index
+ * @param {Array} children Children array of routes
+ * @returns {Object} Route
+ */
+export function getChildIndexRoute(children: any[]): any;
+/**
+ * Creates common menu item structure from route, pulls title and weight from meta (on route or index child)
+ * @param {Object} route Route
+ * @param {Object} routePath The final path for the menu item
+ * @param {Object} options Function to allow alterering the menu item (adding meta, etc)
+ * @param {Function} options.modify Function to allow alterering the menu item (adding meta, etc) (args: item, route)
+ * @param {Function} options.indexMeta Include the routes index child's meta (merged on top of route meta)
+ * @returns {RouteMenuItem} Menu item
+ */
+export function createMenuItem(route: any, routePath: any, options: {
+    modify: Function;
+    indexMeta: Function;
+}): RouteMenuItem;
+/**
+ * Test if route is static (doesn't incude parameters)
+ * @param {Object} route Route object to test
+ * @returns {Boolean} Whether or not this route is static (not dynamic)
+ */
+export function isStaticRoute(route: any): boolean;
+/**
+ *
+ * @param {Object} route Route object to test
+ * @returns {Boolean} Whether or not this route is a static base route
+ */
+export function isStaticBaseRoute(route: any): boolean;
+/**
+ * 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
+ */
+export function nativeLinkRouter(router: any, event: any): void;
+/**
+ * Returns the child routes for base route
+ * @param {Object} route Route Object
+ * @returns
+ */
+export function $getRouteChildren(route: any, parent?: any): any;
+/**
+ * Returns the route's parent
+ * @param {Object} route Route Object
+ * @param {Object} deepest By default this returns the routes parent, if deepest it will return it's base route (top level parent)
+ * @return {Object|Null} Parent route, if there is no parent route for the given route this will return null
+ */
+export function $getParentRoute(route: any, deepest: any): any | null;
+/**
+ * For a given $route will return all it's children as menu items,
+ * using the route's meta.title property for the title. This is for sections only (routes with children)
+ * - Useful for dynamic menus (menus within some unknown section) where you don't want to write static paths
+ * @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 {Object} options.item Options for createMenuItem
+ * @returns {Array.<RouteMenuItem>} Array of menu items
+ */
+export function $createSectionMenu(route: any, options: {
+    parent: any;
+    includeIndex: boolean;
+    item: any;
+}): Array<RouteMenuItem>;
+/**
+ * Route Menu Item
+ */
+export type RouteMenuItem = {
+    /**
+     * - Menu item route path
+     */
+    path: string;
+    /**
+     * - Menu item title
+     */
+    title: string;
+};
+//# sourceMappingURL=vue-router.d.ts.map

package/types/utils/vue-router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue-router.d.ts","sourceRoot":"","sources":["../../lib/utils/vue-router.js"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,uCANW,GAAC,WAET;IAAwB,SAAS;IACT,IAAI;CAC5B,GAAU,KAAK,CAAE,aAAa,CAAC,CAiBjC;AAED;;;;;;;;GAQG;AACH,0CAPW,GAAC,eACD,GAAC,WAET;IAAyB,YAAY;IACb,IAAI;CAC5B,GAAU,KAAK,CAAE,aAAa,CAAC,CA6BjC;AAED;;;;;GAKG;AASH;;;;GAIG;AACH,yDAEC;AACD;;;;;;;;GAQG;AACH,oEAJG;IAA0B,MAAM;IACN,SAAS;CACnC,GAAU,aAAa,CAsBzB;AACD;;;;GAIG;AACH,mDAEC;AACD;;;;GAIG;AACH,uDAGC;AACD;;;;GAIG;AACH,gEAUC;AACD;;;;GAIG;AACH,iEAEC;AACD;;;;;GAKG;AACH,2DAFY,UAAW,CAUtB;AAUD;;;;;;;;;;GAUG;AACH,wDALG;IAAwB,MAAM;IACL,YAAY;IACb,IAAI;CAC5B,GAAU,KAAK,CAAE,aAAa,CAAC,CAgBjC"}