@altano/use-element-observer 1.0.7 → 2.0.2

package/dist/index.d.ts

@@ -1,2 +1,32 @@
-export * from "./useElementObserver";
-//# sourceMappingURL=index.d.ts.map
+import React from 'react';
+
+interface Context {
+    mountedElements: Set<Element>;
+}
+declare const ElementObserverContext: React.Context<Context | null>;
+interface Options {
+    selector: string;
+    tree: React.ReactNode;
+    useWrapperDiv?: boolean | undefined;
+}
+/**
+ * Allows observing mount/unmount of elements that match a given selector in the
+ * given React tree. Tree must be static: only the mounting of the tree itself
+ * is monitored. If the tree's DOM is dynamically changed those mounts and
+ * unmounts will not be detected.
+ *
+ * @param tree The React tree to observe.
+ * @param onMount The callback that will be passed any elements in the tree that
+ * match the given selector, as they mount.
+ * @param onUnmount The callback that will be passed any elements in the tree
+ * that match the given selector, as they unmount.
+ * @param selector The css selector used to select which elements are observed.
+ * @param useWrapperDiv If `true`, a 'div' will wrap the observed children. If
+ * `false`, `children` must be a single child element that can take a ref (which
+ * will be overwritten).
+ * @returns A tuple of: (1) set of elements and (2) the observed tree to be
+ * rendered.
+ */
+declare function useElementObserver({ tree, selector, useWrapperDiv, }: Options): [Set<Element>, React.ReactElement];
+
+export { ElementObserverContext, type Options, useElementObserver };

package/dist/index.js

@@ -1,9 +1,16 @@
 // src/useElementObserver.tsx
-import React, { useCallback, useContext, useEffect, useRef } from "react";
+import React3 from "react";
 import { useSet } from "@uidotdev/usehooks";
-import { jsx } from "react/jsx-runtime";
-var ElementObserverContext = React.createContext(null);
-function useMountRef({ onMount, onUnmount }) {
+
+// src/Observer.tsx
+import React2, { useCallback, useContext } from "react";
+
+// src/useMountRef.tsx
+import { useEffect, useRef } from "react";
+function useMountRef({
+  onMount,
+  onUnmount
+}) {
   const newRef = useRef(null);
   useEffect(() => {
     const ref = newRef.current;
@@ -16,6 +23,9 @@ function useMountRef({ onMount, onUnmount }) {
   }, [newRef, onMount, onUnmount]);
   return newRef;
 }
+
+// src/Observer.tsx
+import { jsx } from "react/jsx-runtime";
 function ObserveChildWithWrapperDiv({
   children,
   onMount,
@@ -30,8 +40,8 @@ function ObserveChild({
   onUnmount
 }) {
   const newRef = useMountRef({ onMount, onUnmount });
-  const child = React.Children.only(children);
-  return React.cloneElement(child, { ref: newRef });
+  const child = React2.Children.only(children);
+  return React2.cloneElement(child, { ref: newRef });
 }
 function Observer({
   children,
@@ -58,15 +68,20 @@ function Observer({
   const Component = useWrapperDiv ? ObserveChildWithWrapperDiv : ObserveChild;
   return /* @__PURE__ */ jsx(Component, { onMount, onUnmount, children });
 }
+
+// src/useElementObserver.tsx
+import { jsx as jsx2 } from "react/jsx-runtime";
+var ElementObserverContext = React3.createContext(null);
 function useElementObserver({
   tree,
   selector,
   useWrapperDiv = true
 }) {
   const mountedElements = useSet();
-  const observedTree = /* @__PURE__ */ jsx(ElementObserverContext.Provider, { value: { mountedElements }, children: /* @__PURE__ */ jsx(Observer, { selector, useWrapperDiv, children: tree }) });
+  const observedTree = /* @__PURE__ */ jsx2(ElementObserverContext.Provider, { value: { mountedElements }, children: /* @__PURE__ */ jsx2(Observer, { selector, useWrapperDiv, children: tree }) });
   return [mountedElements, observedTree];
 }
 export {
+  ElementObserverContext,
   useElementObserver
 };

package/package.json

@@ -1,56 +1,70 @@
 {
   "name": "@altano/use-element-observer",
-  "version": "1.0.7",
+  "version": "2.0.2",
   "description": "Intersection-Observer-based Scroll Spy React Hook",
-  "type": "module",
+  "homepage": "https://github.com/altano/npm-packages/tree/main/packages/use-element-observer",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/altano/npm-packages",
+    "directory": "packages/use-element-observer"
+  },
+  "license": "ISC",
+  "author": {
+    "name": "Alan Norbauer",
+    "email": "altano@gmail.com",
+    "url": "https://alan.norbauer.com"
+  },
   "sideEffects": false,
+  "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*.js",
     "dist/**/*.d.ts"
   ],
-  "author": {
-    "name": "Alan Norbauer",
-    "email": "altano@gmail.com",
-    "url": "https://alan.norbauer.com"
-  },
-  "license": "UNLICENSED",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/altano/npm-packages",
-    "directory": "packages/use-element-observer"
-  },
-  "homepage": "https://github.com/altano/npm-packages/tree/main/packages/use-element-observer",
   "dependencies": {
     "@uidotdev/usehooks": "^2.4.1"
   },
-  "peerDependencies": {
-    "react": "^18"
-  },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.15.4",
+    "@testing-library/jest-dom": "^6.4.2",
+    "@testing-library/react": "^14.2.2",
     "@types/react": "^18.2.64",
     "@types/react-dom": "^18.2.21",
-    "eslint": "^8.57.0",
-    "prettier": "^3.2.5",
-    "react": "^18.2.0",
-    "tsup": "^8.0.2",
-    "typescript": "^5.4.2",
+    "@vitest/coverage-v8": "^3.0.9",
+    "depcheck": "^1.4.7",
+    "eslint": "^9.22.0",
+    "jsdom": "^25.0.1",
+    "prettier": "^3.3.3",
+    "react": "^18.3.1",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.3",
+    "vitest": "^3.0.9",
+    "@altano/build-config": "0.0.0",
+    "@altano/testing": "0.0.0",
     "@altano/tsconfig": "0.0.0",
-    "eslint-config-altano": "0.0.1"
+    "@altano/vitest-plugins": "1.0.0"
+  },
+  "peerDependencies": {
+    "react": "18.x.x"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "tsup src/index.tsx --format esm --onSuccess \"pnpm build:types\"",
-    "build:types": "tsc --emitDeclarationOnly --declaration",
-    "dev": "tsup src/index.tsx --watch --format esm",
-    "lint": "eslint src/**/*.ts*",
-    "lint:timing": "TIMING=1 eslint src/**/*.ts*",
-    "lint:fix": "TIMING=1 eslint src/**/*.ts* --fix",
+    "build": "tsup --config build-config/tsup.config.browser.ts",
+    "check:exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "check:types:src": "tsc --noEmit",
+    "check:types:test": "tsc --noEmit --project ./tests/tsconfig.json",
+    "check:unused-dependencies": "depcheck",
+    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist",
+    "dev": "pnpm run build --watch",
     "format": "prettier --check src",
     "format:fix": "prettier --write src",
-    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist"
+    "lint": "eslint",
+    "lint:fix": "TIMING=1 pnpm lint --fix",
+    "lint:timing": "TIMING=1 pnpm lint",
+    "test:unit": "vitest --run",
+    "test:unit:watch": "vitest"
   }
 }

package/dist/useElementObserver.d.ts

@@ -1,27 +0,0 @@
-import React from "react";
-interface Options {
-    selector: string;
-    tree: React.ReactNode;
-    useWrapperDiv?: boolean;
-}
-/**
- * Allows observing mount/unmount of elements that match a given selector in the
- * given React tree. Tree must be static: only the mounting of the tree itself
- * is monitored. If the tree's DOM is dynamically changed those mounts and
- * unmounts will not be detected.
- *
- * @param tree The React tree to observe.
- * @param onMount The callback that will be passed any elements in the tree that
- * match the given selector, as they mount.
- * @param onUnmount The callback that will be passed any elements in the tree
- * that match the given selector, as they unmount.
- * @param selector The css selector used to select which elements are observed.
- * @param useWrapperDiv If `true`, a 'div' will wrap the observed children. If
- * `false`, `children` must be a single child element that can take a ref (which
- * will be overwritten).
- * @returns A tuple of: (1) set of elements and (2) the observed tree to be
- * rendered.
- */
-export declare function useElementObserver({ tree, selector, useWrapperDiv, }: Options): [Set<Element>, React.ReactElement];
-export {};
-//# sourceMappingURL=useElementObserver.d.ts.map