@gateweb/react-utils 1.15.0 → 1.16.0

package/dist/cjs/index.d.ts

@@ -1226,6 +1226,26 @@ type TCountdownActions = {
  */
 declare const useCountdown: (initialCountdown: number, enableReinitialize?: boolean) => TCountdownActions;
 
+type UseDisclosureReturn = {
+    /** Whether the disclosure is currently open. */
+    isOpen: boolean;
+    /** Open the disclosure (sets isOpen = true). */
+    open: () => void;
+    /** Close the disclosure (sets isOpen = false). */
+    close: () => void;
+    /** Toggle the disclosure state (open -> close or close -> open). */
+    toggle: () => void;
+};
+/**
+ * A small hook to control open/close state.
+ *
+ * Supports an optional controlled pattern by passing `isOpen` and `onChange`.
+ *
+ * @example
+ * const { isOpen, open, close, toggle } = useDisclosure();
+ */
+declare function useDisclosure(initialState?: boolean): UseDisclosureReturn;
+
 type TValueOptions<T> = AtLeastOne<{
     /**
      * The controlled value.
@@ -1335,5 +1355,5 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { ByteSize, MimeTypeMap, OtherMimeType, QueryProvider, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createDataContext, createEnumLikeObject, debounce, deepClone, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNil, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeConfig, mergeRefs, objectToSearchParams, omit, omitByValue, parseFileInfoFromFilename, parseFilenameFromDisposition, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, renameKey, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };
-export type { MimeTypeExtension, MimeTypeValue, PartialBy, RequiredBy, TCountdownActions };
+export { ByteSize, MimeTypeMap, OtherMimeType, QueryProvider, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createDataContext, createEnumLikeObject, debounce, deepClone, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNil, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeConfig, mergeRefs, objectToSearchParams, omit, omitByValue, parseFileInfoFromFilename, parseFilenameFromDisposition, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, renameKey, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useDisclosure, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };
+export type { MimeTypeExtension, MimeTypeValue, PartialBy, RequiredBy, TCountdownActions, UseDisclosureReturn };

package/dist/cjs/index.js

@@ -4,6 +4,7 @@ var dayjs = require('dayjs');
 var queryStore12s = require('./queryStore-12s-q_SLGgYH.js');
 var React = require('react');
 var useCountdown12s = require('./useCountdown-12s-uiqhgllY.js');
+var useDisclosure12s = require('./useDisclosure-12s-SZtbSE4A.js');
 var download12s = require('./download-12s-DKxkL92w.js');
 var webStorage12s = require('./webStorage-12s-DHr9PcPl.js');
 
@@ -1423,6 +1424,7 @@ function mergeRefs(refs) {
 exports.QueryProvider = queryStore12s.QueryProvider;
 exports.useQueryContext = queryStore12s.useQueryContext;
 exports.useCountdown = useCountdown12s.useCountdown;
+exports.useDisclosure = useDisclosure12s.useDisclosure;
 exports.downloadFile = download12s.downloadFile;
 exports.getLocalStorage = webStorage12s.getLocalStorage;
 exports.setLocalStorage = webStorage12s.setLocalStorage;

package/dist/cjs/useDisclosure-12s-SZtbSE4A.js

@@ -0,0 +1,24 @@
+'use client';
+var React = require('react');
+
+/**
+ * A small hook to control open/close state.
+ *
+ * Supports an optional controlled pattern by passing `isOpen` and `onChange`.
+ *
+ * @example
+ * const { isOpen, open, close, toggle } = useDisclosure();
+ */ function useDisclosure(initialState = false) {
+    const [isOpen, setIsOpen] = React.useState(initialState);
+    const open = React.useCallback(()=>setIsOpen(true), []);
+    const close = React.useCallback(()=>setIsOpen(false), []);
+    const toggle = React.useCallback(()=>setIsOpen((prev)=>!prev), []);
+    return {
+        isOpen,
+        open,
+        close,
+        toggle
+    };
+}
+
+exports.useDisclosure = useDisclosure;

package/dist/es/index.d.mts

@@ -1226,6 +1226,26 @@ type TCountdownActions = {
  */
 declare const useCountdown: (initialCountdown: number, enableReinitialize?: boolean) => TCountdownActions;
 
+type UseDisclosureReturn = {
+    /** Whether the disclosure is currently open. */
+    isOpen: boolean;
+    /** Open the disclosure (sets isOpen = true). */
+    open: () => void;
+    /** Close the disclosure (sets isOpen = false). */
+    close: () => void;
+    /** Toggle the disclosure state (open -> close or close -> open). */
+    toggle: () => void;
+};
+/**
+ * A small hook to control open/close state.
+ *
+ * Supports an optional controlled pattern by passing `isOpen` and `onChange`.
+ *
+ * @example
+ * const { isOpen, open, close, toggle } = useDisclosure();
+ */
+declare function useDisclosure(initialState?: boolean): UseDisclosureReturn;
+
 type TValueOptions<T> = AtLeastOne<{
     /**
      * The controlled value.
@@ -1335,5 +1355,5 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { ByteSize, MimeTypeMap, OtherMimeType, QueryProvider, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createDataContext, createEnumLikeObject, debounce, deepClone, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNil, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeConfig, mergeRefs, objectToSearchParams, omit, omitByValue, parseFileInfoFromFilename, parseFilenameFromDisposition, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, renameKey, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };
-export type { MimeTypeExtension, MimeTypeValue, PartialBy, RequiredBy, TCountdownActions };
+export { ByteSize, MimeTypeMap, OtherMimeType, QueryProvider, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createDataContext, createEnumLikeObject, debounce, deepClone, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNil, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeConfig, mergeRefs, objectToSearchParams, omit, omitByValue, parseFileInfoFromFilename, parseFilenameFromDisposition, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, renameKey, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useDisclosure, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };
+export type { MimeTypeExtension, MimeTypeValue, PartialBy, RequiredBy, TCountdownActions, UseDisclosureReturn };

package/dist/es/index.mjs

@@ -2,6 +2,7 @@ import dayjs from 'dayjs';
 export { Q as QueryProvider, u as useQueryContext } from './queryStore-12s-CFQTVwrg.mjs';
 import React, { useMemo, createContext, useContext, useState, useCallback } from 'react';
 export { u as useCountdown } from './useCountdown-12s-t52WIHfq.mjs';
+export { u as useDisclosure } from './useDisclosure-12s-BQAHpAXK.mjs';
 export { d as downloadFile } from './download-12s-CnaJ0p_f.mjs';
 export { g as getLocalStorage, s as setLocalStorage } from './webStorage-12s-W1DItzhS.mjs';
 

package/dist/es/useDisclosure-12s-BQAHpAXK.mjs

@@ -0,0 +1,24 @@
+'use client';
+import { useState, useCallback } from 'react';
+
+/**
+ * A small hook to control open/close state.
+ *
+ * Supports an optional controlled pattern by passing `isOpen` and `onChange`.
+ *
+ * @example
+ * const { isOpen, open, close, toggle } = useDisclosure();
+ */ function useDisclosure(initialState = false) {
+    const [isOpen, setIsOpen] = useState(initialState);
+    const open = useCallback(()=>setIsOpen(true), []);
+    const close = useCallback(()=>setIsOpen(false), []);
+    const toggle = useCallback(()=>setIsOpen((prev)=>!prev), []);
+    return {
+        isOpen,
+        open,
+        close,
+        toggle
+    };
+}
+
+export { useDisclosure as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gateweb/react-utils",
-  "version": "1.15.0",
+  "version": "1.16.0",
   "description": "React Utils for GateWeb",
   "homepage": "https://github.com/GatewebSolutions/react-utils",
   "files": [
@@ -31,16 +31,6 @@
       }
     }
   },
-  "scripts": {
-    "prepare": "husky",
-    "run-code": "ts-node src/period.ts",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
-    "test:ui": "vitest --ui --coverage.enabled=true",
-    "build": "bunchee",
-    "build:prepare": "bunchee --prepare"
-  },
   "publishConfig": {
     "access": "public"
   },
@@ -79,5 +69,13 @@
       "@commitlint/config-conventional"
     ]
   },
-  "packageManager": "pnpm@10.11.0"
+  "scripts": {
+    "run-code": "ts-node src/period.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui --coverage.enabled=true",
+    "build": "bunchee",
+    "build:prepare": "bunchee --prepare"
+  }
 }