@hybridly/vue 0.4.2 → 0.4.3

package/dist/index.d.ts

@@ -86,7 +86,7 @@ declare const RouterLink: vue.DefineComponent<{
         default: undefined;
     };
     preload: {
-        type: BooleanConstructor;
+        type: PropType<boolean | "hover" | "mount">;
         default: boolean;
     };
 }, (props: _vue_shared.LooseRequired<{
@@ -96,7 +96,7 @@ declare const RouterLink: vue.DefineComponent<{
     readonly as: string | Record<string, any>;
     readonly external: boolean;
     readonly disabled: boolean;
-    readonly preload: boolean;
+    readonly preload: boolean | "hover" | "mount";
     readonly text?: string | undefined;
     readonly href?: string | undefined;
 } & {}>) => vue.VNode<vue.RendererNode, vue.RendererElement, {
@@ -137,7 +137,7 @@ declare const RouterLink: vue.DefineComponent<{
         default: undefined;
     };
     preload: {
-        type: BooleanConstructor;
+        type: PropType<boolean | "hover" | "mount">;
         default: boolean;
     };
 }>>, {
@@ -149,7 +149,7 @@ declare const RouterLink: vue.DefineComponent<{
     as: string | Record<string, any>;
     external: boolean;
     disabled: boolean;
-    preload: boolean;
+    preload: boolean | "hover" | "mount";
 }, {}>;
 
 /** Accesses all current properties. */
@@ -492,6 +492,7 @@ declare function useForm<T extends SearchableObject, P extends Path<T> & string
     clearError: (key: P) => void;
     setInitial: (newInitial: Partial<T>) => void;
     hasDirty: (...keys: P[]) => boolean;
+    submitWith: (optionsOverrides?: Omit<HybridRequestOptions$1, 'data'>) => Promise<_hybridly_core.NavigationResponse>;
     submitWithOptions: (optionsOverrides?: Omit<HybridRequestOptions$1, 'data'>) => Promise<_hybridly_core.NavigationResponse>;
     submit: () => Promise<_hybridly_core.NavigationResponse>;
     hasErrors: boolean;
@@ -826,4 +827,4 @@ declare function useRoute(): {
     matches: <T extends string>(name: MaybeRefOrGetter<T>, parameters?: Record<string, any> | undefined) => boolean;
 };
 
-export { Layout, RouterLink, defineLayout, defineLayoutProperties, initializeHybridly, registerHook, setProperty, useBackForward, useContext, useDialog, useForm, useHistoryState, usePaginator, useProperties, useProperty, useRefinements, useRoute };
+export { type Layout, RouterLink, defineLayout, defineLayoutProperties, initializeHybridly, registerHook, setProperty, useBackForward, useContext, useDialog, useForm, useHistoryState, usePaginator, useProperties, useProperty, useRefinements, useRoute };

package/dist/index.mjs

@@ -218,7 +218,9 @@ function setupDevtools(app) {
     });
     const listen = [
       "start",
+      "ready",
       "data",
+      "navigating",
       "navigated",
       "progress",
       "error",
@@ -227,7 +229,9 @@ function setupDevtools(app) {
       "invalid",
       "exception",
       "fail",
-      "after"
+      "after",
+      "backForward",
+      "success"
     ];
     registerHook$1("before", (options) => {
       const groupId = (Math.random() + 1).toString(36).substring(7);
@@ -404,28 +408,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;
+        }
+        router.preload(url, {
+          data,
+          ...props.options
+        });
+      }
+      performPreload("mount");
       return 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;
-          }
-          router.preload(url, {
-            data,
-            ...props.options
-          });
-        },
+        onMouseenter: () => performPreload("hover"),
         onClick: (event) => {
           if (props.external) {
             return;
@@ -484,7 +496,7 @@ Please specify a more appropriate element using the "as" attribute. For example:
       default: void 0
     },
     preload: {
-      type: Boolean,
+      type: [Boolean, String],
       default: false
     }
   }
@@ -690,6 +702,8 @@ function useForm(options) {
     clearError,
     setInitial,
     hasDirty,
+    submitWith: submit,
+    /** @deprecated Use `submitWith` instead */
     submitWithOptions: submit,
     submit: () => submit(),
     hasErrors: computed(() => Object.values(errors.value ?? {}).length > 0),
@@ -781,10 +795,15 @@ const registerHook = (hook, fn, options) => {
 
 function useDialog() {
   return {
+    /** Closes the dialog. */
     close: () => router$1.dialog.close(),
+    /** Closes the dialog without a server round-trip. */
     closeLocally: () => router$1.dialog.close({ local: true }),
+    /** Unmounts the dialog. Should be called after its closing animations. */
     unmount: () => dialogStore.removeComponent(),
+    /** Whether the dialog is shown. */
     show: computed(() => dialogStore.state.show.value),
+    /** Properties of the dialog. */
     properties: computed(() => state.context.value?.dialog?.properties)
   };
 }
@@ -905,20 +924,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
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hybridly/vue",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Vue adapter for Hybridly",
   "keywords": [
     "hybridly",
@@ -44,12 +44,12 @@
     "lodash.isequal": "^4.5.0",
     "nprogress": "^0.2.0",
     "qs": "^6.11.2",
-    "@hybridly/core": "0.4.2",
-    "@hybridly/progress-plugin": "0.4.2",
-    "@hybridly/utils": "0.4.2"
+    "@hybridly/core": "0.4.3",
+    "@hybridly/progress-plugin": "0.4.3",
+    "@hybridly/utils": "0.4.3"
   },
   "devDependencies": {
-    "@types/lodash": "^4.14.195",
+    "@types/lodash": "^4.14.197",
     "@types/lodash.clonedeep": "^4.5.7",
     "@types/lodash.isequal": "^4.5.6",
     "@types/nprogress": "^0.2.0",