dry-ux 1.74.0 → 1.76.0

package/dist/helpers/utilities.d.ts

@@ -59,7 +59,12 @@ export declare const toHashCode: (input: string) => number;
  * @param key The key of the parameter.
  * @param value The value of the parameter.
  */
-export declare const insertUrlParam: (key: string, value: any) => void;
+export declare const insertUrlParam: (key: any, value: any) => void;
+/**
+ * Deletes a URL parameter.
+ * @param key
+ */
+export declare const deleteUrlParam: (key: any) => void;
 /**
  * Inserts multiple URL parameters.
  * @param params An object containing key-value pairs of parameters.
@@ -113,7 +118,21 @@ export declare const usePubSub: <T>() => {
     usePub: () => <TName extends keyof T, TPayload extends T[TName]>(event: TName, data?: TPayload) => void;
     useSub: <TName extends keyof T, TPayload_1 extends T[TName]>(event: TName, callback: (data: TPayload_1) => void) => () => void;
 };
+/**
+ * Hook to get dimensions of an element or the viewport.
+ * @param ref
+ */
 export declare const useDimensions: (ref?: React.MutableRefObject<HTMLElement>) => {
     width: number;
     height: number;
 };
+/**
+ * Hook to get and set URL search parameters.
+ * @template T The type of the URL parameters.
+ * @returns An object containing the current URL parameters and a function to set a parameter.
+ */
+export declare const useSearchParams: <T>() => {
+    params: T;
+    setParam: <TKey extends keyof T, TValue extends T[TKey]>(key: TKey, value: TValue) => void;
+    clearParams: <TKey extends keyof T>(...keys: TKey[]) => void;
+};

package/dist/helpers/utilities.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useDimensions = exports.usePubSub = exports.useIsVisible = exports.tryParseJson = exports.Deferred = exports.getUrlParams = exports.insertUrlParams = exports.insertUrlParam = exports.toHashCode = exports.StorageUtils = exports.fnWithAuthCheck = exports.formatDollar = exports.useCountdown = exports.importStyleSheet = exports.importScript = exports.preventDefault = void 0;
+exports.useSearchParams = exports.useDimensions = exports.usePubSub = exports.useIsVisible = exports.tryParseJson = exports.Deferred = exports.getUrlParams = exports.insertUrlParams = exports.deleteUrlParam = exports.insertUrlParam = exports.toHashCode = exports.StorageUtils = exports.fnWithAuthCheck = exports.formatDollar = exports.useCountdown = exports.importStyleSheet = exports.importScript = exports.preventDefault = void 0;
 const React = require("react");
 /**
  * Returns a function that will call the given handler and prevent the default event behavior.
@@ -167,6 +167,24 @@ const insertUrlParam = (key, value) => {
     }
 };
 exports.insertUrlParam = insertUrlParam;
+/**
+ * Deletes a URL parameter.
+ * @param key
+ */
+const deleteUrlParam = (key) => {
+    if (history.pushState) {
+        let searchParams = new URLSearchParams(window.location.search);
+        searchParams.delete(key);
+        let newUrl = window.location.protocol +
+            "//" +
+            window.location.host +
+            window.location.pathname +
+            "?" +
+            searchParams.toString();
+        window.history.pushState({ path: newUrl }, "", newUrl);
+    }
+};
+exports.deleteUrlParam = deleteUrlParam;
 /**
  * Inserts multiple URL parameters.
  * @param params An object containing key-value pairs of parameters.
@@ -282,6 +300,10 @@ const usePubSub = () => {
     return { usePub, useSub };
 };
 exports.usePubSub = usePubSub;
+/**
+ * Hook to get dimensions of an element or the viewport.
+ * @param ref
+ */
 const useDimensions = (ref) => {
     const [size, setSize] = React.useState({ width: 0, height: 0 });
     const element = (ref === null || ref === void 0 ? void 0 : ref.current) || document.documentElement;
@@ -296,3 +318,31 @@ const useDimensions = (ref) => {
     return size;
 };
 exports.useDimensions = useDimensions;
+/**
+ * Hook to get and set URL search parameters.
+ * @template T The type of the URL parameters.
+ * @returns An object containing the current URL parameters and a function to set a parameter.
+ */
+const useSearchParams = () => {
+    const [params, setParams] = React.useState((0, exports.getUrlParams)());
+    /**
+     * Sets a URL parameter and updates the state.
+     */
+    const setParam = React.useCallback((key, value) => {
+        (0, exports.insertUrlParam)(key, value);
+        setParams((0, exports.getUrlParams)());
+    }, []);
+    /**
+     * Clears one or more URL parameters and updates the state.
+     */
+    const clearParams = React.useCallback((...keys) => {
+        keys.forEach(key => (0, exports.deleteUrlParam)(key));
+        setParams((0, exports.getUrlParams)());
+    }, []);
+    return {
+        params,
+        setParam,
+        clearParams,
+    };
+};
+exports.useSearchParams = useSearchParams;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dry-ux",
-  "version": "1.74.0",
+  "version": "1.76.0",
   "description": "",
   "main": "dist/index",
   "scripts": {