@websolutespa/bom-mixer-hooks 1.8.3 → 1.8.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @websolutespa/bom-mixer-hooks
 
+## 1.8.4
+
+### Patch Changes
+
+- Modified: usePageLoading, shallow routes do not fire loading state
+
 ## 1.8.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -396,6 +396,9 @@ declare function PageProvider({ children, page }: {
     page: IPage;
 }): react_jsx_runtime.JSX.Element;
 
+type IPageRouteOptions = {
+    shallow: boolean;
+};
 type IPageRoute = {
     pathname: string;
     query: Record<string, string>;
@@ -571,4 +574,4 @@ type WindowSize = {
 };
 declare function useWindowSize(): WindowSize;
 
-export { BodyScrollOptions, ClickOutGetContainer, CurrentStateType, ElementStackItem, ExtraProvider, Filter, FilterMode, FilterParams, FilterValues, GeoLocationSensorState, IExtra, IFilter, IFilterOption, IGeolocationPositionError, ILabelContext, ILayoutContext, ILazyModulesContext, IPageContext, IPageRoute, IPaginationInfo, IParams, IParamsEncoded, IParamsQs, IUseSearchParamsEncodedResult, IUseSearchParamsQsResult, IUseSearchParamsResult, IUseSearchParamsValueResult, KeyCode, KeyMod, KeyboardOptions, KeyboardResult, LabelProvider, LabelService, LayoutProvider, LazyModulesProvider, PageProvider, SSRState, SizeResult, SizeType, Sorting, UIReducer, UIValue, UseFiltersResultType, UseKeyboard, UseKeyboardHandler, createElementWithId, createGenericContext, detectIsBrowser, filtersToParams, getCurrentPosition, getFilteredItems, getFilters, getOwnerPaddingRight, getOwnerScrollbarWidth, getPagedItems, getPaginationInfo, getRealSize, getSearchParams, getSearchParamsEncoded, getSearchParamsQs, getUID, hasGeolocation, isElement, isPaginationInfo, localCollectionDelete, localCollectionFetch, localCollectionGet, localCollectionPatch, localCollectionPost, localCollectionPut, parseLabel, parseParams, pushSearchParams, pushSearchParamsEncoded, pushSearchParamsEncodedSilently, pushSearchParamsQs, pushSearchParamsQsSilently, pushSearchParamsSilently, replaceSearchParams, replaceSearchParamsEncoded, replaceSearchParamsEncodedSilently, replaceSearchParamsQs, replaceSearchParamsQsSilently, replaceSearchParamsSilently, scrollToRelativeY, scrollToSelector, scrollToY, setFilters, updateSearchParams, updateSearchParamsEncoded, updateSearchParamsQs, useApi, useApiDelete, useApiFetch, useApiGet, useApiPatch, useApiPost, useApiPut, useBodyScroll, useBreakpoint, useClickAnyWhere, useClickOut, useCollectionApi, useCollectionApiDelete, useCollectionApiGet, useCollectionApiPatch, useCollectionApiPost, useCollectionApiPut, useCurrency, useCurrentState, useDateTimeFormat, useDebounce, useDebounceCallback, useDebugChangedProps, useDomObserver, useDrawer, useElementSize, useEventListener, useExtra, useFilters, useGeolocation, useIdle, useInfiniteLoader, useIntersectionObserver, useIsomorphicLayoutEffect, useKeyboard, useLabel, useLayout, useLazyModules, useModal, useMounted, useNumber, usePage, usePageLoading, usePagination, usePortal, usePrevious, useRealSize, useResize, useSSR, useScroll, useScrollTo, useScrolled, useSearchParams, useSearchParamsEncoded, useSearchParamsQs, useSearchParamsValue, useSorting, useSyncedRef, useUI, useUnit, useUnmountEffect, useWindowSize };
+export { BodyScrollOptions, ClickOutGetContainer, CurrentStateType, ElementStackItem, ExtraProvider, Filter, FilterMode, FilterParams, FilterValues, GeoLocationSensorState, IExtra, IFilter, IFilterOption, IGeolocationPositionError, ILabelContext, ILayoutContext, ILazyModulesContext, IPageContext, IPageRoute, IPageRouteOptions, IPaginationInfo, IParams, IParamsEncoded, IParamsQs, IUseSearchParamsEncodedResult, IUseSearchParamsQsResult, IUseSearchParamsResult, IUseSearchParamsValueResult, KeyCode, KeyMod, KeyboardOptions, KeyboardResult, LabelProvider, LabelService, LayoutProvider, LazyModulesProvider, PageProvider, SSRState, SizeResult, SizeType, Sorting, UIReducer, UIValue, UseFiltersResultType, UseKeyboard, UseKeyboardHandler, createElementWithId, createGenericContext, detectIsBrowser, filtersToParams, getCurrentPosition, getFilteredItems, getFilters, getOwnerPaddingRight, getOwnerScrollbarWidth, getPagedItems, getPaginationInfo, getRealSize, getSearchParams, getSearchParamsEncoded, getSearchParamsQs, getUID, hasGeolocation, isElement, isPaginationInfo, localCollectionDelete, localCollectionFetch, localCollectionGet, localCollectionPatch, localCollectionPost, localCollectionPut, parseLabel, parseParams, pushSearchParams, pushSearchParamsEncoded, pushSearchParamsEncodedSilently, pushSearchParamsQs, pushSearchParamsQsSilently, pushSearchParamsSilently, replaceSearchParams, replaceSearchParamsEncoded, replaceSearchParamsEncodedSilently, replaceSearchParamsQs, replaceSearchParamsQsSilently, replaceSearchParamsSilently, scrollToRelativeY, scrollToSelector, scrollToY, setFilters, updateSearchParams, updateSearchParamsEncoded, updateSearchParamsQs, useApi, useApiDelete, useApiFetch, useApiGet, useApiPatch, useApiPost, useApiPut, useBodyScroll, useBreakpoint, useClickAnyWhere, useClickOut, useCollectionApi, useCollectionApiDelete, useCollectionApiGet, useCollectionApiPatch, useCollectionApiPost, useCollectionApiPut, useCurrency, useCurrentState, useDateTimeFormat, useDebounce, useDebounceCallback, useDebugChangedProps, useDomObserver, useDrawer, useElementSize, useEventListener, useExtra, useFilters, useGeolocation, useIdle, useInfiniteLoader, useIntersectionObserver, useIsomorphicLayoutEffect, useKeyboard, useLabel, useLayout, useLazyModules, useModal, useMounted, useNumber, usePage, usePageLoading, usePagination, usePortal, usePrevious, useRealSize, useResize, useSSR, useScroll, useScrollTo, useScrolled, useSearchParams, useSearchParamsEncoded, useSearchParamsQs, useSearchParamsValue, useSorting, useSyncedRef, useUI, useUnit, useUnmountEffect, useWindowSize };

package/dist/index.js

@@ -1420,22 +1420,31 @@ function usePageLoading(options = { loading: false }) {
   const [previousPageRoute, setPreviousPageRoute] = (0, import_react25.useState)();
   (0, import_react25.useEffect)(() => {
     let previousRoute;
-    const onRouteChangeStart = () => {
+    const onRouteChangeStart = (route, options2) => {
       const pageRoute2 = previousRoute ? getPageRoute(previousRoute) : void 0;
-      setLoading(true);
-      setPreviousPageRoute(pageRoute2);
       setError();
+      setPreviousPageRoute(pageRoute2);
+      if (options2 == null ? void 0 : options2.shallow) {
+        return;
+      }
+      setLoading(true);
     };
-    const onRouteChangeComplete = (route) => {
+    const onRouteChangeComplete = (route, options2) => {
       const pageRoute2 = getPageRoute(route);
       setPageRoute(pageRoute2);
       previousRoute = route;
+      if (options2 == null ? void 0 : options2.shallow) {
+        return;
+      }
       setLoading(false);
     };
-    const onRouteChangeError = (error2) => {
+    const onRouteChangeError = (error2, route, options2) => {
       console.log("usePageLoading.onRouteChangeError", error2);
-      setLoading(false);
       setError(error2);
+      if (options2 == null ? void 0 : options2.shallow) {
+        return;
+      }
+      setLoading(false);
     };
     import_router.Router.events.on("routeChangeStart", onRouteChangeStart);
     import_router.Router.events.on("routeChangeComplete", onRouteChangeComplete);

package/dist/index.mjs

@@ -1280,22 +1280,31 @@ function usePageLoading(options = { loading: false }) {
   const [previousPageRoute, setPreviousPageRoute] = useState14();
   useEffect19(() => {
     let previousRoute;
-    const onRouteChangeStart = () => {
+    const onRouteChangeStart = (route, options2) => {
       const pageRoute2 = previousRoute ? getPageRoute(previousRoute) : void 0;
-      setLoading(true);
-      setPreviousPageRoute(pageRoute2);
       setError();
+      setPreviousPageRoute(pageRoute2);
+      if (options2 == null ? void 0 : options2.shallow) {
+        return;
+      }
+      setLoading(true);
     };
-    const onRouteChangeComplete = (route) => {
+    const onRouteChangeComplete = (route, options2) => {
       const pageRoute2 = getPageRoute(route);
       setPageRoute(pageRoute2);
       previousRoute = route;
+      if (options2 == null ? void 0 : options2.shallow) {
+        return;
+      }
       setLoading(false);
     };
-    const onRouteChangeError = (error2) => {
+    const onRouteChangeError = (error2, route, options2) => {
       console.log("usePageLoading.onRouteChangeError", error2);
-      setLoading(false);
       setError(error2);
+      if (options2 == null ? void 0 : options2.shallow) {
+        return;
+      }
+      setLoading(false);
     };
     Router.events.on("routeChangeStart", onRouteChangeStart);
     Router.events.on("routeChangeComplete", onRouteChangeComplete);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websolutespa/bom-mixer-hooks",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "description": "Mixer Hooks module of the BOM Repository",
   "keywords": [
     "bom",

package/src/usePageLoading/usePageLoading.ts

@@ -1,6 +1,10 @@
 import { Router } from 'next/router';
 import { useEffect, useState } from 'react';
 
+export type IPageRouteOptions = {
+  shallow: boolean;
+};
+
 export type IPageRoute = {
   pathname: string;
   query: Record<string, string>;
@@ -31,24 +35,36 @@ export function usePageLoading(options: { loading: boolean } = { loading: false
 
   useEffect(() => {
     let previousRoute: string | undefined;
-    const onRouteChangeStart = () => {
+    const onRouteChangeStart = (route: string, options: IPageRouteOptions) => {
       const pageRoute = previousRoute ? getPageRoute(previousRoute) : undefined;
       // console.log('usePageLoading.onRouteChangeStart', pageRoute, previousRoute);
-      setLoading(true);
-      setPreviousPageRoute(pageRoute);
       setError();
+      setPreviousPageRoute(pageRoute);
+      // shallow routes do not fire loading state
+      if (options?.shallow) {
+        return;
+      }
+      setLoading(true);
     };
-    const onRouteChangeComplete = (route: string) => {
+    const onRouteChangeComplete = (route: string, options: IPageRouteOptions) => {
       const pageRoute = getPageRoute(route);
       // console.log('usePageLoading.onRouteChangeComplete', pageRoute);
       setPageRoute(pageRoute);
       previousRoute = route;
+      // shallow routes do not fire loading state
+      if (options?.shallow) {
+        return;
+      }
       setLoading(false);
     };
-    const onRouteChangeError = (error: Error) => {
+    const onRouteChangeError = (error: Error, route: string, options: IPageRouteOptions) => {
       console.log('usePageLoading.onRouteChangeError', error);
-      setLoading(false);
       setError(error);
+      // shallow routes do not fire loading state
+      if (options?.shallow) {
+        return;
+      }
+      setLoading(false);
     };
     Router.events.on('routeChangeStart', onRouteChangeStart);
     Router.events.on('routeChangeComplete', onRouteChangeComplete);