@thefoxieflow/signalctx 1.0.0 → 1.0.1

package/README.md

@@ -167,7 +167,7 @@ set((s) => {
 Scoped update:
 
 ```ts
-const store = newStore(() => ({
+const store = newSignal(() => ({
   book: { title: "1984", page: 1 },
   user: { name: "Alice" },
 }));
@@ -212,7 +212,7 @@ The returned function has these properties:
 - **`useAppCtx(selector, options)`** - Hook to select state
 - **`useAppCtx.Provider`** - Context provider component
 - **`useAppCtx.useSet(selector, options)`** - Hook to get setter function
-- **`useAppCtx.useStore(options)`** - Hook to access raw store
+- **`useAppCtx.useSignal(options)`** - Hook to access raw signal underlying the context
 
 ---
 
@@ -226,12 +226,12 @@ type Props = {
   children: React.ReactNode;
 };
 
-export function StoreProvider({ children }: Props) {
+export function AppCtxProvider({ children }: Props) {
   return <useAppCtx.Provider>{children}</useAppCtx.Provider>;
 }
 
 // overwrite value
-export function StoreProvider({ children }: Props) {
+export function AppCtxProvider({ children }: Props) {
   return (
     <useAppCtx.Provider
       value={{
@@ -246,9 +246,9 @@ export function StoreProvider({ children }: Props) {
 ```
 
 ```tsx
-<StoreProvider>
+<AppCtxProvider>
   <App />
-</StoreProvider>
+</AppCtxProvider>
 ```
 
 ---
@@ -360,18 +360,18 @@ const count = useAppCtx((s) => s.count);
 
 ## 🧩 Multiple Stores
 
-You can create isolated stores using `storeName`.
+You can create isolated stores using `name`.
 
 ```tsx
 type Props = {
   children: React.ReactNode;
-  storeName?: string;
+  name?: string;
   initialValue?: { count: number; book: { title: string } };
 };
 
-export function StoreProvider({ children, storeName, initialValue }: Props) {
+export function AppCtxProvider({ children, name, initialValue }: Props) {
   return (
-    <useAppCtx.Provider value={initialValue} storeName={storeName}>
+    <useAppCtx.Provider value={initialValue} name={name}>
       {children}
     </useAppCtx.Provider>
   );
@@ -381,31 +381,28 @@ export function StoreProvider({ children, storeName, initialValue }: Props) {
 ### Usage
 
 ```tsx
-<StoreProvider
-  storeName="storeA"
-  initialValue={{ count: 1, book: { title: "A" } }}
->
+<AppCtxProvider name="storeA" initialValue={{ count: 1, book: { title: "A" } }}>
   {/* useAppCtx(s => s.book) is from storeA */}
   <AppA />
-  <StoreProvider
-    storeName="storeB"
+  <AppCtxProvider
+    name="storeB"
     initialValue={{ count: 5, book: { title: "B" } }}
   >
     {/* useAppCtx(s => s.book) is from storeB */}
-    {/* useAppCtx(s => s.book, { storeName: "storeA" }) is from storeA */}
+    {/* useAppCtx(s => s.book, { name: "storeA" }) is from storeA */}
     <AppB />
-  </StoreProvider>
-</StoreProvider>;
+  </AppCtxProvider>
+</AppCtxProvider>;
 
 function AppB() {
   // Read from parent storeB, book.title = "B"
-  const currentBook = useAppCtx((s) => s.book); // or useAppCtx(s => s.book, { storeName: "storeB" })
+  const currentBook = useAppCtx((s) => s.book); // or useAppCtx(s => s.book, { name: "storeB" })
 
-  const layerAbook = useAppCtx((s) => s.book, { storeName: "storeA" }); // book.title = "A"
+  const layerAbook = useAppCtx((s) => s.book, { name: "storeA" }); // book.title = "A"
 
   // AppB want to change data in context StoreA layer
   const setLayerAbook = useAppCtx.useSet((s) => s.book, {
-    storeName: "storeA",
+    name: "storeA",
   });
 
   const handleSetLayerABook = (text) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thefoxieflow/signalctx",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Lightweight signal-based React context store",
   "main": "dist/index.cjs",
   "module": "dist/index.js",