domet 1.0.1 → 1.0.3

package/README.md

@@ -1,12 +1,12 @@
 # domet ・ /ˈdɔ.met/
 
-domet is a lightweight scroll spy hook for React. Track which section is in view, highlight nav items, and build smooth scrolling experiences.
+domet is a lightweight React hook built for scroll-driven interfaces. Use it for classic scroll-spy, but also for progress indicators, lazy section loading, or any UI that needs reliable section awareness.
 
-Uses `requestAnimationFrame` with throttling for 60fps performance. Hysteresis prevents jittery switching near section boundaries.
+Lightweight under the hood: a tight scroll loop and hysteresis for stable, flicker-free section tracking.
 
 For the source code, check out the [GitHub](https://github.com/blksmr/domet).
 
-## Installation
+## Installation ++Requires React 18 or higher++
 
 ```bash
 npm install domet
@@ -184,4 +184,6 @@ The name **domet** comes from Bosnian/Serbian/Croatian and means "reach" or "ran
 
 For issues or feature requests, open an issue on [GitHub](https://github.com/blksmr/domet).
 
+For LLMs, the full documentation is available at [/llms.txt](/llms.txt).
+
 You can also reach out to me on [Twitter](https://x.com/blkasmir).

package/dist/{useDomet.d.ts → cjs/index.d.ts}

@@ -1,10 +1,11 @@
-import type { RefObject } from "react";
-export type SectionBounds = {
+import { RefObject } from 'react';
+
+type SectionBounds = {
     top: number;
     bottom: number;
     height: number;
 };
-export type ScrollState = {
+type ScrollState = {
     y: number;
     progress: number;
     direction: "up" | "down" | null;
@@ -14,15 +15,15 @@ export type ScrollState = {
     viewportHeight: number;
     offset: number;
 };
-export type SectionState = {
+type SectionState = {
     bounds: SectionBounds;
     visibility: number;
     progress: number;
     isInViewport: boolean;
     isActive: boolean;
 };
-export type ScrollBehavior = "smooth" | "instant" | "auto";
-export type DometOptions = {
+type ScrollBehavior = "smooth" | "instant" | "auto";
+type DometOptions = {
     offset?: number;
     offsetRatio?: number;
     debounceMs?: number;
@@ -35,17 +36,17 @@ export type DometOptions = {
     onScrollStart?: () => void;
     onScrollEnd?: () => void;
 };
-export type SectionProps = {
+type SectionProps = {
     id: string;
     ref: (el: HTMLElement | null) => void;
     "data-domet": string;
 };
-export type NavProps = {
+type NavProps = {
     onClick: () => void;
     "aria-current": "page" | undefined;
     "data-active": boolean;
 };
-export type UseDometReturn = {
+type UseDometReturn = {
     activeId: string | null;
     activeIndex: number;
     scroll: ScrollState;
@@ -55,6 +56,7 @@ export type UseDometReturn = {
     sectionProps: (id: string) => SectionProps;
     navProps: (id: string) => NavProps;
 };
-export declare function useDomet(sectionIds: string[], containerRef?: RefObject<HTMLElement> | null, options?: DometOptions): UseDometReturn;
-export default useDomet;
-//# sourceMappingURL=useDomet.d.ts.map
+declare function useDomet(sectionIds: string[], containerRef?: RefObject<HTMLElement> | null, options?: DometOptions): UseDometReturn;
+
+export { useDomet as default, useDomet };
+export type { DometOptions, NavProps, ScrollBehavior, ScrollState, SectionBounds, SectionProps, SectionState, UseDometReturn };