@darkroom.engineering/hamo - npm Package Compare versions

Comparing version 1.0.0-dev.1 to 1.0.0-dev.2

dist/hamo.d.ts

@@ -113,2 +113,23 @@ import * as react from 'react';
 
-export { type Rect, useLazyState, useMediaQuery, useObjectFit, useRect, useResizeObserver, useTimeout, useWindowSize };
+/**
+ * @name useIntersectionObserver
+ * @description A React hook that oberves element visibility using IntersectionObserver.
+ * @param {HTMLElement} root (optional)
+ * @param {string} rootMargin (optional, default: `0px`)
+ * @param {number} threshold (optional, default: `0`)
+ * @param {boolean} once (optional, default: `false`)
+ * @param {boolean} lazy (optional, default: `false`)
+ * @param {function} callback (optional)
+ * @param {array} deps (optional)
+ * @returns {array} [setElement, entry]
+ */
+declare function useIntersectionObserver({ root, rootMargin, threshold, once, lazy, callback, }?: {
+    root?: HTMLElement | null;
+    rootMargin?: string;
+    threshold?: number;
+    once?: boolean;
+    lazy?: boolean;
+    callback?: (entry: IntersectionObserverEntry | undefined) => void;
+}, deps?: never[]): readonly [react.Dispatch<react.SetStateAction<HTMLElement | null | undefined>>, IntersectionObserverEntry];
+
+export { type Rect, useIntersectionObserver, useLazyState, useMediaQuery, useObjectFit, useRect, useResizeObserver, useTimeout, useWindowSize };

package.json

 {
   "name": "@darkroom.engineering/hamo",
-  "version": "1.0.0-dev.1",
+  "version": "1.0.0-dev.2",
   "description": "hamo means hook, do the math.",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -5,3 +5,3 @@ [![HAMO](https://assets.darkroom.engineering/hamo/header.png)](https://github.com/darkroomengineering/hamo)
 
-`hāmō` means hook in Latin, this package is a collection of custom React hooks.
+`hāmō` means hook in Latin, this package is a collection of custom performance-oriented React hooks.
 
@@ -8,0 +8,0 @@ ## Installation

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52742

increased by10.96%

Lines of code

527

increased by14.07%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes