use-synchronized-state 1.0.5 → 1.0.6

package/README.md

@@ -27,7 +27,7 @@ import { useSyncState } from 'use-synchronized-state';
 
 function ParentComponent() {
   const [parentState, setParentState] = useState(0);
-  
+
   return (
     <ChildComponent parentState={parentState} />
   );
@@ -41,12 +41,12 @@ function ChildComponent({ parentState }: { parentState: number }) {
 ```
 
 ## Description
-This hook creates a synchronized state while avoiding the cascading updates issue. 
+This hook creates a synchronized state while avoiding the cascading updates issue.
 In our case, synchronized means:
 - When there is a change in the reactive value that we synchronize our state with,
 the returned state changes to the same value, but it can also change independently when the returned setState is called.
 
-  
+
 ### Let's see a small example
 
 ```typescript
@@ -67,17 +67,17 @@ function ChildComponent({ parentState }: { parentState: number }) {
 ```
 
 In the above example, we have a simple component structure: a parent component that renders a child component
-(passing its state and setter function).
+(passing its state as props).
 
-When the child component mounts (is rendered for the first time), the unsyncState state has the same 
+When the child component mounts (is rendered for the first time), the unsyncState state has the same
 value as the parentState prop (or the parentState state, which is passed as a prop).
 
 Now if the parentState changes (by calling its setParentState setter), the parentState prop will change accordingly,
-but the value of the unsyncState will not (because the state is only initialized when the component mounts). 
+but the value of the unsyncState will not (because the state is only initialized when the component mounts).
 
 What can we do in the following situation?
 
-The first thing that comes to mind is to do something like this: 
+The first thing that comes to mind is to do something like this:
 
 ```typescript
 function ChildComponent({ parentState }: { parentState: number }) {
@@ -90,26 +90,26 @@ function ChildComponent({ parentState }: { parentState: number }) {
 }
 ```
 
-This is doing its job, but we now have another problem called "cascading updates" (which will be spotted by the 
+This is doing its job, but we now have another problem called "cascading updates" (which will be spotted by the
 React Performance tracks). You can read the docs at the following link
 https://react.dev/reference/dev-tools/react-performance-tracks#cascading-updates.
 
 To explain why this happens, we first have to know that React Fiber algorithm has two phases: the render phase and
 the commit phase. All you need to know, to understand the issue, is that React will call useEffect after the entire
-virtual dom is rendered. 
+virtual dom is rendered.
 
 So, in our case, after the first render will complete parentState and syncState will have both the value 0
-(the initial value of parentState). Setting parentState to a new value (let's say 1), React will render the 
+(the initial value of parentState). Setting parentState to a new value (let's say 1), React will render the
 ChildComponent with the parentState props as 1, but the syncState will still have the previous value 0.
-Once the useEffect runs, setting the syncState to 1, we will have another render that has both values equal to 1. 
-This is the cascading updates problem in all its glory, instead of having one render, you ended up having two 
+Once the useEffect runs (setting the syncState to 1), we will have another render that has both values equal to 1.
+This is the cascading updates problem in all its glory, instead of having one render, you ended up having two
 (having also a performance penalty).
 
 
-What react docs tell us to do in this case can be found here 
+What react docs tell us to do in this case can be found here
 https://react.dev/learn/you-might-not-need-an-effect#adjusting-some-state-when-a-prop-changes.
-I have changed the above example to match it. It still rerenders the ChildComponent twice, which still causes a 
-performance penalty, is hard to reason about and works only for states defined in the same component 
+I have changed the above example to match it. It still rerenders the ChildComponent twice, which still causes a
+performance penalty, is hard to reason about and works only for states defined in the same component
 (if syncSate was a prop, it wouldn't work).
 
 ```typescript
@@ -126,7 +126,7 @@ function ChildComponent({ parentState }: { parentState: number }) {
 }
 ```
 
-The 'use-synchronized-state' hook fixes all these issues by synchronizing the values in the same and only render. In the bellow example, 
+The 'use-synchronized-state' hook fixes all these issues by synchronizing the values in the same and only render. In the bellow example,
 if the reactive value changes (for example setParentState(1) is called), both parentState and syncState will have
 the same value from the first render (after the setParentState) and there will be no additional render (only the needed one).
 
@@ -141,8 +141,4 @@ function ChildComponent({ parentState }: { parentState: number }) {
 ```
 
 ## License
-MIT
-
-
-
-
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-synchronized-state",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A React hook that creates a synchronized state with a reactive value in react (fixing the Cascading updates issue)",
   "author": "rhorge",
   "license": "MIT",