@usefy/use-toggle 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +2 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -24,7 +24,8 @@ interface UseToggleReturn {
|
|
|
24
24
|
setValue: (value: boolean) => void;
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
|
-
* A hook for managing boolean state with helpful utilities
|
|
27
|
+
* A hook for managing boolean state with helpful utilities.
|
|
28
|
+
* Provides toggle, setTrue, setFalse, and setValue functions.
|
|
28
29
|
*
|
|
29
30
|
* @param initialValue - Initial boolean value (default: false)
|
|
30
31
|
* @returns Object containing the current value and control functions
|
package/dist/index.d.ts
CHANGED
|
@@ -24,7 +24,8 @@ interface UseToggleReturn {
|
|
|
24
24
|
setValue: (value: boolean) => void;
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
|
-
* A hook for managing boolean state with helpful utilities
|
|
27
|
+
* A hook for managing boolean state with helpful utilities.
|
|
28
|
+
* Provides toggle, setTrue, setFalse, and setValue functions.
|
|
28
29
|
*
|
|
29
30
|
* @param initialValue - Initial boolean value (default: false)
|
|
30
31
|
* @returns Object containing the current value and control functions
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/useToggle.ts"],"sourcesContent":["export { useToggle, type UseToggleReturn } from \"./useToggle\";\r\n","import { useCallback, useState } from \"react\";\r\n\r\n/**\r\n * useToggle return type\r\n */\r\nexport interface UseToggleReturn {\r\n /**\r\n * Current toggle state\r\n */\r\n value: boolean;\r\n /**\r\n * Toggle the current state\r\n */\r\n toggle: () => void;\r\n /**\r\n * Set state to true\r\n */\r\n setTrue: () => void;\r\n /**\r\n * Set state to false\r\n */\r\n setFalse: () => void;\r\n /**\r\n * Set state to a specific value\r\n */\r\n setValue: (value: boolean) => void;\r\n}\r\n\r\n/**\r\n * A hook for managing boolean state with helpful utilities\r\n *\r\n * @param initialValue - Initial boolean value (default: false)\r\n * @returns Object containing the current value and control functions\r\n *\r\n * @example\r\n * ```tsx\r\n * function Modal() {\r\n * const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);\r\n *\r\n * return (\r\n * <>\r\n * <button onClick={setTrue}>Open</button>\r\n * <button onClick={toggle}>Toggle</button>\r\n * {isOpen && <div>Modal Content</div>}\r\n * </>\r\n * );\r\n * }\r\n * ```\r\n */\r\nexport function useToggle(initialValue: boolean = false): UseToggleReturn {\r\n const [value, setValue] = useState<boolean>(initialValue);\r\n\r\n const toggle = useCallback(() => {\r\n setValue((prev) => !prev);\r\n }, []);\r\n\r\n const setTrue = useCallback(() => {\r\n setValue(true);\r\n }, []);\r\n\r\n const setFalse = useCallback(() => {\r\n setValue(false);\r\n }, []);\r\n\r\n const setValueCallback = useCallback((newValue: boolean) => {\r\n setValue(newValue);\r\n }, []);\r\n\r\n return {\r\n value,\r\n toggle,\r\n setTrue,\r\n setFalse,\r\n setValue: setValueCallback,\r\n };\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAsC;
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/useToggle.ts"],"sourcesContent":["export { useToggle, type UseToggleReturn } from \"./useToggle\";\r\n","import { useCallback, useState } from \"react\";\r\n\r\n/**\r\n * useToggle return type\r\n */\r\nexport interface UseToggleReturn {\r\n /**\r\n * Current toggle state\r\n */\r\n value: boolean;\r\n /**\r\n * Toggle the current state\r\n */\r\n toggle: () => void;\r\n /**\r\n * Set state to true\r\n */\r\n setTrue: () => void;\r\n /**\r\n * Set state to false\r\n */\r\n setFalse: () => void;\r\n /**\r\n * Set state to a specific value\r\n */\r\n setValue: (value: boolean) => void;\r\n}\r\n\r\n/**\r\n * A hook for managing boolean state with helpful utilities.\r\n * Provides toggle, setTrue, setFalse, and setValue functions.\r\n *\r\n * @param initialValue - Initial boolean value (default: false)\r\n * @returns Object containing the current value and control functions\r\n *\r\n * @example\r\n * ```tsx\r\n * function Modal() {\r\n * const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);\r\n *\r\n * return (\r\n * <>\r\n * <button onClick={setTrue}>Open</button>\r\n * <button onClick={toggle}>Toggle</button>\r\n * {isOpen && <div>Modal Content</div>}\r\n * </>\r\n * );\r\n * }\r\n * ```\r\n */\r\nexport function useToggle(initialValue: boolean = false): UseToggleReturn {\r\n const [value, setValue] = useState<boolean>(initialValue);\r\n\r\n const toggle = useCallback(() => {\r\n setValue((prev) => !prev);\r\n }, []);\r\n\r\n const setTrue = useCallback(() => {\r\n setValue(true);\r\n }, []);\r\n\r\n const setFalse = useCallback(() => {\r\n setValue(false);\r\n }, []);\r\n\r\n const setValueCallback = useCallback((newValue: boolean) => {\r\n setValue(newValue);\r\n }, []);\r\n\r\n return {\r\n value,\r\n toggle,\r\n setTrue,\r\n setFalse,\r\n setValue: setValueCallback,\r\n };\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAsC;AAkD/B,SAAS,UAAU,eAAwB,OAAwB;AACxE,QAAM,CAAC,OAAO,QAAQ,QAAI,uBAAkB,YAAY;AAExD,QAAM,aAAS,0BAAY,MAAM;AAC/B,aAAS,CAAC,SAAS,CAAC,IAAI;AAAA,EAC1B,GAAG,CAAC,CAAC;AAEL,QAAM,cAAU,0BAAY,MAAM;AAChC,aAAS,IAAI;AAAA,EACf,GAAG,CAAC,CAAC;AAEL,QAAM,eAAW,0BAAY,MAAM;AACjC,aAAS,KAAK;AAAA,EAChB,GAAG,CAAC,CAAC;AAEL,QAAM,uBAAmB,0BAAY,CAAC,aAAsB;AAC1D,aAAS,QAAQ;AAAA,EACnB,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU;AAAA,EACZ;AACF;","names":[]}
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/useToggle.ts"],"sourcesContent":["import { useCallback, useState } from \"react\";\r\n\r\n/**\r\n * useToggle return type\r\n */\r\nexport interface UseToggleReturn {\r\n /**\r\n * Current toggle state\r\n */\r\n value: boolean;\r\n /**\r\n * Toggle the current state\r\n */\r\n toggle: () => void;\r\n /**\r\n * Set state to true\r\n */\r\n setTrue: () => void;\r\n /**\r\n * Set state to false\r\n */\r\n setFalse: () => void;\r\n /**\r\n * Set state to a specific value\r\n */\r\n setValue: (value: boolean) => void;\r\n}\r\n\r\n/**\r\n * A hook for managing boolean state with helpful utilities\r\n *\r\n * @param initialValue - Initial boolean value (default: false)\r\n * @returns Object containing the current value and control functions\r\n *\r\n * @example\r\n * ```tsx\r\n * function Modal() {\r\n * const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);\r\n *\r\n * return (\r\n * <>\r\n * <button onClick={setTrue}>Open</button>\r\n * <button onClick={toggle}>Toggle</button>\r\n * {isOpen && <div>Modal Content</div>}\r\n * </>\r\n * );\r\n * }\r\n * ```\r\n */\r\nexport function useToggle(initialValue: boolean = false): UseToggleReturn {\r\n const [value, setValue] = useState<boolean>(initialValue);\r\n\r\n const toggle = useCallback(() => {\r\n setValue((prev) => !prev);\r\n }, []);\r\n\r\n const setTrue = useCallback(() => {\r\n setValue(true);\r\n }, []);\r\n\r\n const setFalse = useCallback(() => {\r\n setValue(false);\r\n }, []);\r\n\r\n const setValueCallback = useCallback((newValue: boolean) => {\r\n setValue(newValue);\r\n }, []);\r\n\r\n return {\r\n value,\r\n toggle,\r\n setTrue,\r\n setFalse,\r\n setValue: setValueCallback,\r\n };\r\n}\r\n"],"mappings":";AAAA,SAAS,aAAa,gBAAgB;
|
|
1
|
+
{"version":3,"sources":["../src/useToggle.ts"],"sourcesContent":["import { useCallback, useState } from \"react\";\r\n\r\n/**\r\n * useToggle return type\r\n */\r\nexport interface UseToggleReturn {\r\n /**\r\n * Current toggle state\r\n */\r\n value: boolean;\r\n /**\r\n * Toggle the current state\r\n */\r\n toggle: () => void;\r\n /**\r\n * Set state to true\r\n */\r\n setTrue: () => void;\r\n /**\r\n * Set state to false\r\n */\r\n setFalse: () => void;\r\n /**\r\n * Set state to a specific value\r\n */\r\n setValue: (value: boolean) => void;\r\n}\r\n\r\n/**\r\n * A hook for managing boolean state with helpful utilities.\r\n * Provides toggle, setTrue, setFalse, and setValue functions.\r\n *\r\n * @param initialValue - Initial boolean value (default: false)\r\n * @returns Object containing the current value and control functions\r\n *\r\n * @example\r\n * ```tsx\r\n * function Modal() {\r\n * const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);\r\n *\r\n * return (\r\n * <>\r\n * <button onClick={setTrue}>Open</button>\r\n * <button onClick={toggle}>Toggle</button>\r\n * {isOpen && <div>Modal Content</div>}\r\n * </>\r\n * );\r\n * }\r\n * ```\r\n */\r\nexport function useToggle(initialValue: boolean = false): UseToggleReturn {\r\n const [value, setValue] = useState<boolean>(initialValue);\r\n\r\n const toggle = useCallback(() => {\r\n setValue((prev) => !prev);\r\n }, []);\r\n\r\n const setTrue = useCallback(() => {\r\n setValue(true);\r\n }, []);\r\n\r\n const setFalse = useCallback(() => {\r\n setValue(false);\r\n }, []);\r\n\r\n const setValueCallback = useCallback((newValue: boolean) => {\r\n setValue(newValue);\r\n }, []);\r\n\r\n return {\r\n value,\r\n toggle,\r\n setTrue,\r\n setFalse,\r\n setValue: setValueCallback,\r\n };\r\n}\r\n"],"mappings":";AAAA,SAAS,aAAa,gBAAgB;AAkD/B,SAAS,UAAU,eAAwB,OAAwB;AACxE,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAkB,YAAY;AAExD,QAAM,SAAS,YAAY,MAAM;AAC/B,aAAS,CAAC,SAAS,CAAC,IAAI;AAAA,EAC1B,GAAG,CAAC,CAAC;AAEL,QAAM,UAAU,YAAY,MAAM;AAChC,aAAS,IAAI;AAAA,EACf,GAAG,CAAC,CAAC;AAEL,QAAM,WAAW,YAAY,MAAM;AACjC,aAAS,KAAK;AAAA,EAChB,GAAG,CAAC,CAAC;AAEL,QAAM,mBAAmB,YAAY,CAAC,aAAsB;AAC1D,aAAS,QAAQ;AAAA,EACnB,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU;AAAA,EACZ;AACF;","names":[]}
|