@hybridly/vue 0.4.2 → 0.4.3

package/dist/index.cjs

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 const vue = require('vue');
 const core = require('@hybridly/core');
 const utils = require('@hybridly/utils');
@@ -12,10 +10,10 @@ const dotDiver = require('@clickbar/dot-diver');
 const isEqual = require('lodash.isequal');
 const hybridly = require('hybridly');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
-const qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
-const isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
+const qs__default = /*#__PURE__*/_interopDefaultCompat(qs);
+const isEqual__default = /*#__PURE__*/_interopDefaultCompat(isEqual);
 
 const DEBUG_KEY = "vue:state:dialog";
 const dialogStore = {
@@ -226,7 +224,9 @@ function setupDevtools(app) {
     });
     const listen = [
       "start",
+      "ready",
       "data",
+      "navigating",
       "navigated",
       "progress",
       "error",
@@ -235,7 +235,9 @@ function setupDevtools(app) {
       "invalid",
       "exception",
       "fail",
-      "after"
+      "after",
+      "backForward",
+      "success"
     ];
     core.registerHook("before", (options) => {
       const groupId = (Math.random() + 1).toString(36).substring(7);
@@ -412,28 +414,36 @@ Please specify a more appropriate element using the "as" attribute. For example:
 
 <RouterLink href="${url}" method="${method}" as="button">...</RouterLink>`);
       }
+      function performPreload(type) {
+        if (!preloads) {
+          return;
+        }
+        if (props.external) {
+          return;
+        }
+        if (method !== "GET") {
+          return;
+        }
+        if (type !== "mount" && props.disabled) {
+          return;
+        }
+        if (type === "hover" && preloads === "mount") {
+          return;
+        }
+        if (type === "mount" && preloads !== "mount") {
+          return;
+        }
+        core.router.preload(url, {
+          data,
+          ...props.options
+        });
+      }
+      performPreload("mount");
       return vue.h(props.as, {
         ...attrs,
         ...as === "a" ? { href: url } : {},
         ...props.disabled ? { disabled: props.disabled } : {},
-        onMouseenter: () => {
-          if (!preloads) {
-            return;
-          }
-          if (props.external) {
-            return;
-          }
-          if (props.disabled) {
-            return;
-          }
-          if (method !== "GET") {
-            return;
-          }
-          core.router.preload(url, {
-            data,
-            ...props.options
-          });
-        },
+        onMouseenter: () => performPreload("hover"),
         onClick: (event) => {
           if (props.external) {
             return;
@@ -492,7 +502,7 @@ Please specify a more appropriate element using the "as" attribute. For example:
       default: void 0
     },
     preload: {
-      type: Boolean,
+      type: [Boolean, String],
       default: false
     }
   }
@@ -698,6 +708,8 @@ function useForm(options) {
     clearError,
     setInitial,
     hasDirty,
+    submitWith: submit,
+    /** @deprecated Use `submitWith` instead */
     submitWithOptions: submit,
     submit: () => submit(),
     hasErrors: vue.computed(() => Object.values(errors.value ?? {}).length > 0),
@@ -789,10 +801,15 @@ const registerHook = (hook, fn, options) => {
 
 function useDialog() {
   return {
+    /** Closes the dialog. */
     close: () => hybridly.router.dialog.close(),
+    /** Closes the dialog without a server round-trip. */
     closeLocally: () => hybridly.router.dialog.close({ local: true }),
+    /** Unmounts the dialog. Should be called after its closing animations. */
     unmount: () => dialogStore.removeComponent(),
+    /** Whether the dialog is shown. */
     show: vue.computed(() => dialogStore.state.show.value),
+    /** Properties of the dialog. */
     properties: vue.computed(() => state.context.value?.dialog?.properties)
   };
 }
@@ -913,20 +930,65 @@ function useRefinements(properties, refinementsKeys, defaultOptions = {}) {
     return _ref;
   }
   return {
+    /**
+     * Binds a named filter to a ref, applying filters when it changes and updating the ref accordingly.
+     */
     bindFilter,
+    /**
+     * Available filters.
+     */
     filters: toReactive(refinements.value.filters),
+    /**
+     * Available sorts.
+     */
     sorts: toReactive(refinements.value.sorts),
+    /**
+     * Gets a filter by name.
+     */
     getFilter,
+    /**
+     * Gets a sort by name.
+     */
     getSort,
+    /**
+     * Resets all filters and sorts.
+     */
     reset,
+    /**
+     * Toggles the specified sort.
+     */
     toggleSort,
+    /**
+     * Whether a sort is active.
+     */
     isSorting,
+    /**
+     * Whether a filter is active.
+     */
     isFiltering,
+    /**
+     * The current sorts.
+     */
     currentSorts,
+    /**
+     * The current filters.
+     */
     currentFilters,
+    /**
+     * Clears the given filter.
+     */
     clearFilter,
+    /**
+     * Resets all sorts.
+     */
     clearSorts,
+    /**
+     * Resets all filters.
+     */
     clearFilters,
+    /**
+     * Applies the given filter.
+     */
     applyFilter
   };
 }