@pexip-engage-public/utils 0.1.46

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.
Files changed (68) hide show
  1. package/CHANGELOG.md +549 -0
  2. package/README.md +5 -0
  3. package/dist/array.d.ts +8 -0
  4. package/dist/array.d.ts.map +1 -0
  5. package/dist/array.js +22 -0
  6. package/dist/array.js.map +1 -0
  7. package/dist/copyToClipBoard.d.ts +7 -0
  8. package/dist/copyToClipBoard.d.ts.map +1 -0
  9. package/dist/copyToClipBoard.js +22 -0
  10. package/dist/copyToClipBoard.js.map +1 -0
  11. package/dist/get-current-position.d.ts +14 -0
  12. package/dist/get-current-position.d.ts.map +1 -0
  13. package/dist/get-current-position.js +23 -0
  14. package/dist/get-current-position.js.map +1 -0
  15. package/dist/index.d.ts +15 -0
  16. package/dist/index.d.ts.map +1 -0
  17. package/dist/index.js +11 -0
  18. package/dist/index.js.map +1 -0
  19. package/dist/invariant.d.ts +3 -0
  20. package/dist/invariant.d.ts.map +1 -0
  21. package/dist/invariant.js +6 -0
  22. package/dist/invariant.js.map +1 -0
  23. package/dist/object.d.ts +17 -0
  24. package/dist/object.d.ts.map +1 -0
  25. package/dist/object.js +21 -0
  26. package/dist/object.js.map +1 -0
  27. package/dist/safe-json-parse.d.ts +4 -0
  28. package/dist/safe-json-parse.d.ts.map +1 -0
  29. package/dist/safe-json-parse.js +11 -0
  30. package/dist/safe-json-parse.js.map +1 -0
  31. package/dist/type-guard.d.ts +5 -0
  32. package/dist/type-guard.d.ts.map +1 -0
  33. package/dist/type-guard.js +10 -0
  34. package/dist/type-guard.js.map +1 -0
  35. package/dist/useDebouncedState.d.ts +6 -0
  36. package/dist/useDebouncedState.d.ts.map +1 -0
  37. package/dist/useDebouncedState.js +14 -0
  38. package/dist/useDebouncedState.js.map +1 -0
  39. package/dist/useEffectEvent.d.ts +6 -0
  40. package/dist/useEffectEvent.d.ts.map +1 -0
  41. package/dist/useEffectEvent.js +13 -0
  42. package/dist/useEffectEvent.js.map +1 -0
  43. package/dist/useElementSize.d.ts +10 -0
  44. package/dist/useElementSize.d.ts.map +1 -0
  45. package/dist/useElementSize.js +22 -0
  46. package/dist/useElementSize.js.map +1 -0
  47. package/dist/useEventListener.d.ts +5 -0
  48. package/dist/useEventListener.d.ts.map +1 -0
  49. package/dist/useEventListener.js +17 -0
  50. package/dist/useEventListener.js.map +1 -0
  51. package/dist/useIsomorphicLayoutEffect.d.ts +8 -0
  52. package/dist/useIsomorphicLayoutEffect.d.ts.map +1 -0
  53. package/dist/useIsomorphicLayoutEffect.js +8 -0
  54. package/dist/useIsomorphicLayoutEffect.js.map +1 -0
  55. package/package.json +58 -0
  56. package/src/array.ts +29 -0
  57. package/src/copyToClipBoard.tsx +30 -0
  58. package/src/get-current-position.ts +36 -0
  59. package/src/index.tsx +13 -0
  60. package/src/invariant.ts +7 -0
  61. package/src/object.ts +36 -0
  62. package/src/safe-json-parse.ts +10 -0
  63. package/src/type-guard.ts +10 -0
  64. package/src/useDebouncedState.ts +17 -0
  65. package/src/useEffectEvent.ts +17 -0
  66. package/src/useElementSize.ts +35 -0
  67. package/src/useEventListener.ts +30 -0
  68. package/src/useIsomorphicLayoutEffect.ts +9 -0
@@ -0,0 +1,30 @@
1
+ import { useEffect, useRef } from "react";
2
+
3
+ type Options = Pick<AddEventListenerOptions, "capture" | "passive" | "once">;
4
+
5
+ type EventMap = HTMLElementEventMap & DocumentEventMap & WindowEventMap;
6
+
7
+ export function useEventListener<K extends keyof EventMap>(
8
+ eventName: K,
9
+ handler: (event: EventMap[K]) => void,
10
+ element: HTMLElement | Document | Window = document,
11
+ options: Options = {},
12
+ ) {
13
+ const savedHandler = useRef<(event: EventMap[K]) => void>(null);
14
+ const { capture, once, passive } = options;
15
+
16
+ useEffect(() => {
17
+ savedHandler.current = handler;
18
+ }, [handler]);
19
+
20
+ useEffect(() => {
21
+ const eventListener = (event: any) => savedHandler.current?.(event);
22
+
23
+ const opts = { capture, once, passive };
24
+ element.addEventListener(eventName, eventListener, opts);
25
+
26
+ return () => {
27
+ element.removeEventListener(eventName, eventListener, opts);
28
+ };
29
+ }, [eventName, element, capture, passive, once]);
30
+ }
@@ -0,0 +1,9 @@
1
+ import { useLayoutEffect } from "react";
2
+
3
+ /**
4
+ * During SSR, React emits a warning when calling useLayoutEffect.
5
+ * Since neither useLayoutEffect nor useEffect run on the server,
6
+ * we can suppress this by replace it with a noop on the server.
7
+ */
8
+ export const useIsomorphicLayoutEffect =
9
+ typeof document !== "undefined" ? useLayoutEffect : () => {};