Separating Events from Effects
Event handlers only re-run when you perform the same interaction again. Unlike event handlers, Effects re-synchronize if some value they read, like a prop or a state variable, is different from what it was during the last render. Sometimes, you also want a mix of both behaviors: an Effect that re-runs in response to some values but not others. This page will teach you how to do that.
You will learn
- How to choose between an event handler and an Effect
- Why Effects are reactive, and event handlers are not
- What to do when you want a part of your Effectâs code to not be reactive
- What Event functions are, and how to extract them from your Effects
- How to read the latest props and state from Effects using Event functions
Choosing between event handlers and Effects
First, letâs recap the difference between event handlers and Effects.
Imagine youâre implementing a chat room component. Your requirements look like this:
- Your component should automatically connect to the selected chat room.
- When you click the âSendâ button, it should send a message to the chat.
Letâs say youâve already implemented the code for them, but youâre not sure where to put it. Should you use event handlers or Effects? Every time you need to answer this question, consider why the code needs to run.
Event handlers run in response to specific interactions
From the userâs perspective, sending a message should happen because the particular âSendâ button was clicked. The user will get rather upset if you send their message at any other time or for any other reason. This is why sending a message should be an event handler. Event handlers let you handle specific interactions like clicks:
function ChatRoom({ roomId }) {
const [message, setMessage] = useState('');
// ...
function handleSendClick() {
sendMessage(message);
}
// ...
return (
<>
<input value={message} onChange={e => setMessage(e.target.value)} />
<button onClick={handleSendClick}>Send</button>;
</>
);
}
With an event handler, you can be sure that sendMessage(message)
will only run if the user presses the button.
Effects run whenever synchronization is needed
Recall that you also need to keep the component connected to the chat room. Where does that code go?
The reason to run this code is not some particular interaction. It doesnât matter why or how the user navigated to the chat room screen. Now that theyâre looking at it and could interact with it, the component needs to stay connected to the selected chat server. Even if the chat room component was the initial screen of your app, and the user has not performed any interactions at all, you would still need to connect. This is why itâs an Effect:
function ChatRoom({ roomId }) {
// ...
useEffect(() => {
const connection = createConnection(serverUrl, roomId);
connection.connect();
return () => {
connection.disconnect();
};
}, [roomId]);
// ...
}
With this code, you can be sure that there is always an active connection to the currently selected chat server, regardless of the specific interactions performed by the user. Whether the user has only opened your app, selected a different room, or navigated to another screen and back, your Effect will ensure that the component will remain synchronized with the currently selected room, and will re-connect whenever itâs necessary.
import { useState, useEffect } from 'react'; import { createConnection, sendMessage } from './chat.js'; const serverUrl = 'https://localhost:1234'; function ChatRoom({ roomId }) { const [message, setMessage] = useState(''); useEffect(() => { const connection = createConnection(serverUrl, roomId); connection.connect(); return () => connection.disconnect(); }, [roomId]); function handleSendClick() { sendMessage(message); } return ( <> <h1>Welcome to the {roomId} room!</h1> <input value={message} onChange={e => setMessage(e.target.value)} /> <button onClick={handleSendClick}>Send</button> </> ); } export default function App() { const [roomId, setRoomId] = useState('general'); const [show, setShow] = useState(false); return ( <> <label> Choose the chat room:{' '} <select value={roomId} onChange={e => setRoomId(e.target.value)} > <option value="general">general</option> <option value="travel">travel</option> <option value="music">music</option> </select> </label> <button onClick={() => setShow(!show)}> {show ? 'Close chat' : 'Open chat'} </button> {show && <hr />} {show && <ChatRoom roomId={roomId} />} </> ); }
Reactive values and reactive logic
Intuitively, you could say that event handlers are always triggered âmanuallyâ, for example by clicking a button. Effects, on the other hand, are âautomaticâ: they run and re-run as often as itâs needed to stay synchronized.
There is a more precise way to think about this.
Props, state, and variables declared inside your componentâs body are called reactive values. In this example, serverUrl
is not a reactive value, but roomId
and message
are. They participate in the rendering data flow:
const serverUrl = 'https://localhost:1234';
function ChatRoom({ roomId }) {
const [message, setMessage] = useState('');
// ...
}
Reactive values like these can change due to a re-render. For example, the user may edit the message
or choose a different roomId
in a dropdown. Event handlers and Effects are different in how they respond to changes:
- Logic inside event handlers is not reactive. It will not run again unless the user performs the same interaction (for example, a click) again. Event handlers can read reactive values, but they donât âreactâ to their changes.
- Logic inside Effects is reactive. If your Effect reads a reactive value, you have to specify it as a dependency. Then, if a re-render causes that value to change, React will re-run your Effectâs logic again with the new value.
Letâs revisit the previous example to illustrate this difference.
Logic inside event handlers is not reactive
Take a look at this line of code. Should this logic be reactive or not?
// ...
sendMessage(message);
// ...
From the userâs perspective, a change to the message
does not mean that they want to send a message. It only means that the user is typing. In other words, the logic that sends a message should not be reactive. It should not run again only because the reactive value has changed. Thatâs why you placed this logic in the event handler:
function handleSendClick() {
sendMessage(message);
}
Event handlers arenât reactive, so sendMessage(message)
will only run when the user clicks the Send button.
Logic inside Effects is reactive
Now letâs return to these lines:
// ...
const connection = createConnection(serverUrl, roomId);
connection.connect();
// ...
From the userâs perspective, a change to the roomId
does mean that they want to connect to a different room. In other words, the logic for connecting to the room should be reactive. You want these lines of code to âkeep upâ with the reactive value, and to run again if that value is different. Thatâs why you put this logic inside an Effect:
useEffect(() => {
const connection = createConnection(serverUrl, roomId);
connection.connect();
return () => {
connection.disconnect()
};
}, [roomId]);
Effects are reactive, so createConnection(serverUrl, roomId)
and connection.connect()
will run for every distinct value of roomId
. Your Effect keeps the chat connection synchronized to the currently selected room.
Extracting non-reactive logic out of Effects
Things get more tricky when you want to mix reactive logic with non-reactive logic.
For example, imagine that you want to show a notification when the user connects to the chat. You read the current theme (dark or light) from the props so that you can show the notification in the correct color:
function ChatRoom({ roomId, theme }) {
useEffect(() => {
const connection = createConnection(serverUrl, roomId);
connection.on('connected', () => {
showNotification('Connected!', theme);
});
connection.connect();
// ...
However, theme
is a reactive value (it can change as a result of re-rendering), and every reactive value read by an Effect must be declared as its dependency. So now you have to specify theme
as a dependency of your Effect:
function ChatRoom({ roomId, theme }) {
useEffect(() => {
const connection = createConnection(serverUrl, roomId);
connection.on('connected', () => {
showNotification('Connected!', theme);
});
connection.connect();
return () => {
connection.disconnect()
};
}, [roomId, theme]); // â
All dependencies declared
// ...
Play with this example and see if you can spot the problem with this user experience:
import { useState, useEffect } from 'react'; import { createConnection, sendMessage } from './chat.js'; import { showNotification } from './notifications.js'; const serverUrl = 'https://localhost:1234'; function ChatRoom({ roomId, theme }) { useEffect(() => { const connection = createConnection(serverUrl, roomId); connection.on('connected', () => { showNotification('Connected!', theme); }); connection.connect(); return () => connection.disconnect(); }, [roomId, theme]); return <h1>Welcome to the {roomId} room!</h1> } export default function App() { const [roomId, setRoomId] = useState('general'); const [isDark, setIsDark] = useState(false); return ( <> <label> Choose the chat room:{' '} <select value={roomId} onChange={e => setRoomId(e.target.value)} > <option value="general">general</option> <option value="travel">travel</option> <option value="music">music</option> </select> </label> <label> <input type="checkbox" checked={isDark} onChange={e => setIsDark(e.target.checked)} /> Use dark theme </label> <hr /> <ChatRoom roomId={roomId} theme={isDark ? 'dark' : 'light'} /> </> ); }
When the roomId
changes, the chat re-connects as you would expect. But since theme
is also a dependency, the chat also re-connects every time you switch between the dark and the light theme. Thatâs not great!
In other words, you donât want this line to be reactive, even though it is inside an Effect (which is reactive):
// ...
showNotification('Connected!', theme);
// ...
You need a way to separate this non-reactive logic from the reactive Effect around it.
Declaring an Event function
Use a special Hook called useEvent
to extract this non-reactive logic out of your Effect:
import { useEffect, useEvent } from 'react';
function ChatRoom({ roomId, theme }) {
const onConnected = useEvent(() => {
showNotification('Connected!', theme);
});
// ...
Here, onConnected
is called an Event function. Itâs a part of your Effect logic, but it behaves a lot more like an event handler. The logic inside it is not reactive, and it always âseesâ the latest values of your props and state.
Now you can call the onConnected
Event function from inside your Effect:
function ChatRoom({ roomId, theme }) {
const onConnected = useEvent(() => {
showNotification('Connected!', theme);
});
useEffect(() => {
const connection = createConnection(serverUrl, roomId);
connection.on('connected', () => {
onConnected();
});
connection.connect();
return () => connection.disconnect();
}, [roomId]); // â
All dependencies declared
// ...
This solves the problem. Similar to the set
functions returned from useState
, all Event functions are stable: they never change on a re-render. This is why you can skip them in the dependency list. They are not reactive.
Verify that the new behavior works as you would expect:
import { useState, useEffect } from 'react'; import { experimental_useEvent as useEvent } from 'react'; import { createConnection, sendMessage } from './chat.js'; import { showNotification } from './notifications.js'; const serverUrl = 'https://localhost:1234'; function ChatRoom({ roomId, theme }) { const onConnected = useEvent(() => { showNotification('Connected!', theme); }); useEffect(() => { const connection = createConnection(serverUrl, roomId); connection.on('connected', () => { onConnected(); }); connection.connect(); return () => connection.disconnect(); }, [roomId]); return <h1>Welcome to the {roomId} room!</h1> } export default function App() { const [roomId, setRoomId] = useState('general'); const [isDark, setIsDark] = useState(false); return ( <> <label> Choose the chat room:{' '} <select value={roomId} onChange={e => setRoomId(e.target.value)} > <option value="general">general</option> <option value="travel">travel</option> <option value="music">music</option> </select> </label> <label> <input type="checkbox" checked={isDark} onChange={e => setIsDark(e.target.checked)} /> Use dark theme </label> <hr /> <ChatRoom roomId={roomId} theme={isDark ? 'dark' : 'light'} /> </> ); }
You can think of Event functions as being very similar to event handlers. The main difference is that event handlers run in response to a user interactions, whereas Event functions are triggered by you from Effects. Event functions let you âbreak the chainâ between the reactivity of Effects and some code that should not be reactive.
Reading latest props and state with Event functions
Event functions let you fix many patterns where you might be tempted to suppress the dependency linter.
For example, say you have an Effect to log the page visits:
function Page() {
useEffect(() => {
logVisit();
}, []);
// ...
}
Later, you add multiple routes to your site. Now your Page
component receives a url
prop with the current path. You want to pass the url
as a part of your logVisit
call, but the dependency linter complains:
function Page({ url }) {
useEffect(() => {
logVisit(url);
}, []); // đ´ React Hook useEffect has a missing dependency: 'url'
// ...
}
Think about what you want the code to do. You want to log a separate visit for different URLs since each URL represents a different page. In other words, this logVisit
call should be reactive with respect to the url
. This is why, in this case, it makes sense to follow the dependency linter, and add url
as a dependency:
function Page({ url }) {
useEffect(() => {
logVisit(url);
}, [url]); // â
All dependencies declared
// ...
}
Now letâs say you want to include the number of items in the shopping cart together with every page visit:
function Page({ url }) {
const { items } = useContext(ShoppingCartContext);
const numberOfItems = items.length;
useEffect(() => {
logVisit(url, numberOfItems);
}, [url]); // đ´ React Hook useEffect has a missing dependency: 'numberOfItems'
// ...
}
You used numberOfItems
inside the Effect, so the linter asks you to add it as a dependency. However, you donât want the logVisit
call to be reactive with respect to numberOfItems
. If the user puts something into the shopping cart, and the numberOfItems
changes, this does not mean that the user visited the page again. In other words, visiting the page feels similar to an event. You want to be very precise about when you say itâs happened.
Split the code in two parts:
function Page({ url }) {
const { items } = useContext(ShoppingCartContext);
const numberOfItems = items.length;
const onVisit = useEvent(visitedUrl => {
logVisit(visitedUrl, numberOfItems);
});
useEffect(() => {
onVisit(url);
}, [url]); // â
All dependencies declared
// ...
}
Here, onVisit
is an Event function. The code inside it isnât reactive. This is why you can use numberOfItems
(or any other reactive value!) without worrying that it will cause the surrounding code to re-execute on changes.
On the other hand, the Effect itself remains reactive. Code inside the Effect uses the url
prop, so the Effect will re-run after every re-render with a different url
. This, in turn, will call the onVisit
event function.
As a result, you will call logVisit
for every change to the url
, and always read the latest numberOfItems
. However, if numberOfItems
changes on its own, this will not cause any of the code to re-run.
Deep Dive
Is it okay to suppress the dependency linter instead?
Is it okay to suppress the dependency linter instead?
In the existing codebases, you may sometimes see the lint rule suppressed like this:
function Page({ url }) {
const { items } = useContext(ShoppingCartContext);
const numberOfItems = items.length;
useEffect(() => {
logVisit(url, numberOfItems);
// đ´ Avoid suppressing the linter like this:
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [url]);
// ...
}
After useEvent
becomes a stable part of React, we recommend to never suppress the linter like this.
The first downside of suppressing the rule is that React will no longer warn you when your Effect needs to âreactâ to a new reactive dependency youâve introduced to your code. For example, in the earlier example, you added url
to the dependencies because React reminded you to do it. You will no longer get such reminders for any future edits to that Effect if you disable the linter. This leads to bugs.
Here is an example of a confusing bug caused by suppressing the linter. In this example, the handleMove
function is supposed to read the current canMove
state variable value in order to decide whether the dot should follow the cursor. However, canMove
is always true
inside handleMove
. Can you see why?
import { useState, useEffect } from 'react'; export default function App() { const [position, setPosition] = useState({ x: 0, y: 0 }); const [canMove, setCanMove] = useState(true); function handleMove(e) { if (canMove) { setPosition({ x: e.clientX, y: e.clientY }); } } useEffect(() => { window.addEventListener('pointermove', handleMove); return () => window.removeEventListener('pointermove', handleMove); // eslint-disable-next-line react-hooks/exhaustive-deps }, []); return ( <> <label> <input type="checkbox" checked={canMove} onChange={e => setCanMove(e.target.checked)} /> The dot is allowed to move </label> <hr /> <div style={{ position: 'absolute', backgroundColor: 'pink', borderRadius: '50%', opacity: 0.6, transform: `translate(${position.x}px, ${position.y}px)`, pointerEvents: 'none', left: -20, top: -20, width: 40, height: 40, }} /> </> ); }
The problem with the this code is in suppressing the dependency linter. If you remove the suppression, youâll see that this Effect should depend on the handleMove
function. This makes sense: handleMove
is declared inside the component body, which makes it a reactive value. Every reactive value must be specified as a dependency, or it can potentially get stale over time!
The author of the original code has âliedâ to React by saying that the Effect does not depend ([]
) on any reactive values. This is why React did not re-synchronize the Effect after canMove
has changed (and handleMove
with it). Because React did not re-synchronize the Effect, the handleMove
attached as a listener is the handleMove
function created during the initial render. During the initial render, canMove
was true
, which is why handleMove
from the initial render will forever see that value.
If you never suppress the linter, you will never see problems with stale values.
With useEvent
, there is no need to âlieâ to the linter, and the code works as you would expect:
import { useState, useEffect } from 'react'; import { experimental_useEvent as useEvent } from 'react'; export default function App() { const [position, setPosition] = useState({ x: 0, y: 0 }); const [canMove, setCanMove] = useState(true); const onMove = useEvent(e => { if (canMove) { setPosition({ x: e.clientX, y: e.clientY }); } }); useEffect(() => { window.addEventListener('pointermove', onMove); return () => window.removeEventListener('pointermove', onMove); }, []); return ( <> <label> <input type="checkbox" checked={canMove} onChange={e => setCanMove(e.target.checked)} /> The dot is allowed to move </label> <hr /> <div style={{ position: 'absolute', backgroundColor: 'pink', borderRadius: '50%', opacity: 0.6, transform: `translate(${position.x}px, ${position.y}px)`, pointerEvents: 'none', left: -20, top: -20, width: 40, height: 40, }} /> </> ); }
This doesnât mean that useEvent
is always the correct solution. You should only apply it to the lines of code that you donât want to be reactive. For example, in the above sandbox, you didnât want the Effectâs code to be reactive with regards to canMove
. Thatâs why it made sense to extract an Event function.
Read Removing Effect Dependencies for other correct alternatives to suppressing the linter.
Limitations of Event functions
At the moment, Event functions are very limited in how you can use them:
- Only call them from inside Effects.
- Never pass them to other components or Hooks.
For example, donât declare and pass an Event function like this:
function Timer() {
const [count, setCount] = useState(0);
const onTick = useEvent(() => {
setCount(count + 1);
});
useTimer(onTick, 1000); // đ´ Avoid: Passing event functions
return <h1>{count}</h1>
}
function useTimer(callback, delay) {
useEffect(() => {
const id = setInterval(() => {
callback();
}, delay);
return () => {
clearInterval(id);
};
}, [delay, callback]); // Need to specify "callback" in dependencies
}
Instead, always declare Event functions directly next to the Effects that use them:
function Timer() {
const [count, setCount] = useState(0);
useTimer(() => {
setCount(count + 1);
}, 1000);
return <h1>{count}</h1>
}
function useTimer(callback, delay) {
const onTick = useEvent(() => {
callback();
});
useEffect(() => {
const id = setInterval(() => {
onTick(); // â
Good: Only called locally inside an Effect
}, delay);
return () => {
clearInterval(id);
};
}, [delay]); // No need to specify "onTick" (an Event function) as a dependency
}
Itâs possible that in the future, some of these restrictions will be lifted. But for now, you can think of Event functions as non-reactive âpiecesâ of your Effect code, so they should be close to the Effect using them.
Recap
- Event handlers run in response to specific interactions.
- Effects run whenever synchronization is needed.
- Logic inside event handlers is not reactive.
- Logic inside Effects is reactive.
- You can move non-reactive logic from Effects into Event functions.
- Only call Event functions from inside Effects.
- Donât pass Event functions to other components or Hooks.
Challenge 1 of 4: Fix a variable that doesnât update
This Timer
component keeps a count
state variable which increases every second. The value by which itâs increasing is stored in the increment
state variable. You can control the increment
variable with the plus and minus buttons.
However, no matter how many times you click the plus button, the counter is still incremented by one every second. Whatâs wrong with this code? Why is increment
always equal to 1
inside the Effectâs code? Find the mistake and fix it.
import { useState, useEffect } from 'react'; export default function Timer() { const [count, setCount] = useState(0); const [increment, setIncrement] = useState(1); useEffect(() => { const id = setInterval(() => { setCount(c => c + increment); }, 1000); return () => { clearInterval(id); }; // eslint-disable-next-line react-hooks/exhaustive-deps }, []); return ( <> <h1> Counter: {count} <button onClick={() => setCount(0)}>Reset</button> </h1> <hr /> <p> Every second, increment by: <button disabled={increment === 0} onClick={() => { setIncrement(i => i - 1); }}>â</button> <b>{increment}</b> <button onClick={() => { setIncrement(i => i + 1); }}>+</button> </p> </> ); }