@etsoo/react 1.8.42 → 1.8.43

package/lib/cjs/index.d.ts

@@ -24,6 +24,7 @@ export * from "./uses/useAsyncState";
 export * from "./uses/useCombinedRefs";
 export * from "./uses/useDelayedExecutor";
 export * from "./uses/useDimensions";
+export * from "./uses/useLocationState";
 export * from "./uses/useParamsEx";
 export * from "./uses/useRefs";
 export * from "./uses/useRequiredContext";

package/lib/cjs/index.js

@@ -45,6 +45,7 @@ __exportStar(require("./uses/useAsyncState"), exports);
 __exportStar(require("./uses/useCombinedRefs"), exports);
 __exportStar(require("./uses/useDelayedExecutor"), exports);
 __exportStar(require("./uses/useDimensions"), exports);
+__exportStar(require("./uses/useLocationState"), exports);
 __exportStar(require("./uses/useParamsEx"), exports);
 __exportStar(require("./uses/useRefs"), exports);
 __exportStar(require("./uses/useRequiredContext"), exports);

package/lib/cjs/uses/useLocationState.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Location state
+ * @param T Type of state
+ * @returns State
+ * @throws Error if state is null or undefined
+ */
+export declare function useLocationState<T>(): T;

package/lib/cjs/uses/useLocationState.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useLocationState = useLocationState;
+const react_router_dom_1 = require("react-router-dom");
+/**
+ * Location state
+ * @param T Type of state
+ * @returns State
+ * @throws Error if state is null or undefined
+ */
+function useLocationState() {
+    const location = (0, react_router_dom_1.useLocation)();
+    if (location.state == null) {
+        throw new Error(`useLocationState: ${location.pathname} state is required`);
+    }
+    return location.state;
+}

package/lib/mjs/index.d.ts

@@ -24,6 +24,7 @@ export * from "./uses/useAsyncState";
 export * from "./uses/useCombinedRefs";
 export * from "./uses/useDelayedExecutor";
 export * from "./uses/useDimensions";
+export * from "./uses/useLocationState";
 export * from "./uses/useParamsEx";
 export * from "./uses/useRefs";
 export * from "./uses/useRequiredContext";

package/lib/mjs/index.js

@@ -29,6 +29,7 @@ export * from "./uses/useAsyncState";
 export * from "./uses/useCombinedRefs";
 export * from "./uses/useDelayedExecutor";
 export * from "./uses/useDimensions";
+export * from "./uses/useLocationState";
 export * from "./uses/useParamsEx";
 export * from "./uses/useRefs";
 export * from "./uses/useRequiredContext";

package/lib/mjs/uses/useLocationState.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Location state
+ * @param T Type of state
+ * @returns State
+ * @throws Error if state is null or undefined
+ */
+export declare function useLocationState<T>(): T;

package/lib/mjs/uses/useLocationState.js

@@ -0,0 +1,14 @@
+import { useLocation } from "react-router-dom";
+/**
+ * Location state
+ * @param T Type of state
+ * @returns State
+ * @throws Error if state is null or undefined
+ */
+export function useLocationState() {
+    const location = useLocation();
+    if (location.state == null) {
+        throw new Error(`useLocationState: ${location.pathname} state is required`);
+    }
+    return location.state;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/react",
-  "version": "1.8.42",
+  "version": "1.8.43",
   "description": "TypeScript ReactJs UI Independent Framework",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",

package/src/index.ts

@@ -39,6 +39,7 @@ export * from "./uses/useAsyncState";
 export * from "./uses/useCombinedRefs";
 export * from "./uses/useDelayedExecutor";
 export * from "./uses/useDimensions";
+export * from "./uses/useLocationState";
 export * from "./uses/useParamsEx";
 export * from "./uses/useRefs";
 export * from "./uses/useRequiredContext";

package/src/uses/useLocationState.ts

@@ -0,0 +1,17 @@
+import { useLocation } from "react-router-dom";
+
+/**
+ * Location state
+ * @param T Type of state
+ * @returns State
+ * @throws Error if state is null or undefined
+ */
+export function useLocationState<T>() {
+  const location = useLocation();
+
+  if (location.state == null) {
+    throw new Error(`useLocationState: ${location.pathname} state is required`);
+  }
+
+  return location.state as T;
+}