@altano/use-element-observer 2.0.2 → 3.0.0

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 (3) hide show
  1. package/dist/index.d.ts +16 -4
  2. package/dist/index.js +4 -6
  3. package/package.json +14 -16
package/dist/index.d.ts CHANGED
@@ -1,14 +1,26 @@
1
1
  import React from 'react';
2
2
 
3
+ type ReactElementWithRef = React.ReactElement<{
4
+ ref: React.Ref<Element>;
5
+ }>;
6
+
3
7
  interface Context {
4
8
  mountedElements: Set<Element>;
5
9
  }
6
10
  declare const ElementObserverContext: React.Context<Context | null>;
7
- interface Options {
11
+ type Options = ChildOptions & {
8
12
  selector: string;
13
+ };
14
+ type ChildOptions = {
15
+ useWrapperDiv: false;
16
+ tree: ReactElementWithRef;
17
+ } | {
18
+ useWrapperDiv: true;
9
19
  tree: React.ReactNode;
10
- useWrapperDiv?: boolean | undefined;
11
- }
20
+ } | {
21
+ useWrapperDiv?: undefined;
22
+ tree: React.ReactNode;
23
+ };
12
24
  /**
13
25
  * Allows observing mount/unmount of elements that match a given selector in the
14
26
  * given React tree. Tree must be static: only the mounting of the tree itself
@@ -29,4 +41,4 @@ interface Options {
29
41
  */
30
42
  declare function useElementObserver({ tree, selector, useWrapperDiv, }: Options): [Set<Element>, React.ReactElement];
31
43
 
32
- export { ElementObserverContext, type Options, useElementObserver };
44
+ export { type ChildOptions, ElementObserverContext, type Options, type ReactElementWithRef, useElementObserver };
package/dist/index.js CHANGED
@@ -40,8 +40,7 @@ function ObserveChild({
40
40
  onUnmount
41
41
  }) {
42
42
  const newRef = useMountRef({ onMount, onUnmount });
43
- const child = React2.Children.only(children);
44
- return React2.cloneElement(child, { ref: newRef });
43
+ return React2.cloneElement(children, { ref: newRef });
45
44
  }
46
45
  function Observer({
47
46
  children,
@@ -65,8 +64,7 @@ function Observer({
65
64
  () => mountedElements.clear(),
66
65
  [mountedElements]
67
66
  );
68
- const Component = useWrapperDiv ? ObserveChildWithWrapperDiv : ObserveChild;
69
- return /* @__PURE__ */ jsx(Component, { onMount, onUnmount, children });
67
+ return useWrapperDiv ? /* @__PURE__ */ jsx(ObserveChildWithWrapperDiv, { onMount, onUnmount, children }) : /* @__PURE__ */ jsx(ObserveChild, { onMount, onUnmount, children });
70
68
  }
71
69
 
72
70
  // src/useElementObserver.tsx
@@ -75,10 +73,10 @@ var ElementObserverContext = React3.createContext(null);
75
73
  function useElementObserver({
76
74
  tree,
77
75
  selector,
78
- useWrapperDiv = true
76
+ useWrapperDiv
79
77
  }) {
80
78
  const mountedElements = useSet();
81
- const observedTree = /* @__PURE__ */ jsx2(ElementObserverContext.Provider, { value: { mountedElements }, children: /* @__PURE__ */ jsx2(Observer, { selector, useWrapperDiv, children: tree }) });
79
+ const observedTree = /* @__PURE__ */ jsx2(ElementObserverContext.Provider, { value: { mountedElements }, children: useWrapperDiv == null || useWrapperDiv === true ? /* @__PURE__ */ jsx2(Observer, { selector, useWrapperDiv: true, children: tree }) : /* @__PURE__ */ jsx2(Observer, { selector, useWrapperDiv: false, children: tree }) });
82
80
  return [mountedElements, observedTree];
83
81
  }
84
82
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@altano/use-element-observer",
3
- "version": "2.0.2",
3
+ "version": "3.0.0",
4
4
  "description": "Intersection-Observer-based Scroll Spy React Hook",
5
5
  "homepage": "https://github.com/altano/npm-packages/tree/main/packages/use-element-observer",
6
6
  "repository": {
@@ -26,27 +26,25 @@
26
26
  "@uidotdev/usehooks": "^2.4.1"
27
27
  },
28
28
  "devDependencies": {
29
- "@arethetypeswrong/cli": "^0.15.4",
30
- "@testing-library/jest-dom": "^6.4.2",
31
- "@testing-library/react": "^14.2.2",
32
- "@types/react": "^18.2.64",
33
- "@types/react-dom": "^18.2.21",
34
- "@vitest/coverage-v8": "^3.0.9",
29
+ "@arethetypeswrong/cli": "^0.17.4",
30
+ "@testing-library/react": "^16.2.0",
31
+ "@types/react": "^19.0.12",
32
+ "@types/react-dom": "^19.0.4",
33
+ "@vitest/coverage-v8": "^3.1.1",
35
34
  "depcheck": "^1.4.7",
36
- "eslint": "^9.22.0",
37
- "jsdom": "^25.0.1",
38
- "prettier": "^3.3.3",
39
- "react": "^18.3.1",
35
+ "eslint": "^9.23.0",
36
+ "jsdom": "^26.0.0",
37
+ "prettier": "^3.5.3",
38
+ "react": "^19.1.0",
40
39
  "typescript": "^5.8.2",
41
- "vite": "^6.2.3",
42
- "vitest": "^3.0.9",
40
+ "vite": "^6.2.4",
41
+ "vitest": "^3.1.1",
43
42
  "@altano/build-config": "0.0.0",
44
- "@altano/testing": "0.0.0",
45
43
  "@altano/tsconfig": "0.0.0",
46
- "@altano/vitest-plugins": "1.0.0"
44
+ "@altano/testing": "0.0.0"
47
45
  },
48
46
  "peerDependencies": {
49
- "react": "18.x.x"
47
+ "react": "19.x.x"
50
48
  },
51
49
  "publishConfig": {
52
50
  "access": "public"