@hoosk/minisignals-react 1.0.3 → 1.0.4

package/README.md

@@ -0,0 +1,34 @@
+# @hoosk/minisignals-react
+
+The React 18 adapter for `@hoosk/minisignals`.
+
+This package provides custom hooks to seamlessly integrate the agnostic reactive signals with React's component lifecycle and rendering engine. It utilizes React 18's `useSyncExternalStore` for tear-free concurrent rendering.
+
+## Installation
+
+```bash
+npm install @hoosk/minisignals @hoosk/minisignals-react
+```
+
+## Basic Usage
+
+```tsx
+import { useSignal, useSignalValue } from '@hoosk/minisignals-react';
+
+function Counter() {
+  // Create a local signal that survives re-renders
+  const count = useSignal(0);
+  
+  // Connect the signal to trigger React renders on mutation
+  const value = useSignalValue(count);
+
+  return (
+    <div>
+      <p>Count: {value}</p>
+      <button onClick={() => count.value++}>Increment</button>
+    </div>
+  );
+}
+```
+
+For full documentation, please refer to the [main repository README](../../README.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hoosk/minisignals-react",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "React adapter for @hoosk/minisignals",
   "type": "module",
   "main": "dist/index.js",

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './useSignalValue';
-export * from './useSignal';

package/src/useSignal.ts

@@ -1,20 +0,0 @@
-import { useRef } from 'react';
-import { signal, Signal } from '@hoosk/minisignals';
-
-/**
- * Creates a signal that is tied to the component's lifecycle.
- * The signal instance is preserved across re-renders.
- * NOTE: To trigger a re-render on value change, you must use `useSignalValue(sig)`.
- * 
- * @param initialValue The starting value of the signal.
- * @returns A stable Signal instance.
- */
-export function useSignal<T>(initialValue: T): Signal<T> {
-  const signalRef = useRef<Signal<T> | null>(null);
-
-  if (signalRef.current === null) {
-    signalRef.current = signal(initialValue);
-  }
-
-  return signalRef.current;
-}

package/src/useSignalValue.ts

@@ -1,36 +0,0 @@
-import { useSyncExternalStore, useCallback } from 'react';
-import { effect, Signal, Computed } from '@hoosk/minisignals';
-
-/**
- * A hook that subscribes to a signal or computed value and triggers
- * a React re-render whenever the value changes.
- * Uses React 18's useSyncExternalStore for tear-free concurrent rendering.
- * 
- * @param sig The Signal or Computed to observe.
- * @returns The current value of the signal.
- */
-export function useSignalValue<T>(sig: Signal<T> | Computed<T>): T {
-  const subscribe = useCallback(
-    (onStoreChange: () => void) => {
-      let isInitialRun = true;
-      
-      const unsubscribe = effect(() => {
-        const _val = sig.value;
-        
-        if (!isInitialRun) {
-          onStoreChange();
-        }
-        isInitialRun = false;
-      });
-
-      return unsubscribe;
-    },
-    [sig]
-  );
-
-  return useSyncExternalStore(
-    subscribe,
-    () => sig.value, // getSnapshot
-    () => sig.value  // getServerSnapshot (SSR support)
-  );
-}

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./dist"
-  },
-  "include": ["src/**/*"]
-}