@jobber/hooks 2.7.2 → 2.8.0

package/dist/index.d.ts

@@ -11,3 +11,4 @@ export * from "./useOnKeyDown";
 export * from "./usePasswordStrength";
 export * from "./useRefocusOnActivator";
 export * from "./useResizeObserver";
+export * from "./useShowClear";

package/dist/index.js

@@ -27,3 +27,4 @@ __exportStar(require("./useOnKeyDown"), exports);
 __exportStar(require("./usePasswordStrength"), exports);
 __exportStar(require("./useRefocusOnActivator"), exports);
 __exportStar(require("./useResizeObserver"), exports);
+__exportStar(require("./useShowClear"), exports);

package/dist/useShowClear/index.d.ts

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

package/dist/useShowClear/index.js

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

package/dist/useShowClear/useShowClear.d.ts

@@ -0,0 +1,10 @@
+export type Clearable = "never" | "while-editing" | "always";
+interface UseShowClearParameters {
+    clearable: Clearable;
+    multiline: boolean;
+    focused: boolean;
+    hasValue: boolean;
+    disabled?: boolean;
+}
+export declare function useShowClear({ clearable, multiline, focused, hasValue, disabled, }: UseShowClearParameters): boolean | undefined;
+export {};

package/dist/useShowClear/useShowClear.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useShowClear = void 0;
+function useShowClear({ clearable, multiline, focused, hasValue, disabled = false, }) {
+    if (multiline && clearable !== "never") {
+        throw new Error("Multiline inputs can not be clearable");
+    }
+    // Do not show if there is no value
+    if (!hasValue || clearable === "never" || disabled) {
+        return false;
+    }
+    switch (clearable) {
+        case "while-editing":
+            return focused;
+        case "always":
+            return true;
+    }
+}
+exports.useShowClear = useShowClear;

package/dist/useShowClear/useShowClear.test.d.ts

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

package/dist/useShowClear/useShowClear.test.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const useShowClear_1 = require("./useShowClear");
+describe("useShowClear", () => {
+    describe.each([
+        {
+            clearable: "always",
+            hasValue: true,
+            focused: false,
+            multiline: false,
+            disabled: false,
+            expected: true,
+        },
+        {
+            clearable: "always",
+            hasValue: true,
+            focused: true,
+            multiline: false,
+            disabled: false,
+            expected: true,
+        },
+        {
+            clearable: "always",
+            hasValue: true,
+            focused: false,
+            multiline: false,
+            disabled: true,
+            expected: false,
+        },
+        {
+            clearable: "always",
+            hasValue: false,
+            focused: false,
+            multiline: false,
+            disabled: true,
+            expected: false,
+        },
+        {
+            clearable: "while-editing",
+            hasValue: true,
+            focused: false,
+            multiline: false,
+            disabled: false,
+            expected: false,
+        },
+        {
+            clearable: "while-editing",
+            hasValue: true,
+            focused: true,
+            multiline: false,
+            disabled: false,
+            expected: true,
+        },
+        {
+            clearable: "while-editing",
+            hasValue: false,
+            focused: false,
+            multiline: false,
+            disabled: true,
+            expected: false,
+        },
+        {
+            clearable: "while-editing",
+            hasValue: true,
+            focused: false,
+            multiline: false,
+            disabled: true,
+            expected: false,
+        },
+        {
+            clearable: "never",
+            hasValue: true,
+            focused: false,
+            multiline: false,
+            disabled: false,
+            expected: false,
+        },
+        {
+            clearable: "never",
+            hasValue: true,
+            focused: true,
+            multiline: false,
+            disabled: false,
+            expected: false,
+        },
+        {
+            clearable: "never",
+            hasValue: false,
+            focused: false,
+            multiline: false,
+            disabled: true,
+            expected: false,
+        },
+        {
+            clearable: "never",
+            hasValue: true,
+            focused: false,
+            multiline: false,
+            disabled: true,
+            expected: false,
+        },
+    ])("%j", ({ clearable, hasValue, focused, multiline, disabled, expected, }) => {
+        it(`returns ${expected}`, () => {
+            expect((0, useShowClear_1.useShowClear)({ clearable, multiline, focused, hasValue, disabled })).toEqual(expected);
+        });
+    });
+    it("throws an error if multiline is true and clearable isn't never", () => {
+        expect(() => {
+            (0, useShowClear_1.useShowClear)({
+                clearable: "always",
+                multiline: true,
+                focused: true,
+                hasValue: true,
+                disabled: false,
+            });
+        }).toThrow();
+        expect(() => {
+            (0, useShowClear_1.useShowClear)({
+                clearable: "while-editing",
+                multiline: true,
+                focused: true,
+                hasValue: true,
+                disabled: false,
+            });
+        }).toThrow();
+        expect(() => {
+            (0, useShowClear_1.useShowClear)({
+                clearable: "never",
+                multiline: true,
+                focused: true,
+                hasValue: true,
+                disabled: false,
+            });
+        }).not.toThrow();
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jobber/hooks",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",
@@ -44,5 +44,5 @@
     "@apollo/client": "^3.0.0",
     "react": "^18"
   },
-  "gitHead": "e925163219d4d3c15d78318cfff03f6240c19ef3"
+  "gitHead": "300688dd8bf005f2d0f6fb06a0f913f0a208a937"
 }

package/useShowClear.d.ts

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

package/useShowClear.js

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