@jobber/hooks 2.6.3 → 2.7.0

package/README.mdx

@@ -5,6 +5,7 @@ Shared hooks for components in Atlantis.
 ## Hooks
 
 - [useAssert](../?path=/docs/hooks-useassert--page)
+- [useBool](../?path=/docs/hooks-usebool--page)
 - [useCollectionQuery](../?path=/docs/hooks-usecollectionquery--use-collection-query)
 - [useFormState](../?path=/docs/hooks-useformstate--use-form-state)
 - [useIsMounted](../?path=/docs/hooks-useismounted--use-is-mounted)

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./useAssert";
+export * from "./useBool";
 export * from "./useBreakpoints";
 export * from "./useCollectionQuery";
 export * from "./useFocusTrap";

package/dist/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./useAssert"), exports);
+__exportStar(require("./useBool"), exports);
 __exportStar(require("./useBreakpoints"), exports);
 __exportStar(require("./useCollectionQuery"), exports);
 __exportStar(require("./useFocusTrap"), exports);

package/dist/useBool/index.d.ts

@@ -0,0 +1 @@
+export { useBool } from "./useBool";

package/dist/useBool/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useBool = void 0;
+var useBool_1 = require("./useBool");
+Object.defineProperty(exports, "useBool", { enumerable: true, get: function () { return useBool_1.useBool; } });

package/dist/useBool/useBool.d.ts

@@ -0,0 +1,13 @@
+declare const brand: unique symbol;
+type Callback = () => void;
+export type SetTrue = Callback & {
+    [brand]: "SetTrue";
+};
+export type SetFalse = Callback & {
+    [brand]: "SetFalse";
+};
+export type Toggle = Callback & {
+    [brand]: "Toggle";
+};
+export declare function useBool(initialState?: boolean): [boolean, SetTrue, SetFalse, Toggle];
+export {};

package/dist/useBool/useBool.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useBool = void 0;
+const react_1 = require("react");
+function useBool(initialState = false) {
+    const [state, setState] = (0, react_1.useState)(initialState);
+    const setTrue = (0, react_1.useCallback)(() => setState(true), []);
+    const setFalse = (0, react_1.useCallback)(() => setState(false), []);
+    const toggle = (0, react_1.useCallback)(() => setState(current => !current), []);
+    return [state, setTrue, setFalse, toggle];
+}
+exports.useBool = useBool;

package/dist/useBool/useBool.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/useBool/useBool.test.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = require("@testing-library/react");
+const useBool_1 = require("./useBool");
+describe("useBool, a hook for managing boolean state", () => {
+    it("by default has an initial state that is `false`", () => {
+        const [value] = (0, react_1.renderHook)(() => (0, useBool_1.useBool)()).result.current;
+        expect(value).toBe(false);
+    });
+    it("can be provided an initial state", () => {
+        const [value] = (0, react_1.renderHook)(() => (0, useBool_1.useBool)(true)).result.current;
+        expect(value).toBe(true);
+    });
+    it("provides helpful setters and a toggle method", () => {
+        const { result } = (0, react_1.renderHook)(() => (0, useBool_1.useBool)());
+        const value = () => result.current[0];
+        const [, setTrue, setFalse, toggle] = result.current;
+        expect(value()).toBe(false);
+        (0, react_1.act)(setTrue);
+        expect(value()).toBe(true);
+        (0, react_1.act)(setFalse);
+        expect(value()).toBe(false);
+        (0, react_1.act)(toggle);
+        expect(value()).toBe(true);
+        (0, react_1.act)(toggle);
+        expect(value()).toBe(false);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jobber/hooks",
-  "version": "2.6.3",
+  "version": "2.7.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",
@@ -45,5 +45,5 @@
     "@apollo/client": "^3.0.0",
     "react": "^18"
   },
-  "gitHead": "6e42ff7d712d09ecd2214b0fccae8c39bc51afec"
+  "gitHead": "7d69952a16458e6fcafd0a5e4215bab444d074dc"
 }

package/useBool.d.ts

@@ -0,0 +1 @@
+export * from "./dist/useBool";

package/useBool.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+
+var useBool = require("./dist/useBool");
+
+Object.keys(useBool).forEach(function(key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return useBool[key];
+    },
+  });
+});